Righe predefinite: le righe che si aggiungono da sole ai documenti. Nel web service è il tipo RIGHEPREDEFINITEPERDOC (valore 45 di DataType); gli oggetti sono della classe RighePredefinitePerDoc e viaggiano nella lista ObjectListRighePredefiniteDoc della richiesta e della risposta.
Scheda tecnica
| Voce | Valore |
|---|
| Tipo di dato | RIGHEPREDEFINITEPERDOC = 45 |
| Classe | RighePredefinitePerDoc |
| Lista nella richiesta e nella risposta | ObjectListRighePredefiniteDoc |
| Tabella letta da QUERY | RighePerDoc — è il nome da usare davanti alle colonne in SQLFilter |
| Operazioni ammesse | QUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2) |
| Campi chiave | Codice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea |
| Chiave per cancellare con DeletingClass | Codice |
| Chiave per le conferme di ricezione | Codice — come si usa |
| Controlli prima del salvataggio | Codice: «Codice non specificato» |
I campi di RighePredefinitePerDoc
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.
| Campo | Tipo | Obbligatorio | Predefinito | Colonna | A cosa serve |
|---|
Codice | Testo | Chiave, sì | vuoto | codice | Codice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato». |
Descrizione | Testo | — | vuoto | descrizione | Descrizione del record, mostrata nel gestionale e sul sito. |
TipoRiga | Testo | — | vuoto | tiporiga | Tipo della riga. |
Importo | Decimale | — | 0 | importo | Importo. |
IVAInclusa | Vero/falso | — | false | ivainclusa | Vero se gli importi comprendono l'IVA. |
CodiceIVA | Testo | — | vuoto | codiceiva | Codice IVA. Codice dell'archivio Codici IVA. |
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": 45,
"GuidPC": "gestionale-01",
"AllInsert": false,
"ObjectListRighePredefiniteDoc": [
{
"Codice": "COD001",
"Descrizione": "Descrizione di esempio",
"TipoRiga": "ESEMPIO",
"Importo": 1,
"IVAInclusa": false,
"CodiceIVA": "COD002"
}
]
}
Lettura con filtro: fino a 100 record, ignorando le conferme di ricezione.
JSON · QUERY{
"DataOperation": 3,
"TypeObject": 45,
"GuidPC": "gestionale-01",
"SQLFilter": "RighePerDoc.codice = 'COD001'",
"QueryParameter": {
"IgnoreImportRecord": true,
"StartingRecord": 1,
"LimitRecord": 100
}
}
Cancellazione: bastano i campi chiave.
JSON · DELETE{
"DataOperation": 1,
"TypeObject": 45,
"GuidPC": "gestionale-01",
"ObjectListRighePredefiniteDoc": [
{
"Codice": "COD001"
}
]
}
Le regole su formati, date, numeri e compressione sono in formato e trasporto; esempi completi in esempi di codice.