Universal Web Platform · Tipi di documento

DocumentType: le tipologie di documento con serie, registri e comportamento

Tipi di documento: le tipologie di documento con serie, registri e comportamento. Nel web service è il tipo DOCUMENTTYPE (valore 24 di DataType); gli oggetti sono della classe DocumentType e viaggiano nella lista ObjectListDocumentType della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDOCUMENTTYPE = 24
ClasseDocumentType
Lista nella richiesta e nella rispostaObjectListDocumentType
Tabella letta da QUERYTipologieDocumenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DocumentType

La colonna Obbligatorio riporta i campi chiave e quelli controllati dal server prima di salvare; Predefinito è il valore che il campo assume se non lo invii; Colonna è il nome del campo nel database, da usare nei filtri di lettura.

CampoTipoObbligatorioPredefinitoColonnaA cosa serve
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ConsideraScontiPerAggiornamentoPrezziListinoVero/falso—false—Considera sconti per aggiornamento prezzi listino.
RegistroDiDefaultTesto—vuoto—Registro di predefinito.
InviaEmailRientroDisponibilitaPerPrenotazioniVero/falso—false—Invia email rientro disponibilità per prenotazioni.
ChiediInviaEmailRientroDisponibilitaPerPrenotazioniVero/falso—false—Chiedi invia email rientro disponibilità per prenotazioni.
PrintCartelliniVero/falso—false—Print cartellini.
PrintCartelliniUnoPerRigaVero/falso—false—Print cartellini uno per riga.
PrintCartelliniChiediVero/falso—false—Print cartellini chiedi.
PrintCartelliniListinoTesto—vuoto—Print cartellini listino.
AvvisaDoppioInserimentoVero/falso—falseavvisadoppioinsAvvisa doppio inserimento.
TipoDocProponiBarcodeVero/falso—falseproponibarcodeTipo doc proponi barcode.
TipoDocNumerazioneAutoVero/falso—falseindnumautoTipo doc numerazione auto.
TipoDocNumerazioneAutoCodProgressivoTesto—vuotonumautoprogrTipo doc numerazione auto codice progressivo.
TipoDocProtocollazioneAutoVero/falso—falseindprotocolloTipo doc protocollazione auto.
TipoDocProtocollazioneCodProgressivoTesto—vuotoprotocolloprogrTipo doc protocollazione codice progressivo.
TipoDocControllaConsecutivitaDataVero/falso—falseindcontrdataTipo doc controlla consecutivita data.
TipoDocCollegaFlussiVero/falso—falsecollegaflussiTipo doc collega flussi.
TipoDocCollegaFlussiSchemaTesto—vuotocollegaflussischemaTipo doc collega flussi schema.
TipoDocCollegaFlussiFaseIntero—0collegaflussifaseTipo doc collega flussi fase.
TipoDocCollegaFlussiValoreIntero—0collegaflussivaloreTipo doc collega flussi valore.
TipoDocCollegaFlussiIncFaseIntero—0collegaflussiincfaseTipo doc collega flussi inc fase.
TipoDocCollegaFlussiIncValoreIntero—0collegaflussiincvaloreTipo doc collega flussi inc valore.
TipoDocCollegaFlussiIncChiudiIntero—0collegaflussiincchiudiTipo doc collega flussi inc chiudi.
TipoDocCausaleMagazzinoTesto—vuotocmagTipo doc causale magazzino.
TipoDocCausaleMagazzinoGeneraDocumentoTesto—vuotocmaggendocTipo doc causale magazzino genera documento.
TipoDocCausaleContabileTesto—vuotoccontTipo doc causale contabile.
TipoDocDefNoteTesto—vuotodefnoteTipo doc predefinito note.
TipoDocDefAspettoBeniTesto—vuotodefaspettoTipo doc predefinito aspetto beni.
TipoDocDefCausaleTrasportoTesto—vuotodefcausaleTipo doc predefinito causale trasporto.
TipoDocDefTrasportoAMezzoTesto—vuotodefamezzoTipo doc predefinito trasporto a mezzo.
TipoDocDefPortoTesto—vuotodefportoTipo doc predefinito porto.
TipoDocDefSpedizioniere1Testo—vuotodefsped1Tipo doc predefinito spedizioniere 1.
TipoDocDefSpedizioniere2Testo—vuotodefsped2Tipo doc predefinito spedizioniere 2.
TipoDocDefSerieTesto—vuotoseriedefaultTipo doc predefinito serie.
TipoDocDefProponiDataOraVero/falso—falsedefproponiTipo doc predefinito proponi data ora.
TipoDocDefNumCopieIntero—0numcopiedefTipo doc predefinito numero copie.
TipoDocDefStatoDocumentoTesto—vuotostatodocTipo doc predefinito stato documento.
TipoDocDefSezioneContabileTesto—vuotosezionecontTipo doc predefinito sezione contabile.
TipoDocChangeStatoControparteVero/falso—falsecambiaanagdopoTipo doc change stato controparte.
TipoDocChangeStatoControparteCodiceTesto—vuototipoanagdopoTipo doc change stato controparte codice.
TipoDocDefCodiceIVATesto—vuotocodivadefTipo doc predefinito codice IVA.
CodiceDocumentoFatturaPATesto—vuotocodtipodocfattpaCodice documento fattura PA.
CodiceDocumentoFormatoDIFTesto—vuotocoddifCodice documento formato DIF.
BloccaNumerazioneVero/falso—falsebloccanumerazioneBlocca numerazione.
BloccaProtocollazioneVero/falso—falsebloccaprotocollazioneBlocca protocollazione.
AddebitaPerCategorieMerceologicheVero/falso—falseaddebcatmercAddebita per categorie merceologiche.
AbilitaAvvisoDiRitiroVero/falso—falseabilitaavvisoritiroAbilita avviso di ritiro.
AvvisaPrezziAZeroVero/falso—falseavvisaprezzizeroAvvisa prezzi a zero.
AvvisaPrezziAZeroBloccaInserimentoVero/falso—falsebloccaprezzizeroAvvisa prezzi a zero blocca inserimento.
ModelloStampaPerEmailTesto—vuotomodellomailModello stampa per email.
StampaDescrizioneMacchinaSuCorpoDocumentoVero/falso—falsestampadescrmacchinaStampa descrizione macchina su corpo documento.
StampaCaratteristicheTecnicheSuCorpoDocumentoVero/falso—falsestampacartecStampa caratteristiche tecniche su corpo documento.
CausaleContabileObbligatoriaVero/falso—falsecauscontabileobbligatoriaCausale contabile obbligatoria.
VerificaEsistenzaValoriFatturaElettronicaVero/falso—falsecontrollaesistenzariffeVerifica esistenza valori fattura elettronica.
BloccaInserimentoSenzaValoriFatturaElettronicaVero/falso—falsebloccainserimentosenzafeBlocca inserimento senza valori fattura elettronica.
NonGenerareRigaDichiarazioneIntentoVero/falso—falsenongenrigadichiarazioniintentoNon generare riga dichiarazione intento.
NonStampareDescrizioneRigaVero/falso—falsenonstamparedescrizionerigaNon stampare descrizione riga.
EscludiControlloBolliVero/falso—falseescludicontrollobolliEscludi controllo bolli.
ControparteDefaultTesto——contropartedefControparte predefinito.
EscludiImpostaDiConsumoVero/falso—falseescludiimpostadiconsumoEscludi imposta di consumo.
EmailSostitutivaPerInvioTesto—vuotoemailsostinvioEmail sostitutiva per invio.
DepositoDiDafaultTesto—vuotodepositodefDeposito di dafault.
AttivaControlloImpostaDiCosumoVero/falso—falsecontrollaimpostaconsumoAttiva controllo imposta di cosumo.
DisattivaMessaggiInsolutoNonBloccantiVero/falso—falsedismessnonblocinsolutoDisattiva messaggi insoluto non bloccanti.

