Universal Web Platform · Documenti

Document: ordini, DDT, fatture e ogni altro documento, con righe, spese, trasporto e totali

Documenti: ordini, DDT, fatture e ogni altro documento, con righe, spese, trasporto e totali. Nel web service è il tipo DOCUMENT (valore 23 di DataType); gli oggetti sono della classe Document e viaggiano nella lista ObjectListDocument della richiesta e della risposta.

Un documento è la testata con le sue righe in ListaCorpo. La chiave è formata da tipo, esercizio, serie, registro, numero, controparte e tipo di controparte (C cliente, F fornitore). Servono almeno il tipo, il numero e una riga.

Spese, sconti di testata, trasporto, ritenute, bollo e totali si trasmettono già calcolati, così il documento ricevuto è identico a quello emesso. In lettura puoi filtrare per evento, per deposito e per soli carichi con QueryParameter.

Scheda tecnica

VoceValore
Tipo di datoDOCUMENT = 23
ClasseDocument
Lista nella richiesta e nella rispostaObjectListDocument
Tabella letta da QUERYDocumentiTesta — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveTipo + Esercizio + Serie + Registro + Numero + Controparte + TipoControparte — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassTipo|Esercizio|Serie|Registro|Numero|Controparte|TipoControparte
Chiave per le conferme di ricezioneTipo|Esercizio|Registro|Serie|Numero|TipoControparte|Controparte — come si usa
Controlli prima del salvataggioTipo: «Tipo documento non specificato»
Numero: «Numero non specificato»
ListaCorpo: «Nessuna riga inserita nel corpo documento»

