Concetti fondamentali
Resources e Sync
/api/resources/{Resource} | /api/sync/{Resource} | |
|---|---|---|
| Uso tipico | Lettura e ricerca da applicazioni e front-end | Integrazione fra sistemi, scambio massivo |
| Lettura | Elenco paginato con filtro RecordSelection, ricerca POST …/query | Solo i record variati dopo LastUtcRun |
| Scrittura | — | POST con array di record |
Chiavi
Ogni risorsa ha campi chiave, segnati con 🔑 nelle schede, e la chiave comprende sempre customer_ID. Esempi:
| Risorsa | Chiave (oltre a customer_ID) |
|---|---|
Articoli | cod_art, cod_variante |
CliFor | ind_clifor, cod_clifor |
StoricoDocumentiT | key_documento |
StoricoDocumentiR | key_documento, prg_riga |
Convenzioni sui nomi dei campi
| Prefisso | Significato | Esempio |
|---|---|---|
cod_ | Codice | cod_art, cod_clifor |
des_ | Descrizione | des_ragsoc, des_articolo |
dat_ | Data/ora | dat_doc, dat_ultvar |
qta_ | Quantità | qta_merce |
prz_ / val_ | Prezzo / valore | prz_merce, val_tot_doc |
prc_ | Percentuale | prc_iva, prc_sconto1 |
flg_ | Flag (bit o carattere) | flg_isdeleted, flg_pers_fis |
ind_ | Indicatore a codice | ind_clifor (C/F) |
sig_ | Sigla | sig_prov_res, sig_iso |
prg_ / num_ | Progressivo / numero | prg_riga, num_anno |
key_ | Chiave assegnata dal sistema esterno | key_documento |
Coppie codice/descrizione
Molte risorse riportano accanto al codice anche la descrizione dell'entità collegata, per esempio cod_famiglia e des_famiglia in Articoli. Valorizza entrambe quando invii i dati: chi legge non dovrà fare chiamate aggiuntive.
Cancellazione logica
flg_isdeleted indica un record cancellato logicamente. Invia flg_isdeleted: false sui record attivi e gestisci i record con flg_isdeleted = true ricevuti da GET /api/sync.