Esempi

Inserimento o aggiornamento di un record (valori di esempio). Ricorda che INSERTORMODIFY riscrive tutti i campi: quelli che non invii tornano al valore predefinito, quindi per modificare un record esistente invia il record completo.

JSON · INSERTORMODIFY
{
  "DataOperation": 0,
  "TypeObject": 24,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDocumentType": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ConsideraScontiPerAggiornamentoPrezziListino": false,
      "RegistroDiDefault": "ESEMPIO",
      "InviaEmailRientroDisponibilitaPerPrenotazioni": false,
      "ChiediInviaEmailRientroDisponibilitaPerPrenotazioni": false
    }
  ]
}

Lettura con filtro: fino a 100 record, ignorando le conferme di ricezione.

JSON · QUERY
{
  "DataOperation": 3,
  "TypeObject": 24,
  "GuidPC": "gestionale-01",
  "SQLFilter": "TipologieDocumenti.codice = 'COD001'",
  "QueryParameter": {
    "IgnoreImportRecord": true,
    "StartingRecord": 1,
    "LimitRecord": 100
  }
}

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 24,
  "GuidPC": "gestionale-01",
  "ObjectListDocumentType": [
    {
      "Codice": "COD001"
    }
  ]
}

Le regole su formati, date, numeri e compressione sono in formato e trasporto; esempi completi in esempi di codice.