I campi di Document

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
TipoTestoChiave, sìvuototipodocCodice del tipo di documento (ordine, DDT, fattura...). Codice dell'archivio Tipi di documento. Se manca il server risponde «Tipo documento non specificato».
EsercizioTestoChiavevuotoesercizioCodice dell'esercizio. Codice dell'archivio Esercizi.
SerieTestoChiavevuotoserieSerie di numerazione.
RegistroTestoChiavevuotoregistroRegistro di numerazione.
NumeroIntero lungoChiave, sì0nnumeroNumero del documento. Se manca il server risponde «Numero non specificato».
ControparteTestoChiavevuotocontroparteCodice del cliente o del fornitore. Codice dell'archivio Clienti e fornitori.
TipoControparteTestoChiavevuototipocontroparteC per cliente, F per fornitore.
DataData e ora—nessuna dataultdataData del documento.
CausaleMagazzinoTesto—vuotocausalemagazzinoCausale magazzino. Codice dell'archivio Causali di magazzino.
CausaleContabileTesto—vuotocausalecontabileCausale contabile. Codice dell'archivio Causali contabili.
SezioneContabileTesto—vuotosezionecontabileSezione contabile. Codice dell'archivio Sezioni contabili.
DestinazioneDiversaTesto—vuotodestinazionediversaCodice della destinazione di consegna. Codice dell'archivio Destinazioni diverse.
DepositoTesto—vuotodepositoCodice del deposito. Codice dell'archivio Depositi.
StatoDocumentoTesto—vuotostatodocumentoStato documento. Codice dell'archivio Stati del documento.
NoteTesto—vuotonoteNote libere.
AgenteTesto—vuotoagenteCodice dell'agente.
PagamentoTesto—vuotopagamentoCodice della condizione di pagamento. Codice dell'archivio Pagamenti.
PagamentoIntegratedCardVero/falso—falsepagamentointegratedcardPagamento integrated card.
SpeseIncassoDecimale—0speseincassoSpese di incasso.
ImponibileSpeseIncassoDecimale—0imponibilespeseincassoImponibile spese incasso.
ImponibileSpeseIncassoNettoScontoDecimale—0imponibilespeseincassonettoscontoImponibile spese incasso netto sconto.
IVASpeseIncassoDecimale—0ivaspeseincassoIVA spese incasso.
IVASpeseIncassoNettoScontoDecimale—0ivaspeseincassonettoscontoIVA spese incasso netto sconto.
SpeseIncassoIVAInclusaVero/falso—falsespeseincassoivainclusaSpese incasso IVA inclusa.
CodiceIVASpeseIncassoTesto—vuotocodiceivaspeseincassoCodice IVA spese incasso. Codice dell'archivio Codici IVA.
SpeseTrasportoDecimale—0spesetrasportoSpese di trasporto.
ImponibileSpeseTrasportoDecimale—0imponibilespesetrasportoImponibile spese trasporto.
ImponibileSpesetrasportoNettoScontoDecimale—0imponibilespesetrasportonettoscontoImponibile spesetrasporto netto sconto.
IVASpeseTrasportoDecimale—0ivaspesetrasportoIVA spese trasporto.
IVASpesetrasportoNettoScontoDecimale—0ivaspesetrasportonettoscontoIVA spesetrasporto netto sconto.
SpeseTrasportoIVAInclusaVero/falso—falsespesetrasportoivainclusaSpese trasporto IVA inclusa.
CodiceIVASpeseTrasportoTesto—vuotocodiceivaspesetrasportoCodice IVA spese trasporto. Codice dell'archivio Codici IVA.
PercSconto1Decimale—0percsconto1Primo sconto di testata, in percentuale.
PercSconto2Decimale—0percsconto2Secondo sconto di testata, in percentuale.
PercSconto3Decimale—0percsconto3Terzo sconto di testata, in percentuale.
RifClienteProtNumeroTesto—vuotorifclienteprotnumeroNumero del riferimento del cliente (il suo ordine).
RifClienteProtDataData e ora—nessuna datarifclienteprotdataData del riferimento del cliente.
CommessoTesto—vuotocommessoCodice del commesso.
NotaAggiuntivaTesto—vuotonotaaggiuntivaNota aggiuntiva.
NoteSpedizioneTesto—vuotonotespedizioneNote per la spedizione.
RaggruppamentoStatisticoTesto—vuotoraggruppamentostatisticoRaggruppamento statistico. Codice dell'archivio Raggruppamenti statistici.
SplitPaymentVero/falso—falsesplitpaymentVero se il documento è in scissione dei pagamenti.
CanaleRicevimentoTesto—vuotocanalericevimentoCanale ricevimento. Codice dell'archivio Canali di ricevimento.
ListinoUtilizzatoTesto—vuotolistinoutilizzatoCodice del listino con cui è stato fatto il documento. Codice dell'archivio Listini.
ListinoIVAInclusaVero/falso—falselistinoivainclusaVero se il listino usato è IVA inclusa.
CodiceLotteriaScontriniTesto—vuotocodicelotteriascontriniCodice lotteria del cliente.
EventoAnnoIntero—0eventoannoAnno dell'evento di merchandising collegato.
EventoNumeroIntero—0eventonumeroNumero dell'evento di merchandising collegato.
EventoBancoPartenzaIntero—0eventobancopartenzaEvento banco partenza.
EventoBancoDestinazioneIntero—0eventobancodestinazioneEvento banco destinazione.
TotaleDocumentoDecimale—0—Totale del documento.
TotaleScontoDecimale—0totalescontoTotale sconto.
TotaleScontoImponibileDecimale—0totalescontoimponibileTotale sconto imponibile.
TotaleScontoIVADecimale—0totalescontoivaTotale sconto IVA.
TotaleDocumentoNettoScontoDecimale—0—Totale documento netto sconto.
TotaleImponibileDecimale—0totaleimponibileTotale imponibile.
TotaleIVADecimale—0totaleivaTotale IVA.
TotaleImponibileNettoScontoDecimale—0totaleimponibilenettoscontoTotale imponibile netto sconto.
TotaleIVANettoScontoDecimale—0totaleivanettoscontoTotale IVA netto sconto.
TotaleImponibileMerceDecimale—0totaleimponibilemerceTotale imponibile merce.
TotaleIVAMerceDecimale—0totaleivamerceTotale IVA merce.
TotaleImponibileMerceNettoScontoDecimale—0totaleimponibilemercenettoscontoTotale imponibile merce netto sconto.
TotaleIVAMerceNettoScontoDecimale—0totaleivamercenettoscontoTotale IVA merce netto sconto.
TotaleImponibileOmaggioDecimale—0totaleimponibileomaggioTotale imponibile omaggio.
TotaleIVAOmaggioDecimale—0totaleivaomaggioTotale IVA omaggio.
TotaleImponibileOmaggioNettoScontoDecimale—0totaleimponibileomaggionettoscontoTotale imponibile omaggio netto sconto.
TotaleIVAOmaggioNettoScontoDecimale—0totaleivaomaggionettoscontoTotale IVA omaggio netto sconto.
TotaleImponibileSpeseDecimale—0totaleimponibilespeseTotale imponibile spese.
TotaleIVASpeseDecimale—0totaleivaspeseTotale IVA spese.
TotaleImponibileSpeseNettoScontoDecimale—0totaleimponibilespesenettoscontoTotale imponibile spese netto sconto.
TotaleIVASpeseNettoScontoDecimale—0totaleivaspesenettoscontoTotale IVA spese netto sconto.
TotaleReferenzeDecimale—0totalereferenzeTotale referenze.
TotaleQuantitaDecimale—0totalequantitaTotale quantità.
ArrotondamentoDecimale—0arrotondamentoArrotondamento.
GuidPostazioneTesto—vuoto—Identificativo della postazione che ha creato il record.
DataEOraInserimentoData e ora—data e ora attualidataeorainserimentoData e ora inserimento.
AddebitateSpeseEvasioneVero/falso—falseaddebitatespeseevasioneAddebitate spese evasione.
MetodoDiSpedizioneTesto—vuotometododispedizioneMetodo di spedizione. Codice dell'archivio Metodi di spedizione.
TotaleBuoniDecimale—0totalebuoniTotale buoni.
ZonaSpedizioneTesto—vuotozonaspedizioneZona spedizione. Codice dell'archivio Zone di spedizione.
GaraAppaltoTesto—vuotogaraappaltoCodice della gara d'appalto.
NettoAPagareDecimale—0nettoapagareNetto a pagare.
DataConsegnaData e ora—nessuna datadataconsegnaData di consegna prevista.
CausaleTrasportoTesto—vuotocausaletraspCausale trasporto. Codice dell'archivio Causali di trasporto.
TrasportoAMezzoTesto—vuototrasportoamezzoTrasporto a mezzo. Codice dell'archivio Mezzi di trasporto.
PortoTesto—vuotoportoPorto. Codice dell'archivio Porti.
AspettoBeniTesto—vuotoaspettobeniAspetto esteriore dei beni.
NumeroColliIntero—0ncolliNumero dei colli.
PesoDecimale—0pesoPeso.
Spedizioniere1Testo—vuotospedizioniere1Spedizioniere 1. Codice dell'archivio Spedizionieri.
Autista1Testo—vuotoautista1Autista 1.
DataTrasporto1Data e ora—nessuna datadatatrasp1Data trasporto 1.
OraInizioTrasporto1Testo—vuotoorainizio1Ora inizio trasporto 1.
TrackingSpedizione1Testo—vuototrackingspedizione1Tracking spedizione 1.
Spedizioniere2Testo—vuotospedizioniere2Spedizioniere 2. Codice dell'archivio Spedizionieri.
Autista2Testo—vuotoautista2Autista 2.
DataTrasporto2Data e ora—nessuna datadatatrasp2Data trasporto 2.
OraInizioTrasporto2Testo—vuotoorainizio2Ora inizio trasporto 2.
TrackingSpedizione2Testo—vuototrackingspedizione2Tracking spedizione 2.
PercentualeRitenutaDecimale—0percritPercentuale ritenuta.
ValoreRitenutaDecimale—0valritValore ritenuta.
PercentualeRitenutaImponibileDecimale—0percritimponPercentuale ritenuta imponibile.
ImponibileRitenutaAccontoDecimale—0imponritaccontoImponibile ritenuta acconto.
CodiceIVAArrotondamentiTesto—vuotocodivaarrotondamentiCodice IVA arrotondamenti. Codice dell'archivio Codici IVA.
AddebitaBolloVero/falso—falseaddebitabolloVero se il bollo viene addebitato.
BolloVirtualeVero/falso—falsebollovirtualeVero se il bollo è assolto in modo virtuale.
ImportoBolliDecimale—0importobolliImporto bolli.
DHMPeriodoTesto—vuotodhmperiodoPeriodo.
DHMMantenimentoDaDataData e ora—nessuna datadhmmantenimentodadataMantenimento da data.
DHMMantenimentoADataData e ora—nessuna datadhmmantenimentoadataMantenimento a data.
DHMClienterProprietarioTesto—vuotodhmclienterproprietarioClienter proprietario.
DHMSpecieAnimaleTesto—vuotodhmspecieanimaleSpecie animale.
DHMPresenzaAnimaleTesto—vuotodhmpresenzaanimalePresenza animale.
DHMStrutturaOspitanteTesto—vuotodhmstrutturaospitanteStruttura ospitante.
DHMCaricaAncheaZeroVero/falso—falsedhmcaricaancheazeroCarica anchea zero.
DHMConteggiaGiornoMorteVero/falso—falsedhmconteggiagiornomorteConteggia giorno morte.
DHMUsaAlgAlbergoVero/falso—falsedhmusaalgalbergoUsa alg albergo.
DHMTipologiaAnimaleTesto—vuotodhmtipologiaanimaleTipologia animale.
DHMTipoCalcoloMantenimentoTesto—vuotodhmtipocalcolomantenimentoTipo calcolo mantenimento.
AssoggettatoRitenutaDiGaranziaVero/falso—falseassoggettatoritenutadigaranziaAssoggettato ritenuta di garanzia.
AssoggettatoRitenutaDiGaranziaPercentualeDecimale—0assoggettatoritenutadigaranziapercentualeAssoggettato ritenuta di garanzia percentuale.
AssoggettatoRitenutaDiGaranziaRimborsataVero/falso—falseassoggettatoritenutadigaranziarimborsataAssoggettato ritenuta di garanzia rimborsata.
AssoggettatoEcoBonusVero/falso—falseassoggettatoecobonusAssoggettato eco bonus.
AssoggettatoEcoBonusPercentualeDecimale—0assoggettatoecobonuspercentualeAssoggettato eco bonus percentuale.
ReferredFromTesto—vuotoreferredProvenienza dell'ordine (sito di origine o campagna).
InsertUserTesto—vuotouserinsertUtente che ha inserito il record.
BuoniAssociatiElenco di BuonoSuDocumento—elenco vuoto—Buoni sconto usati nel documento.
ListaCorpoElenco di DocumentCorpoSìelenco vuoto—Righe del documento. Obbligatorio: almeno una riga. Se manca il server risponde «Nessuna riga inserita nel corpo documento».

