Universal Web Platform · Bozze dei documenti

BozzaDocumento: i documenti in preparazione, non ancora emessi

Bozze dei documenti: i documenti in preparazione, non ancora emessi. Nel web service è il tipo BOZZADOCUMENTO (valore 114 di DataType); gli oggetti sono della classe BozzaDocumento e viaggiano nella lista ObjectListBozzaDocumento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoBOZZADOCUMENTO = 114
ClasseBozzaDocumento
Lista nella richiesta e nella rispostaObjectListBozzaDocumento
Tabella letta da QUERYBozzeDocumenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveAnno + Serie + Numero — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassAnno|Serie|Numero
Chiave per le conferme di ricezioneAnno|Serie|Numero — come si usa
Controlli prima del salvataggioAnno: «Anno non specificato»
Numero: «Numero non specificato»
TipoControparte: «Tipo controparte non specificato»
Controparte: «Controparte non specificato»
Data: «Data non specificata»

I campi di BozzaDocumento

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
AnnoInteroChiave, sì0annoAnno. Se manca il server risponde «Anno non specificato».
SerieTestoChiavevuotoserieSerie.
NumeroIntero lungoChiave, sì0numeroNumero. Se manca il server risponde «Numero non specificato».
TipoTesto—vuototipoTipo.
TipoControparteTestoSì"C"tipocontroparteTipo controparte. Se manca il server risponde «Tipo controparte non specificato».
ControparteTestoSìvuotocontroparteControparte. Codice dell'archivio Clienti e fornitori. Se manca il server risponde «Controparte non specificato».
PagamentoTesto—vuotopagamentoCodice della condizione di pagamento. Codice dell'archivio Pagamenti.
DataData e oraSìnessuna datadataData. Se manca il server risponde «Data non specificata».
NoteTesto—vuotonoteNote libere.
ListaCorpoElenco di BozzaDocumentoCorpo—elenco vuoto—Corpo: elenco di oggetti BozzaDocumentoCorpo.

Classe annidata BozzaDocumentoCorpo

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoRigaTesto—"Riga articolo"Tipo della riga.
CodiceArticoloTesto—vuotoCodice dell'articolo. Codice dell'archivio Articoli.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
QuantitaDecimale—0Quantità.
ImportoDecimale—0Importo.
ScontoTesto—vuotoSconto.
NoteTesto—vuotoNote libere.

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": 114,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListBozzaDocumento": [
    {
      "Anno": 2026,
      "Serie": "COD001",
      "Numero": 1,
      "Tipo": "ESEMPIO",
      "TipoControparte": "C",
      "Controparte": "ESEMPIO",
      "Pagamento": "ESEMPIO",
      "Data": "2026-03-15T00:00:00"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 114,
  "GuidPC": "gestionale-01",
  "ObjectListBozzaDocumento": [
    {
      "Anno": 2026,
      "Serie": "COD002",
      "Numero": 1
    }
  ]
}

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