Universal Web Platform · Scadenze dei documenti

DocumentScadenze: le rate di pagamento generate dai documenti

Scadenze dei documenti: le rate di pagamento generate dai documenti. Nel web service è il tipo DOCUMENTISCADENZE (valore 53 di DataType); gli oggetti sono della classe DocumentScadenze e viaggiano nella lista ObjectListDocumentScadenze della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDOCUMENTISCADENZE = 53
ClasseDocumentScadenze
Lista nella richiesta e nella rispostaObjectListDocumentScadenze
Tabella letta da QUERYDocumentiScadenze — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveDocTipo + DocEsercizio + DocSerie + DocRegistro + DocNumero + DocTipoControparte + DocControparte + DocProgressivo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassDocTipo|DocEsercizio|DocSerie|DocRegistro|DocNumero|DocTipoControparte|DocControparte|DocProgressivo
Chiave per le conferme di ricezioneDocTipo|DocEsercizio|DocSerie|DocRegistro|DocNumero|DocControparte|DocTipoControparte|DocProgressivo — come si usa
Controlli prima del salvataggioDocTipo: «Tipo documento non specificato»
DocEsercizio: «Esercizio documento non specificato»
DocNumero: «Numero documento non specificato»
DocTipoControparte: «Tipo controparte non specificato»
DocControparte: «Controparte non specificato»
Data: «Data non specificata»

I campi di DocumentScadenze

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
DocTipoTestoChiave, sìvuototipoDoc tipo. Se manca il server risponde «Tipo documento non specificato».
DocEsercizioTestoChiave, sìvuotoesercizioDoc esercizio. Se manca il server risponde «Esercizio documento non specificato».
DocSerieTestoChiavevuotoserieDoc serie.
DocRegistroTestoChiavevuotoregDoc registro.
DocNumeroDecimaleChiave, sì0numeroDoc numero. Se manca il server risponde «Numero documento non specificato».
DocTipoControparteTestoChiave, sìvuototipocliforDoc tipo controparte. Se manca il server risponde «Tipo controparte non specificato».
DocControparteTestoChiave, sìvuotocontroparteDoc controparte. Se manca il server risponde «Controparte non specificato».
DocProgressivoIntero lungoChiave0progressivoDoc progressivo.
TipoScadenzaTesto—vuototiposcadenzaTipo scadenza.
TipoScadenzaPATesto—"MP05"tiposcadenzapaTipo scadenza PA.
DataData e oraSìnessuna datadataData. Se manca il server risponde «Data non specificata».
ImportoDecimale—0importoImporto.
GeneraIncassoVero/falso—falsegeneraincassoGenera incasso.
ContropartitaIncassoTesto—vuotocontroincassoContropartita incasso.
SezioneContabileIncassoTesto—vuotosezcontincassoSezione contabile incasso.
TrasmesseVero/falso—falseesportateTrasmesse.
DataTrasmissioneData e ora—nessuna datadataesportData trasmissione.
ClassificazioneTesto—vuotoclassificazioneCodice della classificazione.
NonAvvisareAlertVero/falso—falsenonavvisarealertNon avvisare alert.
SoloStampaVero/falso—falsesolostampaSolo stampa.

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": 53,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDocumentScadenze": [
    {
      "DocTipo": "COD001",
      "DocEsercizio": "COD002",
      "DocSerie": "COD003",
      "DocRegistro": "COD004",
      "DocNumero": 1,
      "DocTipoControparte": "COD005",
      "DocControparte": "COD006",
      "DocProgressivo": 1,
      "TipoScadenza": "ESEMPIO",
      "Data": "2026-03-15T00:00:00"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 53,
  "GuidPC": "gestionale-01",
  "ObjectListDocumentScadenze": [
    {
      "DocTipo": "COD001",
      "DocEsercizio": "COD002",
      "DocSerie": "COD003",
      "DocRegistro": "COD004",
      "DocNumero": 1,
      "DocTipoControparte": "COD006",
      "DocControparte": "COD007",
      "DocProgressivo": 1
    }
  ]
}

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