Classe annidata BuonoSuDocumento

Elemento usato dentro Document. I suoi campi si inviano e si ricevono insieme al record principale.

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceTesto—vuotoCodice univoco del record. È la chiave con cui il record viene creato o aggiornato.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
ImportoDecimale—0Importo.

Classe annidata DocumentCorpo

Elemento usato dentro Document. I suoi campi si inviano e si ricevono insieme al record principale.

CampoTipoObbligatorioPredefinitoA cosa serve
IndiceRigaDiRiferimentoIntero—-1Indice della riga a cui questa si riferisce.
TipoRigaTesto—"Riga articolo"Tipo della riga.
CodiceArticoloTesto—vuotoCodice dell'articolo; vuoto per le righe descrittive. Codice dell'archivio Articoli.
StringaVariantiTesto—vuotoValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
DescrizioneArticoloTesto—vuotoDescrizione stampata sulla riga.
QuantitaDecimale—0Quantità.
ImponibileUnitarioDecimale—0Prezzo unitario senza IVA.
ImportoUnitarioDecimale—0Prezzo unitario con IVA.
ImponibileUnitarioNettoScontiDecimale—0Imponibile unitario netto sconti.
ImportoUnitarioNettoScontiDecimale—0Importo unitario netto sconti.
ImportoDecimale—0Importo.
ScontiTesto—vuotoSconti della riga, come nel gestionale (per esempio 10+5).
NoteTesto—vuotoNote libere.
CodiceIVATesto—vuotoCodice IVA. Codice dell'archivio Codici IVA.
DepositoTesto—vuotoDeposito movimentato dalla riga. Codice dell'archivio Depositi.
DepositoDestinazioneTesto—vuotoDeposito di destinazione, per i trasferimenti. Codice dell'archivio Depositi.
TotaleImponibileDecimale—0Totale imponibile.
TotaleIVADecimale—0Totale IVA.
TotaleDecimale——Totale.
TotaleImponibileNettoScontoDecimale—0Totale imponibile netto sconto.
TotaleIVANettoScontoDecimale—0Totale IVA netto sconto.
TotaleImponibileMerceDecimale—0Totale imponibile merce.
TotaleIVAMerceDecimale—0Totale IVA merce.
TotaleImponibileMerceNettoScontoDecimale—0Totale imponibile merce netto sconto.
TotaleIVAMerceNettoScontoDecimale—0Totale IVA merce netto sconto.
TotaleImponibileOmaggioDecimale—0Totale imponibile omaggio.
TotaleIVAOmaggioDecimale—0Totale IVA omaggio.
TotaleImponibileOmaggioNettoScontoDecimale—0Totale imponibile omaggio netto sconto.
TotaleIVAOmaggioNettoScontoDecimale—0Totale IVA omaggio netto sconto.
TotaleNettoScontoDecimale—0Totale netto sconto.
TotaleMerceDecimale—0Totale merce.
TotaleMerceNettoScontoDecimale—0Totale merce netto sconto.
TotaleOmaggioDecimale—0Totale omaggio.
TotaleOmaggioNettoScontoDecimale—0Totale omaggio netto sconto.
UnitaDiMisuraTesto—vuotoUnità di misura della riga. Codice dell'archivio Unità di misura.
ArticoloGestioneSerialiVero/falso—falseArticolo gestione seriali.
ArticoloGestioneVariantiVero/falso—falseArticolo gestione varianti.
ArticoloTipoArticoloTesto—vuotoArticolo tipo articolo.
ArticoloTipoArticoloDescrizioneTesto—vuotoDescrizione di ArticoloTipoArticolo, riportata per comodità di chi legge.
ArticoloPrintBundleDettaglioVero/falso—falseArticolo print bundle dettaglio.
ArticoloBrandCodiceTesto—vuotoArticolo brand codice.
ArticoloBrandDescrizioneTesto—vuotoArticolo brand descrizione.
ArticoloSottoCategoriaCodiceTesto—vuotoArticolo sotto categoria codice.
ArticoloSottoCategoriaDescrizioneTesto—vuotoArticolo sotto categoria descrizione.
ArticoloRepartoCodiceTesto—vuotoArticolo reparto codice.
ArticoloRepartoDescrizioneTesto—vuotoArticolo reparto descrizione.
ArticoloScalaValoriVariabiliCodiceTesto—vuotoArticolo scala valori variabili codice.
ArticoloScalaValoriVariabiliDescrizioneTesto—vuotoArticolo scala valori variabili descrizione.
ArticoloOptionalAttivabiliIntero—0Articolo optional attivabili.
ArticoloCodiceIVATesto—vuotoArticolo codice IVA.
ArticoloContropatitaATesto—vuotoArticolo contropatita a.
ArticoloContropatitaVTesto—vuotoArticolo contropatita v.
ArticoloFotoTesto—vuotoArticolo foto.
ControPartitaTesto—vuotoContro partita.
ArticoloUnitaMisuraTesto—vuotoArticolo unità misura.
ArticoloCategoriaMerceologicaTesto—vuotoArticolo categoria merceologica.
ArticoloCategoriaMerceologicaDescrizioneTesto—vuotoDescrizione di ArticoloCategoriaMerceologica, riportata per comodità di chi legge.
OrdinatoStatoTesto—vuotoOrdinato stato.
OrdinatoDataOraData e ora—nessuna dataOrdinato data ora.
OrdinatoNoteTesto—vuotoOrdinato note.
OrdinatoFornitoreTesto—vuotoOrdinato fornitore.
OrdinatoRifDocTesto—vuotoOrdinato rif doc.
ConsegnatoStatoTesto—vuotoConsegnato stato.
ConsegnatoDataOraData e ora—nessuna dataConsegnato data ora.
ConsegnatoNoteTesto—vuotoConsegnato note.
ConsegnatoRifDocTesto—vuotoConsegnato rif doc.
ConsegnatoUserTesto—vuotoConsegnato user.
InsertUserTesto—vuotoUtente che ha inserito il record.
ListaSerialiElenco di Testo—elenco vuotoNumeri di serie della riga.
ListaOptionalElenco di DocumentoCorpoOptional—elenco vuotoOptional aggiunti alla riga.

Classe annidata DocumentoCorpoOptional

Elemento usato dentro DocumentCorpo. I suoi campi si inviano e si ricevono insieme al record principale.

CampoTipoObbligatorioPredefinitoA cosa serve
OptProgressivoIntero—0Opt progressivo.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
ImportoDecimale—0Importo.
CalcImponibileDecimale—0Calc imponibile.
CalcIVADecimale—0Calc IVA.
CalcImponibileNettoScontiDecimale—0Calc imponibile netto sconti.
CalcIVANettoScontiDecimale—0Calc IVA netto sconti.

Classe annidata RigaCastellettoIVA

Elemento usato dentro Document. I suoi campi si inviano e si ricevono insieme al record principale.

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceIVATesto—vuotoCodice IVA. Codice dell'archivio Codici IVA.
DescrizioneIVATesto—vuotoDescrizione IVA.
AliquotaDecimale—0Aliquota.
NaturaTesto—vuotoNatura.
ImponibileDecimale—0Imponibile.
ImpostaDecimale—0Imposta.

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": 23,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDocument": [
    {
      "Tipo": "COD001",
      "Esercizio": "2026",
      "Serie": "COD002",
      "Registro": "COD003",
      "Numero": 1,
      "Controparte": "COD004",
      "TipoControparte": "C",
      "Data": "2026-03-15T00:00:00",
      "CausaleMagazzino": "ESEMPIO",
      "ListaCorpo": [
        {
          "IndiceRigaDiRiferimento": 1,
          "TipoRiga": "ESEMPIO",
          "CodiceArticolo": "COD001",
          "StringaVarianti": ""
        }
      ]
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 23,
  "GuidPC": "gestionale-01",
  "ObjectListDocument": [
    {
      "Tipo": "COD001",
      "Esercizio": "2026",
      "Serie": "COD003",
      "Registro": "COD004",
      "Numero": 1,
      "Controparte": "COD006",
      "TipoControparte": "C"
    }
  ]
}

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

PrecedenteCategorie provvigionaliSuccessivaTipi di documento