Universal Web Platform · Web service

Web service di Universal Web Platform: protocollo, tipi di dato ed esempi

Documentazione tecnica

Il web service, area per area

Scegli l'area in alto e il tipo di dato a sinistra: per ognuno trovi campi, tipi, obbligatori, chiave ed esempi JSON. Si parte dal protocollo.

Integrazione con altri software

Integrazione con altri software: il web service di Universal Web Platform

Universal Web Platform ha un web service con cui qualsiasi programma può leggere e scrivere i dati del sito: articoli, prezzi, immagini, giacenze, clienti, ordini e documenti, scadenze, contenuti del sito e tutti gli archivi di Dog House Management. È lo stesso canale che usa Business Intelligence Evolution per pubblicare il catalogo e scaricare gli ordini, e lo puoi usare per collegare il tuo gestionale, un marketplace, un'app, un sistema di logistica o un flusso di automazione.

In queste pagine trovi tutto quello che serve per costruire l'integrazione senza chiedere nulla: come si chiama l'indirizzo, come si autentica la chiamata, come si comprime il corpo, che cosa contengono richiesta e risposta, e per ogni tipo di dato la classe con tutti i campi, il loro significato, i valori predefiniti, i campi chiave e quelli obbligatori.

Come funziona in una frase

Invii in POST a https://<tuo-dominio>/webservice.aspx?Key=<chiave>&serialize=json un oggetto WebServiceRequest in JSON o XML, compresso gzip; il server risponde con un WebServiceResponse compresso allo stesso modo. La richiesta dice che cosa fare (DataOperation), su quale tipo di dato (TypeObject) e, per le scritture, con quali record (la lista ObjectList<Classe> del tipo).

Che cosa puoi fare

OperazioneValoreA cosa serve
INSERTORMODIFY0Crea i record nuovi e aggiorna quelli esistenti, riconosciuti dai campi chiave.
DELETE1Cancella i record indicati, riconosciuti dai campi chiave.
TRUNCATETABLE2Svuota l'intero archivio del tipo indicato. Da usare con estrema cautela.
QUERY3Legge i record, con filtro, paginazione, conteggio e sincronizzazione incrementale.
DELETEALLIMPORTCORRISPONDENZE4Azzera tutte le conferme di ricezione della postazione: la prossima lettura ricomincia da capo.
DELETEIMPORTCORRISPONDENZEBYTABLE5Azzera le conferme di ricezione della postazione per un solo tipo di dato.

Gli scenari tipici

  • Pubblicare il catalogo dal tuo gestionale. Invii in ordine gli archivi di base (marchi, categorie, IVA, unità di misura, listini, varianti), poi gli Articoli, i Prezzi degli articoli, le Immagini degli articoli e le Giacenze.
  • Scaricare gli ordini del sito. Leggi i Documenti con QUERY e, record per record, mandi la conferma di ricezione: alla lettura successiva arrivano solo gli ordini nuovi o modificati.
  • Allineare clienti e destinazioni. Clienti e fornitori e Destinazioni diverse nei due sensi.
  • Tenere aggiornate le quantità. Invii solo le giacenze cambiate, anche ogni pochi minuti.
  • Leggere molti tipi in una volta. Con ImportMulti scarichi fino a 64 tipi in una sola chiamata e confermi nello stesso giro quelli ricevuti prima.

Da dove cominciare

  1. Chiedi all'amministratore del sito una chiave abilitata ai tipi di dato che ti servono, in lettura e o in scrittura: endpoint e chiave di accesso.
  2. Prepara il trasporto: POST, corpo UTF-8 compresso gzip, risposta gzip: formato e trasporto.
  3. Costruisci la richiesta: la richiesta, poi scrivere e leggere i dati.
  4. Controlla sempre lo stato e l'elenco degli errori: la risposta e gli errori.
  5. Per scaricare solo le novità usa le conferme: sincronizzazione incrementale.
  6. Per ogni tipo di dato apri la sua pagina dall'elenco dei tipi di dato.

Se scrivi in .NET

La libreria SFHIEDataDefinition contiene tutte le classi descritte qui e la classe Export, che compone la richiesta, la comprime, la invia, ripete i tentativi e restituisce la risposta già deserializzata. Con gli altri linguaggi costruisci gli stessi oggetti in JSON: i nomi dei campi sono identici. Vedi gli esempi di codice.

Endpoint e chiave di accesso

Endpoint e chiave di accesso: indirizzo, parametri e permessi del web service

Il web service risponde a un solo indirizzo per sito, con la chiave e le opzioni nella query string.

Indirizzo
POST https://<tuo-dominio>/webservice.aspx?Key=<chiave>&serialize=json

Il nome della pagina è webservice.aspx (maiuscole e minuscole sono indifferenti); l'estensione .aspx è necessaria. Usa sempre HTTPS: la chiave viaggia nell'indirizzo.

Parametri della query string

ParametroValoriObbligatorioA cosa serve
Keyla chiave ricevutaSìIdentifica chi chiama e i permessi. Senza una chiave valida e attiva la richiesta viene rifiutata.
serializejson oppure xmlNoFormato di richiesta e risposta. Con json si usa JSON; con qualsiasi altro valore, o senza parametro, XML.
directshowtrueNoLa risposta contiene solo l'elenco dei record del tipo richiesto, senza l'involucro WebServiceResponse (quindi senza stato ed errori).
operationmultiimportmultiNoUsa il protocollo ImportMulti: più tipi di dato in lettura nella stessa chiamata.
operationbierecreateafterexportNoEsegue la ricostruzione che segue una pubblicazione completa: vedi qui.
compressiontrueNoCompatibilità con i client vecchi che inviavano il corpo compresso e poi codificato in Base64. Non usarlo nelle integrazioni nuove.

La chiave e i permessi

L'amministratore del sito attiva il web service e crea una chiave per ogni programma che si collega. Per ogni chiave decide:

  • se la chiave è attiva: una chiave disattivata viene rifiutata senza eseguire nulla;
  • per ogni tipo di dato (per nome, per esempio PRODUCT o DOCUMENT) se è permessa la lettura e se è permessa la scrittura. Un tipo che non compare nell'elenco della chiave non è accessibile.
OperazionePermesso richiesto
QUERYlettura sul tipo
INSERTORMODIFY, DELETE, TRUNCATETABLEscrittura sul tipo
DELETEALLIMPORTCORRISPONDENZE, DELETEIMPORTCORRISPONDENZEBYTABLEil tipo indicato in TypeObject deve essere nell'elenco della chiave
Conferme di ricezionescrittura su RECEVEIDCLASS
ImportMultilettura su ogni tipo richiesto; per le conferme, scrittura su RECEVEIDCLASS e lettura sul tipo confermato
Dai a ogni programma la sua chiave, con i soli permessi che gli servono: un sito che riceve il catalogo non ha bisogno di scrivere i documenti, un'app che legge gli ordini non ha bisogno di cancellare gli articoli.

Le risposte di rifiuto

Quando la chiamata viene rifiutata ricevi comunque un WebServiceResponse nel formato richiesto, con lo stato e il messaggio in ResponseString e in ErrorList.

MessaggioStatusCausa
Web Service disattivo. Nessuna richiesta disponibilekeyinvalidIl web service non è attivo su questo sito.
Key non valida per la richiestakeyinvalidLa chiave non esiste.
Key disattivata. Impossibile eseguire richiestekeyinvalidLa chiave esiste ma è disattivata.
Key non autorizzata per l'operazione richiestakeyinvalidIl tipo di dato non è tra quelli della chiave.
Key non autorizzata per l'operazione di scritturakeyinvalidScrittura, cancellazione o svuotamento senza permesso di scrittura.
Key non autorizzata per l'operazione di letturakeyinvalidQUERY senza permesso di lettura.
Errore: Deserializzazione oggetto richiesta: …koIl corpo non è un WebServiceRequest valido: in ErrorList trovi anche il testo ricevuto e la diagnostica del corpo.

Le richieste rifiutate vengono anche scritte nel registro giornaliero degli errori del web service, che l'amministratore del sito può consultare quando un'integrazione non funziona.

Formato e trasporto

Formato e trasporto: HTTP, gzip, JSON e XML

Richiesta e risposta viaggiano come testo UTF-8 compresso gzip, senza altre codifiche. Il formato del testo è JSON o XML, scelto con il parametro serialize.

La chiamata HTTP

ElementoValore
MetodoPOST
Corpola richiesta serializzata in UTF-8 e compressa gzip, così com'è (niente Base64, niente form)
Content-Typeapplication/octet-stream
Content-Encodinggzip
Accept-Encodinggzip
RispostaUTF-8 compresso gzip, con Content-Encoding: gzip e Content-Type application/json; charset=utf-8 oppure application/xml; charset=utf-8
Tempo massimole letture grandi possono durare: imposta un timeout ampio, nell'ordine dei minuti (la libreria .NET usa 6.000 secondi)

Il server riconosce il gzip dai primi due byte (1F 8B). Se un proxy ha già decompresso il corpo, il testo in chiaro viene accettato lo stesso; è una tolleranza, non un'alternativa: invia sempre il corpo compresso. Molte librerie HTTP decomprimono la risposta da sole quando vedono Content-Encoding: gzip; se la tua non lo fa, decomprimila tu.

Regole del JSON

ElementoRegola
Nomi dei campiGli stessi nomi delle proprietà delle classi (DataOperation, ObjectListProduct, Codice...). In lettura maiuscole e minuscole non contano; i campi sconosciuti vengono ignorati.
Campi omessiAssumono il valore predefinito della classe, indicato in ogni pagina dei tipi. Attenzione: in un aggiornamento un campo omesso sovrascrive il valore salvato con il predefinito.
EnumerazioniIl server le scrive come numeri ("TypeObject": 19). In invio sono accettati sia il numero sia il nome ("TypeObject": "PRODUCT").
DateISO 8601, come "2026-03-15T00:00:00". Il server scrive il formato esteso 2026-03-15T00:00:00.0000000. La data vuota è 0001-01-01T00:00:00.
Numeri decimaliCon il punto: 12.5. Mai la virgola, mai tra virgolette.
Booleanitrue / false.
Valori nullAmmessi per oggetti ed elenchi; per i testi è meglio la stringa vuota.
CaratteriScrivi accenti e simboli direttamente in UTF-8. Le entità numeriche XML (&#x...;) vengono rimosse prima di interpretare la richiesta.
ObjectListNella risposta JSON può comparire anche ObjectList, che ripete la lista del tipo richiesto: puoi ignorarlo. In invio non usarlo: compila la lista tipizzata, per esempio ObjectListBrand.

Regole dell'XML

L'XML è quello standard del serializzatore .NET: l'elemento radice è <WebServiceRequest>, ogni proprietà è un elemento con lo stesso nome, le liste contengono un elemento per record con il nome della classe, le enumerazioni si scrivono per nome (<TypeObject>BRAND</TypeObject>), le date in ISO 8601, i decimali con il punto, i booleani true/false.

XML · un marchio
<?xml version="1.0" encoding="utf-8"?>
<WebServiceRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DataOperation>INSERTORMODIFY</DataOperation>
  <SQLFilter />
  <GuidPC>gestionale-01</GuidPC>
  <TypeObject>BRAND</TypeObject>
  <AllInsert>false</AllInsert>
  <ObjectListBrand>
    <Brand>
      <Codice>ACME</Codice>
      <Descrizione>Acme</Descrizione>
      <DescrizioneDettagliata />
      <SitoWEB>https://www.example.com</SitoWEB>
      <Obsoleto>false</Obsoleto>
      <Ordinamento>10</Ordinamento>
    </Brand>
  </ObjectListBrand>
</WebServiceRequest>
JSON · la stessa richiesta
{
  "DataOperation": 0,
  "SQLFilter": "",
  "GuidPC": "gestionale-01",
  "TypeObject": 0,
  "AllInsert": false,
  "ObjectListBrand": [
    { "Codice": "ACME", "Descrizione": "Acme", "SitoWEB": "https://www.example.com", "Obsoleto": false, "Ordinamento": 10 }
  ]
}

La richiesta

La richiesta WebServiceRequest: operazione, tipo di dato e record

Ogni chiamata, tranne ImportMulti, invia un oggetto WebServiceRequest. Contiene l'operazione, il tipo di dato, i parametri di lettura e, per le scritture, la lista dei record.

I campi di WebServiceRequest

CampoTipoObbligatorioA cosa serve
DataOperationIntero (enumerazione)SìL'operazione: 0 INSERTORMODIFY, 1 DELETE, 2 TRUNCATETABLE, 3 QUERY, 4 DELETEALLIMPORTCORRISPONDENZE, 5 DELETEIMPORTCORRISPONDENZEBYTABLE.
TypeObjectIntero (DataType)SìIl tipo di dato su cui operare. Decide anche quale lista viene letta o restituita.
GuidPCTestoSì per QUERY e confermeIdentificativo stabile del programma o della postazione che chiama, scelto da te (per esempio magazzino-milano o un GUID). Serve alla sincronizzazione incrementale: ogni postazione ha le sue conferme. Usa sempre lo stesso valore.
SQLFilterTestoNoSolo per QUERY: condizione SQL aggiunta alla lettura. Vedi leggere i dati.
QueryParameterQueryParameterNoSolo per QUERY: paginazione, conteggio, filtri per evento e deposito, gestione delle conferme.
AllInsertVero/falsoNoSolo per INSERTORMODIFY: con true i record vengono aggiunti senza cercare se esistono già. È più veloce per caricare un archivio vuoto; usalo solo lì, perché se un record esiste già la scrittura non va a buon fine.
ObjectList<Classe>ElencoSì per scritture e cancellazioniI record da scrivere o cancellare, nella lista del tipo: ObjectListBrand per BRAND, ObjectListProduct per PRODUCT e così via. La lista di ogni tipo è indicata nella sua pagina e nell'elenco dei tipi di dato. Le altre liste vanno lasciate vuote o omesse.

Le operazioni

ValoreNomeUsaEffetto
0INSERTORMODIFYla lista del tipoPer ogni record: cerca per campi chiave, aggiorna se esiste, crea se non esiste. Dettagli
1DELETEla lista del tipo, con i soli campi chiaveCancella i record con quella chiave.
2TRUNCATETABLEsolo TypeObjectSvuota l'archivio del tipo. Non si annulla.
3QUERYSQLFilter, QueryParameterLegge i record. Dettagli
4DELETEALLIMPORTCORRISPONDENZEGuidPCAzzera tutte le conferme di ricezione della postazione.
5DELETEIMPORTCORRISPONDENZEBYTABLEGuidPC, TypeObjectAzzera le conferme della postazione per quel tipo.

Una richiesta per tipo

Una richiesta lavora su un solo tipo di dato. Per inviare articoli e prezzi fai due chiamate, prima gli articoli e poi i prezzi; per leggere più tipi in una volta c'è ImportMulti. Nelle scritture puoi mettere molti record nella stessa lista: blocchi da qualche centinaio di record sono un buon compromesso tra numero di chiamate e dimensione del corpo (per le immagini, blocchi più piccoli).

L'ordine degli archivi

Il server non rifiuta un articolo che usa un codice di categoria inesistente, ma il dato resta scollegato. Invia quindi prima gli archivi di base e poi quelli che li usano:

  1. tabelle: Codici IVA, Unità di misura, Marchi, Categorie merceologiche, Sottocategorie merceologiche, Reparti, Settori, Listini, Depositi, Varianti, Valori delle varianti, Pagamenti;
  2. anagrafiche: Clienti e fornitori, Destinazioni diverse;
  3. articoli: Articoli;
  4. dati degli articoli: Prezzi degli articoli, Immagini degli articoli, File degli articoli, Giacenze;
  5. documenti: Documenti.

Scrivere i dati

Scrivere i dati: INSERTORMODIFY, DELETE e TRUNCATETABLE

Per scrivere usi INSERTORMODIFY (crea o aggiorna) e DELETE (cancella), con i record nella lista del tipo.

Come viene salvato ogni record

  1. Il server esegue i controlli della classe: se manca un campo obbligatorio il record viene scartato con un messaggio come «Codice non specificato».
  2. Cerca il record con i campi chiave: se lo trova lo aggiorna, altrimenti lo crea. Con AllInsert a true salta la ricerca e crea sempre.
  3. Scrive tutti i campi della classe, e registra la data dell'ultima modifica.
  4. Per immagini e file salva il contenuto nella cartella del sito e registra il percorso.
INSERTORMODIFY riscrive il record intero. Un campo che non invii prende il valore predefinito e cancella quello salvato; un'immagine non inviata viene tolta dal record. Per cambiare solo alcuni campi leggi prima il record con QUERY, modificalo e rinvialo completo.

Errori riga per riga

I record della lista vengono salvati uno dopo l'altro nella stessa transazione. Un record che non supera i controlli non ferma gli altri: finisce in ErrorList con ElementNumber uguale alla sua posizione nella lista (da 0) e SourceError nella forma «Riga n° 3: Codice non specificato» (numerata da 1), e lo Status della risposta diventa ALERT.

Dopo ogni scrittura controlla quindi lo stato: se non è OK rinvia solo i record elencati, dopo averli corretti.

Codici e numerazioni

Il server non assegna codici: ogni record arriva con la sua chiave completa, decisa da chi scrive. Per i documenti questo significa tipo, esercizio, serie, registro, numero e controparte; per i prezzi il progressivo dell'articolo; per le immagini l'indice.

Cancellare

Con DELETE invii nella lista del tipo oggetti con i soli campi chiave valorizzati. Un record che non esiste non genera errore. Per cancellare tutto un archivio c'è TRUNCATETABLE, che non chiede la lista e non si può annullare.

JSON · cancellare una sottocategoria
{
  "DataOperation": 1,
  "TypeObject": 3,
  "GuidPC": "gestionale-01",
  "ObjectListSottoCategoriaMerceologica": [
    { "CodiceCategoria": "ABB", "Codice": "MAGLIE" }
  ]
}

Prima pubblicazione di un archivio grande

Per caricare la prima volta decine di migliaia di record: svuota l'archivio con TRUNCATETABLE, poi invia blocchi con AllInsert a true. Dopo una pubblicazione completa del catalogo chiama la ricostruzione dopo l'esportazione.

Leggere i dati

Leggere i dati: QUERY, filtri SQL, paginazione e conteggio

Con QUERY leggi i record di un tipo. La risposta li restituisce nella lista del tipo, completi di tutti i campi e degli elenchi annidati.

Come il server costruisce la lettura

Per ogni tipo il server parte da una lettura fissa sulla tabella del tipo (indicata nella sua pagina), del tipo select ... from <tabella> WHERE 0 = 0, e aggiunge in ordine:

  1. i filtri del tipo stesso (eventi, deposito, obsoleti, dove previsti);
  2. se IgnoreImportRecord è falso, l'esclusione dei record già confermati da questa postazione (GuidPC);
  3. AND <SQLFilter>, se il filtro non è vuoto;
  4. la paginazione con StartingRecord e LimitRecord.

Il testo della lettura eseguita torna nella risposta in LastSQLExecute: è il primo posto dove guardare quando una lettura non restituisce quello che ti aspetti.

SQLFilter

È una condizione SQL scritta con i nomi della tabella e delle colonne del database, non con i nomi delle proprietà. Le colonne di ogni tipo sono nella colonna «Colonna» della sua pagina; il nome della tabella è nella scheda tecnica.

Esempi di SQLFilter
articoli.codice LIKE 'A%'
CategorieMerceologiche.codice IN ('ABB', 'CAL')
DocumentiTesta.Tipo = 'OC' AND DocumentiTesta.TipoControparte = 'C'
clientifornitori.tipo = 'C' 
Se il filtro contiene un errore la risposta arriva senza record, con Status FAILED e il messaggio del database in ErrorList. Controlla LastSQLExecute e prova il filtro con una lettura di pochi record prima di usarlo in produzione. Gli apici dentro i valori vanno raddoppiati ('D''Angelo').

Per i tipi che partono da un'altra tabella collegata agli articoli (Prezzi degli articoli, Immagini degli articoli, File degli articoli, Giacenze per articolo) il filtro può usare anche le colonne di articoli, per esempio articoli.linea = 'ABB' per leggere solo i prezzi di una categoria.

QueryParameter

CampoTipoPredefinitoA cosa serve
StartingRecordIntero0Primo record da restituire, contando da 1.
LimitRecordIntero0Numero massimo di record da restituire. Con 0 non c'è limite: evitalo sugli archivi grandi.
CountingVero/falsofalseInvece dei record restituisce solo il loro numero, in ObjectListCounting[0].Number. Serve per sapere quante pagine leggere.
IgnoreImportRecordVero/falsofalseCon false (predefinito) la lettura esclude i record che questa postazione ha già confermato: è la sincronizzazione incrementale. Con true legge tutto, conferme comprese.
FiltraPerEventoVero/falsofalsePer Documenti: con evento indicato legge solo i documenti di quell'evento; con EventoAnno a 0 legge tutti quelli collegati a un evento. Per gli articoli e i loro dati filtra quelli dell'evento.
EventoAnnoIntero0Anno dell'evento di merchandising.
EventoNumeroIntero0Numero dell'evento di merchandising.
DepositoTestovuotoPer Documenti: solo i documenti con almeno una riga che movimenta questo deposito, in partenza o in arrivo.
SoloCarichiVero/falsofalsePer Documenti: solo i documenti con causale di magazzino di carico.
LoadObsoletiVero/falsofalsePer Eventi di merchandising: include anche gli eventi obsoleti.

Leggere un archivio intero, a pagine

  1. Chiedi il conteggio: QUERY con Counting: true e IgnoreImportRecord: true.
  2. Leggi a blocchi: StartingRecord = 1, 1001, 2001... con LimitRecord = 1000, sempre con IgnoreImportRecord: true.
  3. Per scaricare solo le novità usa invece la sincronizzazione incrementale, che legge sempre dal primo record.
JSON · quanti articoli iniziano per A
{
  "DataOperation": 3,
  "TypeObject": 19,
  "GuidPC": "gestionale-01",
  "SQLFilter": "articoli.codice LIKE 'A%'",
  "QueryParameter": { "Counting": true, "IgnoreImportRecord": true }
}
Risposta (estratto)
{
  "Status": "OK",
  "RequestDataOperation": 3,
  "TypeObject": 19,
  "ErrorList": [],
  "ObjectListCounting": [ { "Number": 1284 } ]
}

Solo l'elenco dei record

Aggiungendo directshow=true all'indirizzo la risposta contiene solo la lista dei record del tipo richiesto, senza stato ed errori. È comoda per le letture veloci da strumenti esterni, ma in un'integrazione vera conviene la risposta completa.

La risposta e gli errori

La risposta WebServiceResponse: stato, errori e dati

Ogni chiamata restituisce un WebServiceResponse (ImportMulti un WebServiceMultiResponse), anche in caso di errore. Leggi sempre prima lo stato e l'elenco degli errori, poi i dati.

I campi di WebServiceResponse

CampoTipoA cosa serve
StatusTestoEsito della chiamata: vedi la tabella qui sotto.
RequestDataOperationInteroL'operazione richiesta, ripetuta.
RequestSQLFilterTestoIl filtro richiesto, ripetuto.
ResponseGuidPCTestoLa postazione della richiesta, ripetuta.
TypeObjectInteroIl tipo di dato della richiesta.
ResponseStringTestoMessaggio del server; in caso di rifiuto è il motivo.
LastSQLExecuteTestoL'ultima istruzione eseguita sul database: utile per capire filtri e letture.
ErrorListElenco di WebServiceErrorGli errori, uno per record scartato o per motivo di rifiuto.
IsDatabaseReopenVero/falsoSempre vero; mantenuto per compatibilità.
ObjectList<Classe>ElencoPer QUERY i record letti, nella lista del tipo. Dopo la scrittura di Immagini degli articoli e File degli articoli un elemento per ogni record inviato, nello stesso ordine, con l'indirizzo pubblico del file salvato in URLExportFoto (vuoto se il file non è stato salvato).
ObjectListCountingElenco di CountingCon Counting il numero dei record in [0].Number.

I valori di Status

StatusQuandoChe cosa fare
OKTutto eseguito.Prosegui.
ALERTUno o più record scartati in scrittura o cancellazione; in ImportMulti, conferme non registrate.Leggi ErrorList, correggi e rinvia i soli record in errore.
WARNINGImportMulti: almeno una delle letture ha avuto un problema.Controlla lo stato di ogni elemento di Responses.
FAILEDLettura o svuotamento non riusciti, per esempio per un SQLFilter sbagliato; in ImportMulti, richiesta non valida (limiti superati, tipi duplicati, postazione mancante).Leggi il messaggio in ErrorList e correggi la richiesta.
keyinvalidChiave mancante, sbagliata, disattivata o senza permesso.Vedi le risposte di rifiuto.
koRichiesta illeggibile o errore imprevisto.Leggi ErrorList: contiene il messaggio e, se il corpo non è stato capito, il testo ricevuto e la diagnostica della compressione.

Confronta lo stato senza distinguere maiuscole e minuscole: la ricostruzione dopo l'esportazione, per esempio, risponde ok.

Un errore di scrittura

Risposta (estratto)
{
  "Status": "ALERT",
  "RequestDataOperation": 0,
  "TypeObject": 19,
  "ErrorList": [
    { "TypeObject": 19, "ElementNumber": 2, "SourceError": "Riga n° 3: Descrizione non specificato" }
  ]
}

Il terzo articolo della lista (indice 2) non aveva la descrizione: gli altri sono stati salvati.

Errori di trasporto

Se la chiamata non arriva al server (rete, certificato, timeout) non c'è risposta da leggere: ripeti la chiamata dopo una breve attesa. La libreria .NET lo fa da sola, fino a tre volte. Le scritture si possono ripetere senza danni, perché INSERTORMODIFY aggiorna i record già presenti invece di duplicarli (purché AllInsert sia falso).

Sincronizzazione incrementale

Sincronizzazione incrementale: conferme di ricezione e cancellazioni

La sincronizzazione incrementale serve a scaricare solo i record nuovi o modificati dall'ultima volta, senza tenere traccia di date o numeri dal tuo lato. Si basa su tre elementi: l'identificativo della postazione, le conferme di ricezione e la chiave dei record.

Come funziona

  1. Scegli un GuidPC stabile per il tuo programma e usalo in tutte le chiamate.
  2. Leggi con QUERY lasciando IgnoreImportRecord a false: il server esclude i record che questa postazione ha già confermato.
  3. Salva i record nel tuo sistema.
  4. Per ogni record salvato invia una conferma: INSERTORMODIFY del tipo RECEVEIDCLASS con Type (il tipo letto), Guid (il tuo GuidPC) e Key (la chiave del record).
  5. Ripeti la lettura, sempre dal primo record: quelli confermati non tornano più, quindi ogni giro restituisce i successivi. Ti fermi quando la lettura torna vuota.

Quando un record viene modificato sul sito la sua conferma non vale più e il record torna nella lettura successiva.

La chiave da confermare

La Key della conferma è formata dai valori dei campi chiave del record, separati dal carattere |, nell'ordine indicato per ogni tipo nella sua pagina, alla voce «Chiave per le conferme di ricezione». Attenzione: per alcuni tipi l'ordine non è quello dei campi nella classe. Esempi:

TipoChiave
MarchiCodice
Sottocategorie merceologicheCodiceCategoria|Codice
Prezzi degli articoliArticolo|Progressivo
Immagini degli articoliArticolo|StringaVariante|Indice
GiacenzeArticolo|StringaVarianti|Deposito
Clienti e fornitoriTipo|Codice
DocumentiTipo|Esercizio|Registro|Serie|Numero|TipoControparte|Controparte
Eventi di merchandisingAnno|Numero

Per un documento la chiave è quindi OC|2026|01|A|125|C|000123 (tipo, esercizio, registro, serie, numero, tipo controparte, controparte); i numeri si scrivono senza decimali e senza zeri aggiunti.

JSON · conferme di ricezione
{
  "DataOperation": 0,
  "TypeObject": 42,
  "GuidPC": "gestionale-01",
  "ObjectListReceveidClass": [
    { "Type": 19, "Guid": "gestionale-01", "Key": "A0001" },
    { "Type": 19, "Guid": "gestionale-01", "Key": "A0002" },
    { "Type": 20, "Guid": "gestionale-01", "Key": "A0001|1" }
  ]
}

Le conferme sono idempotenti: inviare due volte la stessa non crea doppioni. Puoi confermare record di tipi diversi nella stessa lista. Con ImportMulti le conferme viaggiano insieme alla lettura successiva, in una sola chiamata.

Ricominciare da capo

Per riscaricare tutto (un nuovo database, un errore da recuperare) azzera le conferme della tua postazione: DataOperation 4 le cancella tutte, 5 solo quelle del tipo indicato in TypeObject. Le conferme delle altre postazioni non vengono toccate.

JSON · riscaricare tutti i documenti
{ "DataOperation": 5, "TypeObject": 23, "GuidPC": "gestionale-01" }

Le cancellazioni

Un record cancellato sul sito non può tornare in una lettura. Per questo c'è il tipo DELETINGCLASS:

  • dal sito al tuo programma: QUERY di DELETINGCLASS restituisce le cancellazioni con Type e Key; tu cancelli i record corrispondenti e confermi ogni cancellazione con una conferma di tipo DELETINGCLASS e chiave Type|Guid|Key (il tipo come numero);
  • dal tuo programma al sito: INSERTORMODIFY di DELETINGCLASS con Type e Key cancella sul sito il record con quella chiave. Qui la chiave segue l'ordine dei campi chiave nella classe, indicato in ogni pagina alla voce «Chiave per cancellare con DeletingClass».

Ricostruzione dopo l'esportazione

Dopo una pubblicazione completa del catalogo chiama l'indirizzo del web service con operationbie=recreateafterexport (la chiave è sempre necessaria, il corpo non serve). Il server ricostruisce i dati che dipendono dall'insieme del catalogo: la tabella delle varianti, gli avvisi di sottoscorta e i progressivi delle causali. La risposta è un WebServiceResponse con Status ok e il riepilogo in ResponseString.

Indirizzo
POST https://<tuo-dominio>/webservice.aspx?Key=<chiave>&serialize=json&operationbie=recreateafterexport

Conferme di ricezione

ReceveidClass: le conferme che un record è stato ricevuto e salvato

Conferme di ricezione: le conferme che un record è stato ricevuto e salvato. Nel web service è il tipo RECEVEIDCLASS (valore 42 di DataType); gli oggetti sono della classe ReceveidClass e viaggiano nella lista ObjectListReceveidClass della richiesta e della risposta.

È il mattone della sincronizzazione incrementale. Ogni conferma dice al server: «il record di questo tipo, con questa chiave, è arrivato alla postazione Guid». Da quel momento le QUERY della stessa postazione non lo restituiscono più, finché non viene modificato. Si inviano con INSERTORMODIFY e tipo RECEVEIDCLASS; DataImport lo imposta il server.

Scheda tecnica

VoceValore
Tipo di datoRECEVEIDCLASS = 42
ClasseReceveidClass
Lista nella richiesta e nella rispostaObjectListReceveidClass
Tabella letta da QUERYImportRecord — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Chiave per le conferme di ricezioneType|Key|Guid — come si usa

I campi di ReceveidClass

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
TypeDataType—BRAND—Tipo del record confermato (DataType).
GuidTesto—vuotoguidpostazioneIdentificativo della postazione (lo stesso GuidPC della richiesta).
KeyTesto—vuotokeyChiave del record, con i valori separati dal carattere |.
DataImportData e ora—nessuna datadataimportData e ora della conferma, impostate dal server.

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": 42,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListReceveidClass": [
    {
      "Guid": "gestionale-01",
      "Key": "COD001",
      "DataImport": "2026-03-15T00:00:00"
    }
  ]
}

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

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

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

Cancellazioni da sincronizzare

DeletingClass: i record cancellati da riportare dall'altra parte

Cancellazioni da sincronizzare: i record cancellati da riportare dall'altra parte. Nel web service è il tipo DELETINGCLASS (valore 41 di DataType); gli oggetti sono della classe DeletingClass e viaggiano nella lista ObjectListDeletingClass della richiesta e della risposta.

Serve a riportare le cancellazioni. In lettura restituisce i record cancellati sul sito che la postazione deve cancellare a sua volta: Type è il tipo, Key la chiave del record. In scrittura fa l'opposto: ogni oggetto inviato cancella sul sito il record di tipo Type con chiave Key, scomposta sui campi chiave nell'ordine in cui sono dichiarati nella classe.

Scheda tecnica

VoceValore
Tipo di datoDELETINGCLASS = 41
ClasseDeletingClass
Lista nella richiesta e nella rispostaObjectListDeletingClass
Tabella letta da QUERYSofheWProtocolCancellazione — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Chiave per le conferme di ricezioneType|Guid|Key — come si usa

I campi di DeletingClass

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
TypeDataType—BRANDtypeTipo del record cancellato (DataType).
GuidTesto—vuotoguidIdentificativo della postazione (lo stesso GuidPC della richiesta).
KeyTesto—vuotokeyChiave del record, con i valori separati dal carattere |.

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": 41,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDeletingClass": [
    {
      "Guid": "gestionale-01",
      "Key": "COD001"
    }
  ]
}

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

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

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

ImportMulti

ImportMulti: più tipi di dato in una chiamata, con le conferme

ImportMulti è il protocollo per leggere più tipi di dato in una sola chiamata e, nella stessa chiamata, confermare i record ricevuti al giro precedente. Riduce di molto il numero di chiamate di una sincronizzazione completa. È di sola lettura: per scrivere si usa il protocollo normale.

Indirizzo
POST https://<tuo-dominio>/webservice.aspx?Key=<chiave>&serialize=json&operationmulti=importmulti

Trasporto, compressione e formato sono gli stessi del protocollo normale; cambia l'oggetto inviato.

WebServiceMultiRequest

CampoTipoObbligatorioA cosa serve
ProtocolVersionInteroSìVersione del protocollo: deve essere 1.
GuidPCTestoSìIdentificativo della postazione, da 1 a 256 caratteri. Vale per tutte le letture e tutte le conferme.
RequestsElenco di WebServiceMultiItemRequestSìLe letture: una per tipo di dato.
ReceivedRecordsElenco di WebServiceMultiReceiptNoLe conferme dei record ricevuti al giro precedente.

WebServiceMultiItemRequest

CampoTipoA cosa serve
TypeObjectDataTypeIl tipo da leggere.
QueryParameterQueryParameterParametri della lettura. Counting viene ignorato; LimitRecord a 0 diventa 1000 (20 per immagini e file); senza IgnoreImportRecord la lettura parte sempre dal primo record. SQLFilter qui non è disponibile.

WebServiceMultiReceipt

CampoTipoA cosa serve
TypeObjectDataTypeIl tipo del record confermato.
KeyTestoLa chiave del record, al massimo 4096 caratteri, composta come per le conferme.

I limiti

LimiteValore
Tipi per richiestaal massimo 64, senza ripetizioni
Record per tipoal massimo 1000
Record per tipo con fileal massimo 20 per PRODUCTIMAGE, PRODUCTFILE, DHMANIMALIIMAGE, DHMANIMALIFILE, DHMUSERFILEALLEGATI
Record richiesti in totaleal massimo 10.000 (somma dei LimitRecord)
Conferme per richiestaal massimo 10.000

Permessi e ordine di esecuzione

  1. Il server controlla l'intera richiesta prima di fare qualsiasi cosa: limiti, permesso di lettura su ogni tipo, permesso di scrittura su RECEVEIDCLASS e di lettura sul tipo di ogni conferma.
  2. Registra tutte le conferme in una sola transazione. Se anche una sola non riesce, non esegue nessuna lettura e risponde ALERT: così non perdi record.
  3. Esegue le letture nell'ordine richiesto e mette ogni risposta in Responses.

WebServiceMultiResponse

CampoTipoA cosa serve
ProtocolVersionInteroVersione del protocollo.
StatusTestoOK; WARNING se una lettura ha avuto problemi; ALERT se le conferme non sono state registrate; FAILED se la richiesta non è valida; keyinvalid o ko per chiave e errori generali.
ResponseStringTestoMessaggio del server.
LastSQLExecuteTestoUltima istruzione eseguita.
ErrorListElenco di WebServiceErrorErrori della richiesta nel suo insieme.
ResponsesElenco di WebServiceResponseUna risposta per ogni lettura, nello stesso ordine, con i record nella lista del tipo.
ReceiptResponseWebServiceResponseEsito della registrazione delle conferme.

Il ciclo completo

JSON · articoli, prezzi, giacenze e immagini con le conferme del giro prima
{
  "ProtocolVersion": 1,
  "GuidPC": "app-magazzino-01",
  "Requests": [
    { "TypeObject": 19, "QueryParameter": { "LimitRecord": 500 } },
    { "TypeObject": 20, "QueryParameter": { "LimitRecord": 1000 } },
    { "TypeObject": 32, "QueryParameter": { "LimitRecord": 1000 } },
    { "TypeObject": 21, "QueryParameter": { "LimitRecord": 20 } }
  ],
  "ReceivedRecords": [
    { "TypeObject": 19, "Key": "A0001" },
    { "TypeObject": 20, "Key": "A0001|1" }
  ]
}
  1. Primo giro: ReceivedRecords vuoto.
  2. Salvi i record ricevuti e prepari le loro chiavi.
  3. Giro successivo: le stesse Requests con le conferme in ReceivedRecords.
  4. Ti fermi quando tutte le Responses tornano vuote, e mandi un'ultima chiamata con le sole conferme rimaste e Requests vuoto.

Immagini, file e allegati

Immagini, file e allegati: come si trasmettono i file

Immagini, documenti e allegati viaggiano dentro la richiesta, codificati in Base64, con la classe ImageTrasmission. Il server li salva nella cartella giusta del sito e registra il percorso nel record.

ImageTrasmission

CampoTipoA cosa serve
FileNameTestoNome del file con estensione, per esempio scarpa-rossa.jpg. Viene normalizzato; il server può scriverlo in minuscolo per i siti su Linux.
EncryptedFileTestoIl contenuto del file in Base64. Nonostante il nome non è cifrato: è la semplice codifica Base64 dei byte.
Un ImageTrasmission con EncryptedFile vuoto toglie il file dal record. Se aggiorni un record senza voler cambiare l'immagine devi rinviarla.

Immagini e file degli articoli

Per gli articoli immagini e file hanno i loro tipi: Immagini degli articoli e File degli articoli. Ogni record è identificato da articolo, variante e indice; con FotoDefault scegli la foto principale. Nella risposta alla scrittura trovi, per ogni record e nello stesso ordine, URLExportFoto con l'indirizzo pubblico del file salvato.

JSON · foto principale di un articolo
{
  "DataOperation": 0,
  "TypeObject": 21,
  "GuidPC": "gestionale-01",
  "ObjectListProductImage": [
    {
      "Articolo": "A0001",
      "StringaVariante": "",
      "Indice": 1,
      "FotoDefault": true,
      "Nome": "Vista frontale",
      "Image": { "FileName": "a0001-fronte.jpg", "EncryptedFile": "/9j/4AAQSkZJRgABAQ..." }
    }
  ]
}

Le immagini pesano: inviale a blocchi piccoli (da 10 a 20 per chiamata) e ridimensionale prima, alla misura che serve al sito.

MediaEntry e AttachedFile

I contenuti del sito (news, blog, eventi, servizi...) hanno elenchi di immagini e video (MediaEntry) e di allegati (AttachedFile), descritti nei tipi di supporto. Un MediaEntry è un'immagine oppure un video di YouTube, indicato solo dal codice del video.

Esempi di codice

Esempi di codice: Python, C#, VB.NET e curl

Esempi completi e funzionanti della stessa chiamata in più linguaggi. Sostituisci dominio, chiave e postazione con i tuoi.

Python

Python 3, solo libreria standard
import gzip, json, urllib.request

URL = "https://www.tuosito.it/webservice.aspx?Key=LA-TUA-CHIAVE&serialize=json"

def chiama(richiesta):
    corpo = gzip.compress(json.dumps(richiesta, ensure_ascii=False).encode("utf-8"))
    req = urllib.request.Request(URL, data=corpo, method="POST", headers={
        "Content-Type": "application/octet-stream",
        "Content-Encoding": "gzip",
        "Accept-Encoding": "gzip"})
    with urllib.request.urlopen(req, timeout=600) as r:
        dati = r.read()
    if dati[:2] == b"\x1f\x8b":          # risposta compressa
        dati = gzip.decompress(dati)
    risposta = json.loads(dati.decode("utf-8"))
    if str(risposta.get("Status", "")).upper() != "OK":
        raise RuntimeError(risposta.get("ResponseString") or risposta.get("ErrorList"))
    return risposta

# scrivere un marchio
chiama({"DataOperation": 0, "TypeObject": 0, "GuidPC": "gestionale-01",
        "ObjectListBrand": [{"Codice": "ACME", "Descrizione": "Acme"}]})

# leggere i nuovi ordini e confermarli
r = chiama({"DataOperation": 3, "TypeObject": 23, "GuidPC": "gestionale-01",
            "QueryParameter": {"StartingRecord": 1, "LimitRecord": 100}})
conferme = []
for d in r["ObjectListDocument"]:
    # ... salva il documento nel tuo sistema ...
    chiave = "|".join([d["Tipo"], d["Esercizio"], d["Registro"], d["Serie"],
                       str(int(d["Numero"])), d["TipoControparte"], d["Controparte"]])
    conferme.append({"Type": 23, "Guid": "gestionale-01", "Key": chiave})
if conferme:
    chiama({"DataOperation": 0, "TypeObject": 42, "GuidPC": "gestionale-01",
            "ObjectListReceveidClass": conferme})

C#

C# (.NET 6 o successivo)
using System.IO.Compression;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;

var http = new HttpClient(new HttpClientHandler {
    AutomaticDecompression = System.Net.DecompressionMethods.GZip }) { Timeout = TimeSpan.FromMinutes(10) };
var url = "https://www.tuosito.it/webservice.aspx?Key=LA-TUA-CHIAVE&serialize=json";

var richiesta = new {
    DataOperation = 3, TypeObject = 19, GuidPC = "gestionale-01",
    SQLFilter = "articoli.codice LIKE 'A%'",
    QueryParameter = new { IgnoreImportRecord = true, StartingRecord = 1, LimitRecord = 200 }
};
byte[] testo = Encoding.UTF8.GetBytes(JsonSerializer.Serialize(richiesta));
using var compresso = new MemoryStream();
using (var gz = new GZipStream(compresso, CompressionLevel.Optimal, leaveOpen: true))
    gz.Write(testo, 0, testo.Length);

var contenuto = new ByteArrayContent(compresso.ToArray());
contenuto.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
contenuto.Headers.ContentEncoding.Add("gzip");

var risposta = await http.PostAsync(url, contenuto);
using var json = JsonDocument.Parse(await risposta.Content.ReadAsStringAsync());
var stato = json.RootElement.GetProperty("Status").GetString();
foreach (var articolo in json.RootElement.GetProperty("ObjectListProduct").EnumerateArray())
    Console.WriteLine($"{articolo.GetProperty("Codice")} {articolo.GetProperty("Descrizione")}");

VB.NET con la libreria SFHIEDataDefinition

VB.NET
Imports SFHIEDataDefinition

Dim export As New Export With {.ForceAttend = False}
export.EndPoint.URL = "https://www.tuosito.it/webservice.aspx"
export.EndPoint.Key = "LA-TUA-CHIAVE"          ' Key e serialize vengono aggiunti dalla libreria
Dim cookie As New Net.CookieContainer

Dim marchi As New List(Of Definition.Brand) From {
   New Definition.Brand With {.Codice = "ACME", .Descrizione = "Acme"}}

Dim risposta As Definition.WebServiceResponse = export.ExecuteCommand(
   marchi, Definition.DataType.BRAND, Definition.DataOperation.INSERTORMODIFY,
   "", True, cookie, SFHCommon.Serialization.TypeSerialize.JSON,
   False, "gestionale-01", New Definition.QueryParameter)

If risposta.ErrorList.Count > 0 Then
   For Each e In risposta.ErrorList
      Console.WriteLine(e.SourceError)
   Next
End If

La libreria compone l'indirizzo con Key e serialize, comprime il corpo, ripete fino a tre volte le chiamate non riuscite e restituisce la risposta già deserializzata. Per ImportMulti usa Export.ExecuteMultiCommand.

curl

Terminale: i primi dieci marchi
echo '{"DataOperation":3,"TypeObject":0,"GuidPC":"prova","QueryParameter":{"IgnoreImportRecord":true,"LimitRecord":10}}' \
  | gzip -c \
  | curl -s --compressed -X POST --data-binary @- \
      -H "Content-Type: application/octet-stream" -H "Content-Encoding: gzip" \
      "https://www.tuosito.it/webservice.aspx?Key=LA-TUA-CHIAVE&serialize=json"

Un documento completo

JSON · un ordine con una riga (codici di esempio)
{
  "DataOperation": 0,
  "TypeObject": 23,
  "GuidPC": "gestionale-01",
  "ObjectListDocument": [
    {
      "Tipo": "OC", "Esercizio": "2026", "Serie": "A", "Registro": "01", "Numero": 125,
      "Controparte": "000123", "TipoControparte": "C",
      "Data": "2026-03-15T00:00:00",
      "Pagamento": "BB30", "Deposito": "SEDE", "Note": "Consegna al mattino",
      "SpeseTrasporto": 8.5, "CodiceIVASpeseTrasporto": "22",
      "TotaleImponibile": 108.5, "TotaleIVA": 23.87, "TotaleDocumento": 132.37,
      "ListaCorpo": [
        { "TipoRiga": "", "CodiceArticolo": "A0001", "StringaVarianti": "", "DescrizioneArticolo": "Maglia cotone blu",
          "Quantita": 2, "ImponibileUnitario": 50, "Sconti": "", "CodiceIVA": "22", "Deposito": "SEDE", "UnitaDiMisura": "PZ" }
      ]
    }
  ]
}

I codici (tipo documento, pagamento, deposito, IVA, unità di misura) devono essere quelli configurati sul sito: leggili prima con QUERY dai rispettivi tipi.

Tipi di dato

Tipi di dato: tutti i valori di DataType con la loro classe

Questi sono tutti i tipi di dato del web service. Il valore è quello da mettere in TypeObject in JSON; in XML si usa il nome. La lista è la proprietà della richiesta e della risposta che contiene i record. Clicca il nome per la pagina con tutti i campi.

Articoli e magazzino

ValoreDataTypePaginaListaOperazioni
0BRANDMarchiObjectListBrandL S C T
1LISTINIListiniObjectListListinoL S C T
2CATEGORIEMERCEOLOGICHECategorie merceologicheObjectListCategoriaMerceologicaL S C T
3SOTTOCATEGORIEMERCEOLOGICHESottocategorie merceologicheObjectListSottoCategoriaMerceologicaL S C T
5REPARTIRepartiObjectListRepartiL S C T
6SETTORISettoriObjectListSettoriL S C T
7TESTAVARIANTEVariantiObjectListTestaVarianteL S C T
8CORPOVARIANTEValori delle variantiObjectListCorpoVarianteL S C T
9DEPOSITIDepositiObjectListDepositoL S C T
10CAUSALIMAGAZZINOCausali di magazzinoObjectListCausaleMagazzinoL S C T
12MERCHANDISINGEVENTOEventi di merchandisingObjectListMerchandisingEventoL S C T
13MERCHANDISINGARTISTIArtisti degli eventiObjectListMerchandisingArtistiL S C T
14SCALAVALORIScale di valoriObjectListScalaValoriL S C T
15CAMPIVARIABILI1Campi variabili tabellari 1ObjectListCampiVariabiliArticoli1L S C T
16CAMPIVARIABILI2Campi variabili tabellari 2ObjectListCampiVariabiliArticoli2L S C T
17CAMPIVARIABILI3Campi variabili tabellari 3ObjectListCampiVariabiliArticoli3L S C T
18CAMPIVARIABILI4Campi variabili tabellari 4ObjectListCampiVariabiliArticoli4L S C T
19PRODUCTArticoliObjectListProductL S C T
20PRODUCTPRICEPrezzi degli articoliObjectListProductPriceL S C T
21PRODUCTIMAGEImmagini degli articoliObjectListProductImageL S C T
22PRODUCTFILEFile degli articoliObjectListProductFileL S C T
25PRODUCTSTOCKGiacenze per articoloObjectListGiacenzeArticoliL
32GIACENZEARTICOLIGiacenzeObjectListGiacenzeArticoliL S C T
49ARTICOLISTATSStatistiche degli articoliObjectListArticoliStatsS C T
95RAGGRUPPAMENTOFILERaggruppamenti dei fileObjectListRaggruppamentoFileL S C T
117PROMOZIONIPromozioniObjectListPromozioniL S C T
123UNITAMISURAUnità di misuraObjectListUnitaMisuraL S C T
125CATEGORIAPROVVIGIONALECategorie provvigionaliObjectListCategoriaProvvigionaleL S C T

Documenti e spedizioni

ValoreDataTypePaginaListaOperazioni
23DOCUMENTDocumentiObjectListDocumentL S C T
24DOCUMENTTYPETipi di documentoObjectListDocumentTypeL S C T
26STATODOCUMENTOStati del documentoObjectListStatoDocumentoL S C T
28RAGGRUPPAMENTOSTATISTICORaggruppamenti statisticiObjectListRaggruppamentoStatisticoL S C T
29CANALERICEVIMENTODOCUMENTOCanali di ricevimentoObjectListCanaleRicevimentoDocumentoL S C T
45RIGHEPREDEFINITEPERDOCRighe predefiniteObjectListRighePredefiniteDocL S C T
50METODOSPEDIZIONEZONEZone di spedizioneObjectListMetodoSpedizioneZoneL S C T
51METODOSPEDIZIONEMetodi di spedizioneObjectListMetodoSpedizioneL S C T
52BUONISCONTIBuoni scontoObjectListBuoniScontiL S C T
114BOZZADOCUMENTOBozze dei documentiObjectListBozzaDocumentoL S C T
118TRASPORTOCAUSALECausali di trasportoObjectListTrasportoCausaleL S C T
119TRASPORTOMEZZOMezzi di trasportoObjectListTrasportoMezzoL S C T
120TRASPORTOPORTOPortiObjectListTrasportoPortoL S C T
124SPEDIZIONIERESpedizionieriObjectListSpedizioniereL S C T

Clienti e anagrafiche

ValoreDataTypePaginaListaOperazioni
30DIPENDENTIDipendentiObjectListDipendentiL S C T
34CLIENTIFORNITORIClienti e fornitoriObjectListClientiFornitoriL S C T
35CATEGORIECLIENTEFORNITORECategorie anagraficheObjectListCategorieClienteFornitoreL S C T
36TIPOLOGIECLIENTEFORNITORETipologie anagraficheObjectListTipoClienteFornitoreL S C T
37COMUNIComuniObjectListComuniL S C T
38COMUNIZONEZone dei comuniObjectListComuniZoneL S C T
39REGIONIRegioniObjectListRegioniL S C T
40GRUPPICLIENTEFORNITOREGruppi aziendaliObjectListGruppiClienteFornitoreL S C T
44DESTINAZIONIDIVERSEDestinazioni diverseObjectListDestinazioniDiverseL S C T
47NAZIONINazioniObjectListNazioniL S C T
48PROVINCEProvinceObjectListProvinceL S C T
63TIPODOCUMENTORICONOSCIMENTOTipi di documento di riconoscimentoObjectListTipoDocumentoRiconoscimentoL S C T
121ZONACLIENTEFORNITOREZoneObjectListZonaClienteFornitoreL S C T
122ORIGINEIMPORTAZIONECLIENTEFORNITOREOrigini dei contattiObjectListOrigineImportazioneClienteFornitoreL S C T
126AFFIDABILITACLIENTEFORNITOREAffidabilitàObjectListAffidabilitaClienteFornitoreL S C T
127SOTTOZONACLIENTEFORNITORESottozoneObjectListSottoZonaClienteFornitoreL S C T

Contabilità e scadenze

ValoreDataTypePaginaListaOperazioni
4IVACodici IVAObjectListIVAL S C T
11CAUSALICONTABILICausali contabiliObjectListCausaleContabileL S C T
27SEZIONECONTABILESezioni contabiliObjectListSezioneContabileL S C T
31PAGAMENTIPagamentiObjectListPagamentiL S C T
33ESERCIZIEserciziObjectListEserciziL S C T
43TIPOLOGIACOSTORICAVOTipologie di costo e ricavoObjectListTipologiaCostoRicavoL S C T
46PIANODEICONTIPiano dei contiObjectListPianoDeiContiL S C T
53DOCUMENTISCADENZEScadenze dei documentiObjectListDocumentScadenzeL S C T
54DOCUMENTIRIMESSASUSCADENZERimesse sulle scadenzeObjectListDocumentiRimessaSuScadenzaL S C T
55EFFETTIINCASSOPAGAMENTOEffettiObjectListEffettiIncassoPagamentoL S C T
56CLASSIFICAZIONESCADENZEClassificazione delle scadenzeObjectListClassificazioneScadenzeL S C T
57TIPORIMESSATipi di rimessaObjectListTipoRimessaL S C T

Dog House Management

ValoreDataTypePaginaListaOperazioni
58DHMTARIFFAZIONESPECIALETariffazioni specialiObjectListDHMTariffazioneSpecialeL S C T
59DHMTIPICERTIFICATISMALTIMENTOTipi di certificato di smaltimentoObjectListDHMTipiCertificatiSmaltimentoL S C T
60DHMTIPIINTERVENTITipi di interventoObjectListDHMTipiInterventiL S C T
61DHMTIPOLOGIAFATTURAZIONEANIMALITipologie di fatturazioneObjectListDHMTipologiaFatturazioneAnimaliL S C T
62DHMSPECIEANIMALISpecie animaliObjectListDHMSpecieAnimaliL S C T
64DHMTAGLIETaglieObjectListDHMTaglieL S C T
65DHMRAZZERazzeObjectListDHMRazzeL S C T
66DHMTIPOPRELIEVITipi di prelievoObjectListDHMTipoPrelieviL S C T
67DHMEVENTIEventi degli animaliObjectListDHMEventiAssociatiAnimaliL S C T
68DHMENTISTERILIZZATORIEnti sterilizzatoriObjectListDHMEntiSterilizzatoriL S C T
69DHMSTRUTTUREOSPITANTIStrutture ospitantiObjectListDHMStruttureOspitantiL S C T
70DHMEDUCATORICINOFILIEducatori cinofiliObjectListDHMEducatoriCinofiliL S C T
71DHMSTATOANIMALIStati degli animaliObjectListDHMStatoAnimaliL S C T
72DHMTIPOADOTTABILETipi di adottabilitàObjectListDHMTipoAdottabileL S C T
73DHMAFFIDATARIAffidatariObjectListDHMAffidatariL S C T
74DHMANIMALIAnimaliObjectListDHMAnimaliL S C T
75DHMMETODOINGRESSOMetodi di ingressoObjectListDHMMetodoIngressoL S C T
76DHMASLASLObjectListDHMASLL S C T
77DHMCAUSEDECESSOCause di decessoObjectListDHMCauseDecessoL S C T
78DHMCATEGORIAANIMALICategorie di animaliObjectListDHMCategoriaAnimaliL S C T
79DHMANAGRAFICASCHIERESchiereObjectListDHMAnagraficaSchiereL S C T
80DHMVETERINARISTRUTTURAVeterinari della strutturaObjectListDHMVeterinariStrutturaL S C T
81DHMMALATTIAMalattieObjectListDHMMalattiaL S C T
82DHMDESTINAZIONISTORICOSPOSTAMENTIDestinazioni degli spostamentiObjectListDHMDestinazioniStoricoSpostamentiL S C T
83DHMESAMETipi di esameObjectListDHMEsameL S C T
84DHMSCHEDACOMPORTAMENTALESchede comportamentaliObjectListDHMSchedaComportamentaleL S C T
85DHMVACCINIVacciniObjectListDHMVacciniL S C T
86DHMCORSICorsiObjectListDHMCorsiL S C T
87DHMTRATTAMENTITrattamentiObjectListDHMTrattamentiL S C T
88DHMCORSITIPOLOGIETipologie di corsoObjectListDHMCorsiTipologieL S C T
89DHMPATOLOGIEPatologieObjectListDHMPatologieL S C T
90DHMCORSIDOCENTIDocenti dei corsiObjectListDHMCorsiDocentiL S C T
91DHMANIMALIIMAGEFoto degli animaliObjectListDHMAnimaliImageL S C T
92DHMANIMALIFILEFile degli animaliObjectListDHMAnimaliFileL S C T
93DHMUSERUtenti dell'area riservataObjectListDHMUserL S C T
94DHMUSERFILEALLEGATIFile degli utentiObjectListDHMUserFileAllegatiL S C T
115DHMTIPOVACCINOTipi di vaccinoObjectListDHMTipoVaccinoL S C T
116DHMTIPOTRATTAMENTOTipi di trattamentoObjectListDHMTipoTrattamentoL S C T

Contenuti del sito

ValoreDataTypePaginaListaOperazioni
96UWPCATEGORIABLOGCategorie del blogObjectListUWPCategoriaBlogL S C T
97UWPCATEGORIACONTENUTOCategorie dei contenutiObjectListUWPCategoriaContenutoL S C T
98UWPCATEGORIADOWNLOADCategorie dei downloadObjectListUWPCategoriaDownloadL S C T
99UWPCATEGORIAEVENTICategorie degli eventiObjectListUWPCategoriaEventiL S C T
100UWPCATEGORIAMEDIACONTENTCategorie dei contenuti multimedialiObjectListUWPCategoriaMediaContentL S C T
101UWPCATEGORIANEWSCategorie delle newsObjectListUWPCategoriaNewsL S C T
102UWPCATEGORIAPREMICategorie dei premiObjectListUWPCategoriaPremiL S C T
103UWPCATEGORIAPRESSCategorie della rassegna stampaObjectListUWPCategoriaPressL S C T
104UWPCATEGORIASERVIZICategorie dei serviziObjectListUWPCategoriaServiziL S C T
105UWPBLOGArticoli del blogObjectListUWPBlogL S C T
106UWPCONTENUTOContenutiObjectListUWPContenutoL S C T
107UWPDOWNLOADDownloadObjectListUWPDownloadL S C T
108UWPEVENTIEventiObjectListUWPEventiL S C T
109UWPMEDIACONTENTContenuti multimedialiObjectListUWPMediaContentL S C T
110UWPNEWSNewsObjectListUWPNewsL S C T
111UWPPREMIPremi e riconoscimentiObjectListUWPPremiL S C T
112UWPPRESSRassegna stampaObjectListUWPPressL S C T
113UWPSERVIZIServizi offertiObjectListUWPServiziL S C T

Il protocollo

ValoreDataTypePaginaListaOperazioni
41DELETINGCLASSCancellazioni da sincronizzareObjectListDeletingClassL S C T
42RECEVEIDCLASSConferme di ricezioneObjectListReceveidClassL S C T

Operazioni: L lettura (QUERY), S scrittura (INSERTORMODIFY), C cancellazione (DELETE), T svuotamento (TRUNCATETABLE). I valori da 128 a 131 sono riservati al funzionamento interno della piattaforma e non sono disponibili alle integrazioni.

Tipi di supporto

Tipi di supporto: file, contenuti multimediali, errori ed enumerazioni

Classi ed enumerazioni usate dentro gli altri tipi.

ImageTrasmission

CampoTipoObbligatorioPredefinitoA cosa serve
FileNameTesto—vuotoFile nome.
EncryptedFileTesto—vuotoEncrypted file.

MediaEntry

CampoTipoObbligatorioPredefinitoA cosa serve
TypeMediaEntryType—ImageTipo di dato a cui si riferisce il record, come valore numerico di DataType.
ImageImageTrasmission—nullImmagine, come file in Base64.
YouTubeCodeTesto—vuotoYou tube code.
TitoloTesto—vuotoTitolo.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
DefaultValueVero/falso—falseVero se è il valore proposto per primo.

AttachedFile

CampoTipoObbligatorioPredefinitoA cosa serve
FileImageTrasmission—nullFile, trasmesso in Base64.
TitoloTesto—vuotoTitolo.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.

WebServiceError

CampoTipoObbligatorioPredefinitoA cosa serve
TypeObjectDataType—BRANDTipo object.
ElementNumberIntero—0Element numero.
SourceErrorTesto—vuotoSource error.

Counting

CampoTipoObbligatorioPredefinitoA cosa serve
NumberIntero lungo—0Numero.

In WebServiceError il campo ElementNumber è la posizione del record nella lista inviata, da 0; SourceError il messaggio.

MediaEntryType

ValoreNome
0Image
1Video

SFHTypeBarcode

ValoreNome
0Code11
1Code128
2Code25
3Code39
4Code93
5Ean13
6Ean8
7PDF417
8QRCode

MediaEntryType dice se un elemento multimediale è un'immagine (0) o un video di YouTube (1). SFHTypeBarcode è il tipo di codice a barre degli articoli.

Marchi

Brand: i marchi degli articoli, con logo, sito e ordinamento

Marchi: i marchi degli articoli, con logo, sito e ordinamento. Nel web service è il tipo BRAND (valore 0 di DataType); gli oggetti sono della classe Brand e viaggiano nella lista ObjectListBrand della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoBRAND = 0
ClasseBrand
Lista nella richiesta e nella rispostaObjectListBrand
Tabella letta da QUERYbrand — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Brand

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
LogoImageTrasmission—oggetto vuoto—Logo, come file in Base64.
DescrizioneDettagliataTesto—vuotodescrizionedettDescrizione estesa, anche in HTML.
SitoWEBTesto—vuotositowebIndirizzo del sito web.
ObsoletoVero/falso—falseobsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.

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": 0,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListBrand": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "DescrizioneDettagliata": "Descrizione di esempio",
      "SitoWEB": "ESEMPIO",
      "Obsoleto": false,
      "Ordinamento": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 0,
  "GuidPC": "gestionale-01",
  "ObjectListBrand": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Listini

Listino: i listini di vendita, con validità, IVA inclusa o esclusa e agente collegato

Listini: i listini di vendita, con validità, IVA inclusa o esclusa e agente collegato. Nel web service è il tipo LISTINI (valore 1 di DataType); gli oggetti sono della classe Listino e viaggiano nella lista ObjectListListino della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoLISTINI = 1
ClasseListino
Lista nella richiesta e nella rispostaObjectListListino
Tabella letta da QUERYListini — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Listino

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ValidoDalData e ora—nessuna datadadataInizio del periodo di validità.
ValidoAlData e ora—nessuna dataadataFine del periodo di validità.
IVAInclusaVero/falso—falseivainclusaVero se gli importi comprendono l'IVA.
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.
ModificaAgenteQuandoUsiQuestoListinoVero/falso—falsespostaagenteVero se usando questo listino il documento passa all'agente indicato.
ModificaAgenteQuandoUsiQuestoListinoCodiceAgenteTesto—vuotospostaagentecodiceCodice dell'agente da usare con questo listino.

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": 1,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListListino": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ValidoDal": "2026-03-15T00:00:00",
      "ValidoAl": "2026-03-15T00:00:00",
      "IVAInclusa": false,
      "Ordinamento": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 1,
  "GuidPC": "gestionale-01",
  "ObjectListListino": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie merceologiche

CategoriaMerceologica: le categorie che ordinano il catalogo, con le categorie dei marketplace

Categorie merceologiche: le categorie che ordinano il catalogo, con le categorie dei marketplace. Nel web service è il tipo CATEGORIEMERCEOLOGICHE (valore 2 di DataType); gli oggetti sono della classe CategoriaMerceologica e viaggiano nella lista ObjectListCategoriaMerceologica della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCATEGORIEMERCEOLOGICHE = 2
ClasseCategoriaMerceologica
Lista nella richiesta e nella rispostaObjectListCategoriaMerceologica
Tabella letta da QUERYCategorieMerceologiche — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CategoriaMerceologica

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
LogoImageTrasmission—oggetto vuoto—Logo, come file in Base64.
LogoMiniaturaImageTrasmission—oggetto vuoto—Logo in miniatura, come file in Base64.
CaricaVenditaBancoVero/falso—falsecaricavendbancoCarica vendita banco.
CaricaSuMenuEcommerceVero/falso—falsecaricaecommerceCarica su menu e-commerce.
CategoriaEbayTesto—vuotocatebayCategoria eBay.
CategoriaGoogleMarketTesto—vuotogooglecodCategoria corrispondente nella tassonomia di Google Merchant.
CategoriaGoogleMarketDescrizioneTesto—vuotogoogledesDescrizione di CategoriaGoogleMarket, riportata per comodità di chi legge.
CategoriaFacebookMarketTesto—vuotofacebookcodCategoria corrispondente nel catalogo di Meta.
CategoriaFacebookMarketDescrizioneTesto—vuotofacebookdesDescrizione di CategoriaFacebookMarket, riportata per comodità di chi legge.
CategoriaAmazonTesto—vuotocatamazonCategoria Amazon.
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.
DescrizioneDettagliataTesto—vuotodescrizionedettDescrizione estesa, anche in HTML.
AttivoVero/falso—falseattivoVero se il record è attivo.
SottocategoriaDefaultTesto—vuotosottocategoriadefSottocategoria predefinito.
RistoPlusPrioritaIntero—0rpprioritaRisto plus priorità.

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": 2,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCategoriaMerceologica": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CaricaVenditaBanco": false,
      "CaricaSuMenuEcommerce": false,
      "CategoriaEbay": "ESEMPIO",
      "CategoriaGoogleMarket": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 2,
  "GuidPC": "gestionale-01",
  "ObjectListCategoriaMerceologica": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Sottocategorie merceologiche

SottoCategoriaMerceologica: il secondo livello del catalogo, legato alla sua categoria

Sottocategorie merceologiche: il secondo livello del catalogo, legato alla sua categoria. Nel web service è il tipo SOTTOCATEGORIEMERCEOLOGICHE (valore 3 di DataType); gli oggetti sono della classe SottoCategoriaMerceologica e viaggiano nella lista ObjectListSottoCategoriaMerceologica della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSOTTOCATEGORIEMERCEOLOGICHE = 3
ClasseSottoCategoriaMerceologica
Lista nella richiesta e nella rispostaObjectListSottoCategoriaMerceologica
Tabella letta da QUERYSottoCategorieMerceologiche — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodiceCategoria + Codice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodiceCategoria|Codice
Chiave per le conferme di ricezioneCodiceCategoria|Codice — come si usa
Controlli prima del salvataggioCodiceCategoria: «Codice categoria non specificato»
Codice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di SottoCategoriaMerceologica

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
CodiceCategoriaTestoChiave, sìvuotocodicecategoriaCodice della categoria merceologica a cui appartiene. Codice dell'archivio Categorie merceologiche. Se manca il server risponde «Codice categoria non specificato».
DescrizioneCategoriaTesto—vuoto—Descrizione categoria.
CodiceTestoChiave, sìvuotocodiceCodice della sottocategoria, univoco all'interno della categoria. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CategoriaGoogleMarketTesto—vuotogooglecodCategoria corrispondente nella tassonomia di Google Merchant.
CategoriaGoogleMarketDescrizioneTesto—vuotogoogledesDescrizione di CategoriaGoogleMarket, riportata per comodità di chi legge.
CategoriaFacebookMarketTesto—vuotofacebookcodCategoria corrispondente nel catalogo di Meta.
CategoriaFacebookMarketDescrizioneTesto—vuotofacebookdesDescrizione di CategoriaFacebookMarket, riportata per comodità di chi legge.
LogoImageTrasmission—oggetto vuoto—Logo, come file in Base64.
LogoMiniaturaImageTrasmission—oggetto vuoto—Logo in miniatura, come file in Base64.
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.
DescrizioneDettagliataTesto—vuotodescrizionedettDescrizione estesa, anche in HTML.
AttivoVero/falso—falseattivoVero se il record è attivo.

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": 3,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListSottoCategoriaMerceologica": [
    {
      "CodiceCategoria": "COD001",
      "DescrizioneCategoria": "Descrizione di esempio",
      "Codice": "COD002",
      "Descrizione": "Descrizione di esempio",
      "CategoriaGoogleMarket": "ESEMPIO",
      "CategoriaFacebookMarket": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 3,
  "GuidPC": "gestionale-01",
  "ObjectListSottoCategoriaMerceologica": [
    {
      "CodiceCategoria": "COD001",
      "Codice": "COD002"
    }
  ]
}

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

Reparti

Reparti: i reparti di vendita, usati anche dai registratori di cassa

Reparti: i reparti di vendita, usati anche dai registratori di cassa. Nel web service è il tipo REPARTI (valore 5 di DataType); gli oggetti sono della classe Reparti e viaggiano nella lista ObjectListReparti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoREPARTI = 5
ClasseReparti
Lista nella richiesta e nella rispostaObjectListReparti
Tabella letta da QUERYReparti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Reparti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CodiceIVATesto—vuotocodivaCodice IVA. Codice dell'archivio Codici IVA.
StampanteTesto—vuotostampanteStampante.

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": 5,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListReparti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CodiceIVA": "COD002",
      "Stampante": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 5,
  "GuidPC": "gestionale-01",
  "ObjectListReparti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Settori

Settori: i settori merceologici per le analisi di vendita

Settori: i settori merceologici per le analisi di vendita. Nel web service è il tipo SETTORI (valore 6 di DataType); gli oggetti sono della classe Settori e viaggiano nella lista ObjectListSettori della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSETTORI = 6
ClasseSettori
Lista nella richiesta e nella rispostaObjectListSettori
Tabella letta da QUERYSettori — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Settori

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 6,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListSettori": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 6,
  "GuidPC": "gestionale-01",
  "ObjectListSettori": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Varianti

TestaVariante: le varianti degli articoli, come taglia o colore

Varianti: le varianti degli articoli, come taglia o colore. Nel web service è il tipo TESTAVARIANTE (valore 7 di DataType); gli oggetti sono della classe TestaVariante e viaggiano nella lista ObjectListTestaVariante della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTESTAVARIANTE = 7
ClasseTestaVariante
Lista nella richiesta e nella rispostaObjectListTestaVariante
Tabella letta da QUERYTestaVarianti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TestaVariante

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ProgressivoIntero—0progressivoNumero progressivo della riga all'interno del record principale.
MultiSelectVero/falso—falsemultiselectVero se si possono scegliere più valori insieme.

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": 7,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTestaVariante": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Progressivo": 1,
      "MultiSelect": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 7,
  "GuidPC": "gestionale-01",
  "ObjectListTestaVariante": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Valori delle varianti

CorpoVariante: i valori di ogni variante, generali o specifici di un articolo

Valori delle varianti: i valori di ogni variante, generali o specifici di un articolo. Nel web service è il tipo CORPOVARIANTE (valore 8 di DataType); gli oggetti sono della classe CorpoVariante e viaggiano nella lista ObjectListCorpoVariante della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCORPOVARIANTE = 8
ClasseCorpoVariante
Lista nella richiesta e nella rispostaObjectListCorpoVariante
Tabella letta da QUERYCorpoVarianti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodiceVariante + Codice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodiceVariante|Codice
Chiave per le conferme di ricezioneCodiceVariante|Codice|CodiceArticolo — come si usa
Controlli prima del salvataggioCodiceVariante: «Codice variante non specificato»
Codice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CorpoVariante

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
CodiceVarianteTestoChiave, sìvuotocodicevarCodice della variante a cui appartiene il valore. Codice dell'archivio Varianti. Se manca il server risponde «Codice variante non specificato».
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
CodiceArticoloTesto—vuotocodartCodice dell'articolo, se il valore vale solo per quell'articolo; vuoto se vale per tutti. Codice dell'archivio Articoli.
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ProgressivoIntero—0progressivoNumero progressivo della riga all'interno del record principale.
DefaultValueVero/falso—falsedefvalueVero se è il valore proposto per primo.
NonStampareVero/falso—falsenostampaVero per non stampare il valore nei documenti.
EsportaVero/falso—falseesportaprestaVero se il record va esportato.

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": 8,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCorpoVariante": [
    {
      "CodiceVariante": "COD001",
      "Codice": "COD002",
      "CodiceArticolo": "COD003",
      "Descrizione": "Descrizione di esempio",
      "Progressivo": 1,
      "DefaultValue": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 8,
  "GuidPC": "gestionale-01",
  "ObjectListCorpoVariante": [
    {
      "CodiceVariante": "COD001",
      "Codice": "COD002"
    }
  ]
}

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

Depositi

Deposito: i magazzini e i punti vendita in cui si tengono le giacenze

Depositi: i magazzini e i punti vendita in cui si tengono le giacenze. Nel web service è il tipo DEPOSITI (valore 9 di DataType); gli oggetti sono della classe Deposito e viaggiano nella lista ObjectListDeposito della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDEPOSITI = 9
ClasseDeposito
Lista nella richiesta e nella rispostaObjectListDeposito
Tabella letta da QUERYDepositi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Deposito

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
IndirizzoTesto—vuotoindirizzoIndirizzo (via e numero civico).
CapTesto—vuotocapCodice di avviamento postale.
CittaTesto—vuotocittaCittà.
ProvinciaTesto—vuotoprovSigla della provincia.
Telefono1Testo—vuototelefono1Primo numero di telefono.
Telefono2Testo—vuototelefono2Secondo numero di telefono.
CellulareTesto—vuotocellulareNumero di cellulare.
FaxTesto—vuotofaxNumero di fax.
ReferenteTesto—vuotoreferenteNome del referente.
DestinazioneDiversaLegataADepositoTesto—vuotocoddestinazioneDestinazione diversa legata a deposito.
DescrizioneAggiuntivaTesto—vuotoaggiuntivaDescrizione aggiuntiva.
GestisciContabileVero/falso—falsemovimentaGestisci contabile.
NoteTesto—vuotonotedepNote libere.
OrariTesto—vuotoorariOrari.
ListinoTesto—vuotolistinoCodice del listino. Codice dell'archivio Listini.
ObsoletoVero/falso—falseobsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
DataObsoletoData e ora—nessuna datadataobData da cui il record è obsoleto.
EmailTesto—vuotoemailIndirizzo email.
PECTesto—vuotopecIndirizzo di posta elettronica certificata.
GPSLatitudineDecimale—0gpslatGPS latitudine.
GPSLongitudineDecimale—0gpslongGPS longitudine.
MerchandisingTipoTesto—vuotomerctipoMerchandising tipo.
MerchandisingNumeroBancoIntero—0mercnumbancoMerchandising numero banco.

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": 9,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDeposito": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Indirizzo": "ESEMPIO",
      "Cap": "ESEMPIO",
      "Citta": "ESEMPIO",
      "Provincia": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 9,
  "GuidPC": "gestionale-01",
  "ObjectListDeposito": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Causali di magazzino

CausaleMagazzino: le causali che decidono come un documento muove il magazzino

Causali di magazzino: le causali che decidono come un documento muove il magazzino. Nel web service è il tipo CAUSALIMAGAZZINO (valore 10 di DataType); gli oggetti sono della classe CausaleMagazzino e viaggiano nella lista ObjectListCausaleMagazzino della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCAUSALIMAGAZZINO = 10
ClasseCausaleMagazzino
Lista nella richiesta e nella rispostaObjectListCausaleMagazzino
Tabella letta da QUERYCausaliMagazzino — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CausaleMagazzino

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
CodiceTestoChiave, sì—codiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSì—descrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoMovimentoTesto——tipoTipo movimento.
TipoControparteRichiestaIntero———Tipo controparte richiesta.
TipoControparteRichiestaInStringTesto———Tipo controparte richiesta in string.
IndicatoreVendutoQuantitaTesto——venqtIndicatore venduto quantità.
IndicatoreVendutoValoreTesto——venvalIndicatore venduto valore.
IndicatoreAcquistatoQuantitaTesto——acqqtIndicatore acquistato quantità.
IndicatoreAcquistatoValoreTesto——acqvalIndicatore acquistato valore.
IndicatoreCaricatoQuantitaTesto——carqtIndicatore caricato quantità.
IndicatoreCaricatoValoreTesto——carvalIndicatore caricato valore.
IndicatoreScaricatoQuantitaTesto——scarqtIndicatore scaricato quantità.
IndicatoreScaricatoValoreTesto——scarvalIndicatore scaricato valore.
IndicatoreImpegnatoQuantitaTesto——impqtIndicatore impegnato quantità.
IndicatoreImpegnatoValoreTesto——impvalIndicatore impegnato valore.
IndicatoreOrdinatoClienteQuantitaTesto——ordcqtIndicatore ordinato cliente quantità.
IndicatoreOrdinatoClienteValoreTesto——ordcvalIndicatore ordinato cliente valore.
IndicatoreOrdinatoFornitoreQuantitaTesto——ordfqtIndicatore ordinato fornitore quantità.
IndicatoreOrdinatoFornitoreValoreTesto——ordfvalIndicatore ordinato fornitore valore.
IndicatoreEsistenzaInizialeQuantitaTesto——esiinizqtIndicatore esistenza iniziale quantità.
IndicatoreEsistenzaInizialeValoreTesto——esiinizvalIndicatore esistenza iniziale valore.
IndicatoreMemoArticoliTesto——memoordIndicatore memo articoli.
IndicatoreMovimentazioneClienteUtilizzatoreTesto——movcliutiIndicatore movimentazione cliente utilizzatore.
IndicatoreMovimentazioneClienteProprietarioTesto——movclipropIndicatore movimentazione cliente proprietario.
MotivoMovimentazioneParcoMacchineTesto——motivomovpmMotivo movimentazione parco macchine.
OperativitaTesto——operativitaOperativita.
AggiornaUltimoPrezzoListinoVero/falso——aggiornaultpzAggiorna ultimo prezzo listino.
EscludiDaStoricoVero/falso——escludidastoricoEscludi da storico.
NonMovimentaParcoMacchineVero/falso——nonmovpmNon movimenta parco macchine.
SegnoCausaleTesto———Segno causale.
SegnoCausale2Testo———Segno causale 2.
GeneraMovimentoSegnoOppostoVero/falso——genmovasegnooppostoGenera movimento segno opposto.
GeneraMovimentoSegnoOppostoDepositoTesto——genmovasegnooppostodepositoGenera movimento segno opposto deposito.
GeneraMovimentoDiInvioContoLavorazioneVero/falso——genmovinviocontolavGenera movimento di invio conto lavorazione.
ObsoletoVero/falso——obsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
DataObsoletoData e ora——obsoletodalData da cui il record è obsoleto.

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": 10,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCausaleMagazzino": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "TipoMovimento": "ESEMPIO",
      "TipoControparteRichiesta": 1,
      "TipoControparteRichiestaInString": "ESEMPIO",
      "IndicatoreVendutoQuantita": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 10,
  "GuidPC": "gestionale-01",
  "ObjectListCausaleMagazzino": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Eventi di merchandising

MerchandisingEvento: gli eventi con banchi, articoli e artisti per il merchandising

Eventi di merchandising: gli eventi con banchi, articoli e artisti per il merchandising. Nel web service è il tipo MERCHANDISINGEVENTO (valore 12 di DataType); gli oggetti sono della classe MerchandisingEvento e viaggiano nella lista ObjectListMerchandisingEvento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoMERCHANDISINGEVENTO = 12
ClasseMerchandisingEvento
Lista nella richiesta e nella rispostaObjectListMerchandisingEvento
Tabella letta da QUERYMercEventi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveAnno + Numero — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassAnno|Numero
Chiave per le conferme di ricezioneAnno|Numero — come si usa

I campi di MerchandisingEvento

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
AnnoInteroChiave0annoAnno.
NumeroInteroChiave0numeroNumero.
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
ObsoletoVero/falso—falseobsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
ConclusoVero/falso—falseconclusoConcluso.
ArtistiElenco di Testo—elenco vuotoartistaArtisti.
TappeElenco di MerchandisingEventoTappa—elenco vuoto—Tappe: elenco di oggetti MerchandisingEventoTappa.
ArticoliElenco di MerchandisingEventoArticoli—elenco vuoto—Articoli: elenco di oggetti MerchandisingEventoArticoli.
FileAllegatiElenco di ImageTrasmission—elenco vuoto—File allegati.

Classe annidata MerchandisingEventoTappa

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataData e ora—nessuna dataData.
CittaTesto—vuotoCittà.
LuogoTesto—vuotoLuogo.
NumeroBanchiIntero—0Numero banchi.
CompletataVero/falso—falseCompletata.

Classe annidata MerchandisingEventoArticoli

Elemento usato dentro MerchandisingEvento. 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.
GesVarianteVero/falso—falseGes variante.
VarianteTesto—vuotoVariante.
ImportoDecimale—0Importo.
CategoriaMerceologicaTesto—vuotoCategoria merceologica. Codice dell'archivio Categorie merceologiche.
SottocategoriaMerceologicaTesto—vuotoSottocategoria merceologica. Codice dell'archivio Sottocategorie merceologiche.
PercentualeProvvigioneDecimale—0Percentuale provvigione.
RaggruppamentoTesto—vuotoCodice del raggruppamento. Codice dell'archivio Raggruppamenti dei file.
ListaCodiciVariantiElenco di MerchandisingEventoArticoliCodiciVarianti—elenco vuotoCodici varianti: elenco di oggetti MerchandisingEventoArticoliCodiciVarianti.

Classe annidata MerchandisingEventoArticoliCodiciVarianti

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

CampoTipoObbligatorioPredefinitoA cosa serve
StringaVarianteTesto—vuotoValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
CodiceTesto—vuotoCodice univoco del record. È la chiave con cui il record viene creato o aggiornato.

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": 12,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListMerchandisingEvento": [
    {
      "Anno": 2026,
      "Numero": 1,
      "Descrizione": "Descrizione di esempio",
      "Obsoleto": false,
      "Concluso": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 12,
  "GuidPC": "gestionale-01",
  "ObjectListMerchandisingEvento": [
    {
      "Anno": 2026,
      "Numero": 1
    }
  ]
}

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

Artisti degli eventi

MerchandisingArtisti: gli artisti collegati agli eventi di merchandising

Artisti degli eventi: gli artisti collegati agli eventi di merchandising. Nel web service è il tipo MERCHANDISINGARTISTI (valore 13 di DataType); gli oggetti sono della classe MerchandisingArtisti e viaggiano nella lista ObjectListMerchandisingArtisti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoMERCHANDISINGARTISTI = 13
ClasseMerchandisingArtisti
Lista nella richiesta e nella rispostaObjectListMerchandisingArtisti
Tabella letta da QUERYMercArtisti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di MerchandisingArtisti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 13,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListMerchandisingArtisti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 13,
  "GuidPC": "gestionale-01",
  "ObjectListMerchandisingArtisti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Scale di valori

ScalaValori: le scale di valori variabili applicate agli articoli

Scale di valori: le scale di valori variabili applicate agli articoli. Nel web service è il tipo SCALAVALORI (valore 14 di DataType); gli oggetti sono della classe ScalaValori e viaggiano nella lista ObjectListScalaValori della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSCALAVALORI = 14
ClasseScalaValori
Lista nella richiesta e nella rispostaObjectListScalaValori
Tabella letta da QUERYScalaValoriVariabiliperArticolo — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di ScalaValori

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ImageImageTrasmission—null—Immagine, come file in Base64.
ValoriElenco di ScalaValoriValori—elenco vuoto—Valori: elenco di oggetti ScalaValoriValori.

Classe annidata ScalaValoriValori

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

CampoTipoObbligatorioPredefinitoA cosa serve
NumeroCampoSuRecordArticoliTesto—vuotoNumero campo su record articoli.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
EsportaVero/falso—falseVero se il record va esportato.

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": 14,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListScalaValori": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 14,
  "GuidPC": "gestionale-01",
  "ObjectListScalaValori": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Campi variabili tabellari 1

CampiVariabiliArticoli1: i valori ammessi per il primo campo variabile tabellare degli articoli

Campi variabili tabellari 1: i valori ammessi per il primo campo variabile tabellare degli articoli. Nel web service è il tipo CAMPIVARIABILI1 (valore 15 di DataType); gli oggetti sono della classe CampiVariabiliArticoli1 e viaggiano nella lista ObjectListCampiVariabiliArticoli1 della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCAMPIVARIABILI1 = 15
ClasseCampiVariabiliArticoli1
Lista nella richiesta e nella rispostaObjectListCampiVariabiliArticoli1
Tabella letta da QUERYCampiVariabiliArticolo1 — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
ScalaValori: «Scala valori non specificata»
Descrizione: «Descrizione non specificato»

I campi di CampiVariabiliArticoli1

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ScalaValoriTestoSìvuotocodscalavaloriScala valori. Se manca il server risponde «Scala valori non specificata».
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.

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": 15,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCampiVariabiliArticoli1": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ScalaValori": "ESEMPIO",
      "Ordinamento": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 15,
  "GuidPC": "gestionale-01",
  "ObjectListCampiVariabiliArticoli1": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Campi variabili tabellari 2

CampiVariabiliArticoli2: i valori ammessi per il secondo campo variabile tabellare degli articoli

Campi variabili tabellari 2: i valori ammessi per il secondo campo variabile tabellare degli articoli. Nel web service è il tipo CAMPIVARIABILI2 (valore 16 di DataType); gli oggetti sono della classe CampiVariabiliArticoli2 e viaggiano nella lista ObjectListCampiVariabiliArticoli2 della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCAMPIVARIABILI2 = 16
ClasseCampiVariabiliArticoli2
Lista nella richiesta e nella rispostaObjectListCampiVariabiliArticoli2
Tabella letta da QUERYCampiVariabiliArticolo2 — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
ScalaValori: «Scala valori non specificata»
Descrizione: «Descrizione non specificato»

I campi di CampiVariabiliArticoli2

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ScalaValoriTestoSìvuotocodscalavaloriScala valori. Se manca il server risponde «Scala valori non specificata».
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.

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": 16,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCampiVariabiliArticoli2": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ScalaValori": "ESEMPIO",
      "Ordinamento": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 16,
  "GuidPC": "gestionale-01",
  "ObjectListCampiVariabiliArticoli2": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Campi variabili tabellari 3

CampiVariabiliArticoli3: i valori ammessi per il terzo campo variabile tabellare degli articoli

Campi variabili tabellari 3: i valori ammessi per il terzo campo variabile tabellare degli articoli. Nel web service è il tipo CAMPIVARIABILI3 (valore 17 di DataType); gli oggetti sono della classe CampiVariabiliArticoli3 e viaggiano nella lista ObjectListCampiVariabiliArticoli3 della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCAMPIVARIABILI3 = 17
ClasseCampiVariabiliArticoli3
Lista nella richiesta e nella rispostaObjectListCampiVariabiliArticoli3
Tabella letta da QUERYCampiVariabiliArticolo3 — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
ScalaValori: «Scala valori non specificata»
Descrizione: «Descrizione non specificato»

I campi di CampiVariabiliArticoli3

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ScalaValoriTestoSìvuotocodscalavaloriScala valori. Se manca il server risponde «Scala valori non specificata».
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.

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": 17,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCampiVariabiliArticoli3": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ScalaValori": "ESEMPIO",
      "Ordinamento": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 17,
  "GuidPC": "gestionale-01",
  "ObjectListCampiVariabiliArticoli3": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Campi variabili tabellari 4

CampiVariabiliArticoli4: i valori ammessi per il quarto campo variabile tabellare degli articoli

Campi variabili tabellari 4: i valori ammessi per il quarto campo variabile tabellare degli articoli. Nel web service è il tipo CAMPIVARIABILI4 (valore 18 di DataType); gli oggetti sono della classe CampiVariabiliArticoli4 e viaggiano nella lista ObjectListCampiVariabiliArticoli4 della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCAMPIVARIABILI4 = 18
ClasseCampiVariabiliArticoli4
Lista nella richiesta e nella rispostaObjectListCampiVariabiliArticoli4
Tabella letta da QUERYCampiVariabiliArticolo4 — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
ScalaValori: «Scala valori non specificata»
Descrizione: «Descrizione non specificato»

I campi di CampiVariabiliArticoli4

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ScalaValoriTestoSìvuotocodscalavaloriScala valori. Se manca il server risponde «Scala valori non specificata».
OrdinamentoIntero—0ordinamentoPosizione nell'ordinamento: i valori più bassi vengono prima.

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": 18,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCampiVariabiliArticoli4": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ScalaValori": "ESEMPIO",
      "Ordinamento": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 18,
  "GuidPC": "gestionale-01",
  "ObjectListCampiVariabiliArticoli4": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Articoli

Product: l'anagrafica completa dell'articolo, con codici a barre, varianti, distinte, imballi e dati per il sito

Articoli: l'anagrafica completa dell'articolo, con codici a barre, varianti, distinte, imballi e dati per il sito. Nel web service è il tipo PRODUCT (valore 19 di DataType); gli oggetti sono della classe Product e viaggiano nella lista ObjectListProduct della richiesta e della risposta.

È la classe più ricca del web service. Con un solo oggetto Product si trasmettono l'anagrafica, la classificazione (categoria, sottocategoria, marchio, reparto, settore), i dati fiscali, le misure del prodotto e della confezione, i testi per il sito, i campi variabili e gli elenchi collegati: codici a barre, articoli correlati e accessori, varianti, distinta dei componenti, imballi, scorte minime per deposito, optional, caratteristiche tecniche, tasse di smaltimento, conversioni tra unità di misura e importi per le spedizioni.

Prezzi, immagini, file e giacenze non stanno nell'articolo: hanno ciascuno il proprio tipo (PRODUCTPRICE, PRODUCTIMAGE, PRODUCTFILE, GIACENZEARTICOLI), così si aggiornano separatamente e con la frequenza che serve. Prima di inviare un articolo devono esistere i codici che usa: categoria, IVA, unità di misura, marchio e gli altri archivi collegati.

Scheda tecnica

VoceValore
Tipo di datoPRODUCT = 19
ClasseProduct
Lista nella richiesta e nella rispostaObjectListProduct
Tabella letta da QUERYarticoli — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Product

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
CodiceTestoChiave, sìvuotocodiceCodice dell'articolo, univoco. È la chiave dell'articolo in tutto il web service. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione dell'articolo usata nei documenti. Se manca il server risponde «Descrizione non specificato».
CategoriaMerceologicaTesto—vuotolineaCategoria merceologica. Codice dell'archivio Categorie merceologiche.
CategoriaMerceologicaDescrizioneTesto—vuotocatmercdescrizioneDescrizione di CategoriaMerceologica, riportata per comodità di chi legge.
SottocategoriaMerceologicaTesto—vuotosottolineaSottocategoria merceologica. Codice dell'archivio Sottocategorie merceologiche.
SottocategoriaMerceologicaDescrizioneTesto—vuotosottodesDescrizione di SottocategoriaMerceologica, riportata per comodità di chi legge.
TipologiaArticoloIntero—0tipoartTipologia dell'articolo, come numero.
TipologiaArticoloDescrizioneTesto—vuoto—Descrizione di TipologiaArticolo, riportata per comodità di chi legge.
SettoreTesto—vuotosettoreSettore. Codice dell'archivio Settori.
SettoreDescrizioneTesto—vuotodessettoreDescrizione di Settore, riportata per comodità di chi legge.
RepartoTesto—vuotorepartoReparto. Codice dell'archivio Reparti.
RepartoDescrizioneTesto—vuotodesrepartoDescrizione di Reparto, riportata per comodità di chi legge.
IVATesto—vuotoivaCodice IVA dell'articolo. Codice dell'archivio Codici IVA.
IVAPercentualeDecimale—0ivapercIVA percentuale.
IVAPercentualeDetraibileDecimale—0ivapercdetrIVA percentuale detraibile.
IVAReverseChargeVero/falso—falseivarevchargeIVA reverse charge.
IVADescrizioneTesto—vuotoivadesDescrizione di IVA, riportata per comodità di chi legge.
ScortaMinimaDecimale—0scortaminScorta minima generale; quella per deposito sta in ListaScortaMinima.
PosizioneInMagazzinoTesto—vuotoposinmagPosizione dell'articolo in magazzino (scaffale, corsia).
UnitaMisuraTesto—vuotoumCodice dell'unità di misura. Codice dell'archivio Unità di misura.
UnitaMisuraDescrizioneTesto—vuoto—Descrizione di UnitaMisura, riportata per comodità di chi legge.
GestioneSerialNumberVero/falso—false—Vero se l'articolo gestisce i numeri di serie.
NoteTesto—vuotonoteNote libere.
CampiVariabiliTabellare1Testo—vuototestot1Campi variabili tabellare 1. Codice dell'archivio Campi variabili tabellari 1.
CampiVariabiliTabellare1DescrizioneTesto—vuotodestestot1desDescrizione di CampiVariabiliTabellare1, riportata per comodità di chi legge.
CampiVariabiliTabellare2Testo—vuototestot2Campi variabili tabellare 2. Codice dell'archivio Campi variabili tabellari 2.
CampiVariabiliTabellare2DescrizioneTesto—vuotodestestot2desDescrizione di CampiVariabiliTabellare2, riportata per comodità di chi legge.
CampiVariabiliTabellare3Testo—vuototestot3Campi variabili tabellare 3. Codice dell'archivio Campi variabili tabellari 3.
CampiVariabiliTabellare3DescrizioneTesto—vuotodestestot3desDescrizione di CampiVariabiliTabellare3, riportata per comodità di chi legge.
CampiVariabiliTabellare4Testo—vuototestot4Campi variabili tabellare 4. Codice dell'archivio Campi variabili tabellari 4.
CampiVariabiliTabellare4DescrizioneTesto—vuotodestestot4desDescrizione di CampiVariabiliTabellare4, riportata per comodità di chi legge.
CampiVariabiliDescrittiva1Testo—vuototesto1Campi variabili descrittiva 1.
CampiVariabiliDescrittiva2Testo—vuototesto2Campi variabili descrittiva 2.
CampiVariabiliDescrittiva3Testo—vuototesto3Campi variabili descrittiva 3.
CampiVariabiliDescrittiva4Testo—vuototesto4Campi variabili descrittiva 4.
CampiVariabiliDescrittiva5Testo—vuototesto5Campi variabili descrittiva 5.
CampiVariabiliDescrittiva6Testo—vuototesto6Campi variabili descrittiva 6.
CampiVariabiliDescrittiva7Testo—vuototesto7Campi variabili descrittiva 7.
CampiVariabiliDescrittiva8Testo—vuototesto8Campi variabili descrittiva 8.
CampiVariabiliDescrittiva9Testo—vuototesto9Campi variabili descrittiva 9.
CampiVariabiliDescrittiva10Testo—vuototesto10Campi variabili descrittiva 10.
CampiVariabiliDescrittiva11Testo—vuototesto11Campi variabili descrittiva 11.
CampiVariabiliDescrittiva12Testo—vuototesto12Campi variabili descrittiva 12.
CampiVariabiliDescrittiva13Testo—vuototesto13Campi variabili descrittiva 13.
CampiVariabiliDescrittiva14Testo—vuototesto14Campi variabili descrittiva 14.
CampiVariabiliDescrittiva15Testo—vuototesto15Campi variabili descrittiva 15.
CampiVariabiliDescrittiva16Testo—vuototesto16Campi variabili descrittiva 16.
CampiVariabiliDescrittiva17Testo—vuototesto17Campi variabili descrittiva 17.
CampiVariabiliDescrittiva18Testo—vuototesto18Campi variabili descrittiva 18.
CampiVariabiliDescrittiva19Testo—vuototesto19Campi variabili descrittiva 19.
CampiVariabiliDescrittiva20Testo—vuototesto20Campi variabili descrittiva 20.
CampiVariabiliDescrittiva21Testo—vuototesto21Campi variabili descrittiva 21.
CampiVariabiliDescrittiva22Testo—vuototesto22Campi variabili descrittiva 22.
CampiVariabiliDescrittiva23Testo—vuototesto23Campi variabili descrittiva 23.
CampiVariabiliDescrittiva24Testo—vuototesto24Campi variabili descrittiva 24.
CampiVariabiliDescrittiva25Testo—vuototesto25Campi variabili descrittiva 25.
CampiVariabiliDescrittiva26Testo—vuototesto26Campi variabili descrittiva 26.
CategoriaProvvigionaleTesto—vuotocatprovvCategoria provvigionale. Codice dell'archivio Categorie provvigionali.
CategoriaProvvigionaleDescrizioneTesto—vuotodescatprovvDescrizione di CategoriaProvvigionale, riportata per comodità di chi legge.
FornitoreAbitualeTesto—vuotofornabitualeCodice del fornitore abituale. Codice dell'archivio Clienti e fornitori.
FornitoreAbitualeDescrizioneTesto—vuotodesfornabitualeDescrizione di FornitoreAbituale, riportata per comodità di chi legge.
GestioneVariantiVero/falso—false—Vero se l'articolo ha varianti (taglia, colore...).
ObsoletoVero/falso—false—Vero se il record non è più in uso: resta in archivio ma non viene proposto.
ObsoletoDalData e ora—nessuna datadataobData da cui il record è obsoleto.
PesoDecimale—0pesoPeso.
PesoConfezionatoDecimale—0pesoconfPeso confezionato.
CubaturaDecimale—0cubaturaCubatura.
CubaturaInternaDecimale—0cubaturaintCubatura interna.
CubaturaEsternaDecimale—0cubaturaestCubatura esterna.
ConfezionatoAltezzaDecimale—0altezzaconfConfezionato altezza.
ConfezionatoProfonditaDecimale—0profonditaconfConfezionato profondità.
ConfezionatoLarghezzaDecimale—0larghezzaconfConfezionato larghezza.
InternoAltezzaDecimale—0altezzaintInterno altezza.
InternoProfonditaDecimale—0profonditaintInterno profondità.
InternoLarghezzaDecimale—0larghezzaintInterno larghezza.
EsternoAltezzaDecimale—0altezzaestEsterno altezza.
EsternoProfonditaDecimale—0profonditaestEsterno profondità.
EsternoLarghezzaDecimale—0larghezzaestEsterno larghezza.
DescrizioneDettagliataTesto—vuotodescdettDescrizione estesa, anche in HTML.
CodiceRaeeTesto—vuotocodraeeCodice del contributo RAEE.
CodiceRaeeDescrizioneTesto—vuoto—Descrizione di CodiceRaee, riportata per comodità di chi legge.
ModelloEtichettaTesto—vuotomodetichModello di etichetta da stampare per l'articolo.
ModelloEtichettaDescrizioneTesto—vuoto—Descrizione di ModelloEtichetta, riportata per comodità di chi legge.
QuantitaPerColloDecimale—0qtapercolloQuantità contenuta in un collo.
ScalaVariabiliTesto—vuotoscalavaloriCodice della scala di valori applicata all'articolo. Codice dell'archivio Scale di valori.
ScalaVariabiliDescrizioneTesto—vuotodesscalavaloriDescrizione di ScalaVariabili, riportata per comodità di chi legge.
OffertaVero/falso—false—Vero se l'articolo è in offerta.
BrandTesto—vuotobrandBrand. Codice dell'archivio Marchi.
BrandDescrizioneTesto—vuotodesbrandDescrizione di Brand, riportata per comodità di chi legge.
PezziPerConfezioneDecimale—0pezziconfPezzi contenuti in una confezione.
PartecipaRitenutaDAccontoVero/falso—false—Vero se l'articolo entra nel calcolo della ritenuta d'acconto.
DescrizioneWEBTesto—vuotodescwebDescrizione da usare sul sito al posto di quella del gestionale.
PrezzoNominaleDecimale—0pznominalePrezzo nominale di riferimento.
ChiediQuantitaSuVenditaAlBancoVero/falso—false—Vero se alla vendita al banco va chiesta la quantità.
RendiInvisibileWEBVero/falso—false—Vero per nascondere l'articolo sul sito.
RendiNonOrdinabileWEBVero/falso—false—Vero se l'articolo si vede sul sito ma non si può ordinare.
CalcoloAutoImportoBaseDecimale—0calcoloautoimportobaseImporto base per il calcolo automatico del prezzo.
QuantitaPropostaWEBDecimale—0ecommqtapropQuantità proposta nel carrello del sito.
ImportoMaggiorazioneSpedizioniDecimale—0importomaggspedImporto che si aggiunge alle spese di spedizione quando l'articolo è nel carrello.
EscludiDaExportAmazonVero/falso—false—Vero per escludere l'articolo dai feed per Amazon.
CaricaNelBannerVero/falso—false—Vero per mostrare l'articolo nei banner del sito.
BestSellerVero/falso—false—Vero per segnalare l'articolo come più venduto.
URLSchedaTesto—vuotourlschedaIndirizzo di una scheda esterna dell'articolo.
CodiceVideoYoutube1Testo—vuotocodyoutube1Codice video YouTube 1.
CodiceVideoYoutube2Testo—vuotocodyoutube2Codice video YouTube 2.
CodiceVideoYoutube3Testo—vuotocodyoutube3Codice video YouTube 3.
AsinAmazonTesto—vuotoasinamazonCodice ASIN dell'articolo su Amazon.
EscludiDaCalcoloPezziInDocumentiVero/falso—falseescludidacalcolopezziindocumentiVero per non contare l'articolo nel totale dei pezzi dei documenti.
AssoggettatoImpostaDiConsumoVero/falso—falseimpostaconsumoAssoggettato imposta di consumo.
AssoggettatoImpostaDiConsumoImportoDecimale—0impostaconsumoimportoAssoggettato imposta di consumo importo.
AssoggettatoImpostaDiConsumoCodiceArticoloTesto—vuotoimpostaconsumocodarticoloAssoggettato imposta di consumo codice articolo.
AssoggettatoImpostaDiConsumoTipoTabellaTesto—vuotoimpostaconsumotabrifAssoggettato imposta di consumo tipo tabella.
AssoggettatoImpostaDiConsumoPezziConfezioneIntero—0impostaconsumonumpezziAssoggettato imposta di consumo pezzi confezione.
AssoggettatoImpostaDiConsumoPezziConfezioneOriginaleSuTracciatoIntero—0impostaconsumonumpezziorigtracciatoAssoggettato imposta di consumo pezzi confezione originale su tracciato.
ArticoloDigitaleVero/falso—falseversionedigitaleVero per gli articoli digitali, senza spedizione.
EcommercePositionDecimale—0ecommercepositionPosizione dell'articolo negli elenchi del sito.
QuantitaMassimaSuSitoDecimale—0quantitamassimasusitoQuantità massima ordinabile sul sito per ordine.
ScontoMassimoApplicabileDecimale—0scontomassimoapplicabileSconto massimo che si può applicare all'articolo, in percentuale.
DataInserimentoData e ora—nessuna datainsdataData di inserimento.
OraInserimentoData e ora—nessuna datainsoraOra di inserimento.
EsportaSuMarketVero/falso—falseesportamarketVero per includere l'articolo nei feed dei marketplace.
ActiveVero/falso—false—Vero se l'articolo è attivo.
MaxOrdinabiliSuSitoPerClienteDecimale—0maxordinabileperclienteQuantità massima ordinabile sul sito da ogni cliente.
PostiPerOfferteComponibiliDecimale—0boxpostiPosti disponibili quando l'articolo è una confezione componibile.
PostiOccupatiPerOfferteComponibiliDecimale—0postioccupatiPosti che l'articolo occupa dentro una confezione componibile.
ListaArticoliCorrelatiElenco di Testo—elenco vuotocodiceassCodici degli articoli correlati, proposti insieme a questo.
ListaArticoliAccessoriElenco di Testo—elenco vuotocodiceassCodici degli articoli accessori.
ListaCodiciBarreElenco di BarCode—elenco vuoto—Codici barre: elenco di oggetti BarCode.
ListaCategorieIncluseElenco di CategorieSottocategorieIncluse—elenco vuoto—Categorie incluse: elenco di oggetti CategorieSottocategorieIncluse.
ListaImballiElenco di Imballi—elenco vuoto—Imballi: elenco di oggetti Imballi.
ListaScortaMinimaElenco di ScortaMinimaPerDeposito—elenco vuoto—Scorta minima: elenco di oggetti ScortaMinimaPerDeposito.
ListaOptionalArticoloElenco di OptionalArticolo—elenco vuoto—Optional articolo: elenco di oggetti OptionalArticolo.
ListaTasseDiSmaltimentoElenco di TasseDiSmaltimento—elenco vuoto—Tasse di smaltimento: elenco di oggetti TasseDiSmaltimento.
ListaVariantiElenco di Testo—elenco vuotocodvarianteCodici delle varianti usate dall'articolo.
ListaClassificazioneElenco di Classificazioni—elenco vuoto—Classificazione: elenco di oggetti Classificazioni.
ListaCaratteristicheTecnicheElenco di CaratteristicheTecniche—elenco vuoto—Caratteristiche tecniche: elenco di oggetti CaratteristicheTecniche.
ListaCaratteristicheTecnicheDescrittiveElenco di Testo—elenco vuotodescrizioneCaratteristiche tecniche descrittive, una per elemento.
ListaCaratteristicheTecnicheDotazioneElenco di CaratteristicheTecnicheDotazione—elenco vuoto—Caratteristiche tecniche dotazione: elenco di oggetti CaratteristicheTecnicheDotazione.
ListaArticoliBundleElenco di ComponentiBundle—elenco vuoto—Articoli bundle: elenco di oggetti ComponentiBundle.
ListaUnitaMisuraConversionRateElenco di UnitaMisuraConversionRate—elenco vuoto—Unità misura conversion rate: elenco di oggetti UnitaMisuraConversionRate.
ListaImportoPerSpedizioniElenco di ImportoPerSpedizione—elenco vuoto—Importo per spedizioni: elenco di oggetti ImportoPerSpedizione.

Classe annidata BarCode

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

CampoTipoObbligatorioPredefinitoA cosa serve
DepositoTesto—vuotoCodice del deposito. Codice dell'archivio Depositi.
DepositoDescrizioneTesto—vuotoDescrizione di Deposito, riportata per comodità di chi legge.
UnitaMisuraTesto—vuotoCodice dell'unità di misura. Codice dell'archivio Unità di misura.
UnitaMisuraDescrizioneTesto—vuotoDescrizione di UnitaMisura, riportata per comodità di chi legge.
BarCodeTesto—vuotoIl codice a barre.
DefaultBarCodeVero/falso——Vero se è il codice a barre principale.
StringaVariantiTesto—vuotoValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
TypeBarcodeSFHTypeBarcode—Ean13Tipo di codice a barre (enumerazione SFHTypeBarcode).

Classe annidata CategorieSottocategorieIncluse

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceCategoriaTesto—vuotoCodice della categoria merceologica a cui appartiene. Codice dell'archivio Categorie merceologiche.
CodiceSottoCategoriaTesto—vuotoCodice sotto categoria.

Classe annidata Imballi

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceImballoTesto—vuotoCodice imballo.
QuantitaDecimale—0Quantità.

Classe annidata ScortaMinimaPerDeposito

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

CampoTipoObbligatorioPredefinitoA cosa serve
DepositoTesto—vuotoCodice del deposito. Codice dell'archivio Depositi.
QuantitaDecimale—0Quantità.

Classe annidata OptionalArticolo

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoOptionalTesto—vuotoTipo optional.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
ImportoDecimale—0Importo.

Classe annidata TasseDiSmaltimento

Elemento usato dentro Product. 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.
TipoAddebitoTesto—"f"Tipo addebito.
IncludiNelPrezzoVero/falso—falseIncludi nel prezzo.
ImportoDecimale—0Importo.
IVAInclusaVero/falso—falseVero se gli importi comprendono l'IVA.
ListaDettaglioMaterialiElenco di TasseDiSmaltimentoDettaglio—elenco vuotoDettaglio materiali: elenco di oggetti TasseDiSmaltimentoDettaglio.

Classe annidata TasseDiSmaltimentoDettaglio

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoMaterialeTesto—vuotoTipo materiale.
SottotipoMaterialeTesto—vuotoSottotipo materiale.
QuantitaGenerataDecimale—0Quantità generata.

Classe annidata Classificazioni

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceClassificazioneTesto—vuotoCodice classificazione.
CodiceValoreTesto—vuotoCodice valore.
UltimoLivelloVero/falso—falseUltimo livello.

Classe annidata CaratteristicheTecniche

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

CampoTipoObbligatorioPredefinitoA cosa serve
CaratteristicaTesto—vuotoCaratteristica.
ValoreCaratteristicaTesto—vuotoValore caratteristica.
TipoValoreTesto—vuotoTipo valore.
DescrizioneValoreTesto—vuotoDescrizione valore.
UltimaDataModificaData e ora—nessuna dataUltima data modifica.
UltimoSerialeTesto—vuotoUltimo seriale.
AvvisaSostituzioneVero/falso—falseAvvisa sostituzione.
TipoAvvisoTesto—vuotoTipo avviso.
InizioValoreDecimale—0Inizio valore.
DecorrenzaDecimale—0Decorrenza.
AnticipoAvvisoDecimale—0Anticipo avviso.
GiaAvvisatoVero/falso—falseGia avvisato.
StampaVero/falso—falseStampa.

Classe annidata CaratteristicheTecnicheDotazione

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

CampoTipoObbligatorioPredefinitoA cosa serve
RaggruppamentoTesto—vuotoCodice del raggruppamento. Codice dell'archivio Raggruppamenti dei file.
TipoTesto—vuotoTipo.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.

Classe annidata ComponentiBundle

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceArticoloTesto—vuotoCodice dell'articolo. Codice dell'archivio Articoli.
FormVarTesto—vuotoValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
QtaDecimale—0Quantità.
UnitaMisuraTesto—vuotoCodice dell'unità di misura. Codice dell'archivio Unità di misura.
PercIncidenzaPrezzoDecimale—0Percentuale incidenza prezzo.

Classe annidata UnitaMisuraConversionRate

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

CampoTipoObbligatorioPredefinitoA cosa serve
UnitaDestinazioneTesto—vuotoUnità destinazione.
RapportoDecimale—0Rapporto.
SegnoIntero—0Segno dell'operazione.

Classe annidata ImportoPerSpedizione

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

CampoTipoObbligatorioPredefinitoA cosa serve
ListinoTesto—vuotoCodice del listino. Codice dell'archivio Listini.
ListinoDescrizioneTesto—vuotoDescrizione di Listino, riportata per comodità di chi legge.
ImportoDecimale—0Importo.
GratisDaImportoDecimale—0Gratis da importo.

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": 19,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListProduct": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CategoriaMerceologica": "ESEMPIO",
      "SottocategoriaMerceologica": "ESEMPIO",
      "TipologiaArticolo": 1,
      "Settore": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 19,
  "GuidPC": "gestionale-01",
  "ObjectListProduct": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Prezzi degli articoli

ProductPrice: i prezzi per listino, variante, unità di misura, confezione, quantità e promozione

Prezzi degli articoli: i prezzi per listino, variante, unità di misura, confezione, quantità e promozione. Nel web service è il tipo PRODUCTPRICE (valore 20 di DataType); gli oggetti sono della classe ProductPrice e viaggiano nella lista ObjectListProductPrice della richiesta e della risposta.

Ogni prezzo è una riga identificata da articolo e progressivo. La riga dice a quale listino, variante, unità di misura e confezione si applica, se vale solo in un intervallo di quantità (SpecificaPerQuantita con DaQuantita e AQuantita) e se è un prezzo promozionale, con il periodo e il prezzo pieno da mostrare barrato.

Il progressivo lo decide chi invia: per un articolo con tre prezzi usa 1, 2 e 3. Reinviando lo stesso articolo e progressivo la riga viene aggiornata.

Scheda tecnica

VoceValore
Tipo di datoPRODUCTPRICE = 20
ClasseProductPrice
Lista nella richiesta e nella rispostaObjectListProductPrice
Tabella letta da QUERYPrezziListini — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveArticolo + Progressivo + StringaVariante + Listino + UnitaMisura + Derivato + SpecificaPerQuantita + Package + DaQuantita + AQuantita + InPromozione + CodicePromozione — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassArticolo|Progressivo|StringaVariante|Listino|UnitaMisura|Derivato|SpecificaPerQuantita|Package|DaQuantita|AQuantita|InPromozione|CodicePromozione
Chiave per le conferme di ricezioneArticolo|Progressivo — come si usa

I campi di ProductPrice

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
IDIntero lungo—0idNumero interno della riga di prezzo, assegnato dal server.
ArticoloTestoChiavevuotoarticoloCodice dell'articolo a cui appartiene il prezzo. Codice dell'archivio Articoli.
ProgressivoInteroChiave—progressivoNumero della riga di prezzo per l'articolo: insieme all'articolo identifica la riga.
StringaVarianteTestoChiavevuotoformvarValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
ListinoTestoChiavevuotolistinoCodice del listino. Codice dell'archivio Listini.
ImportoDecimale—0importoPrezzo unitario.
UnitaMisuraTestoChiavevuotoumCodice dell'unità di misura. Codice dell'archivio Unità di misura.
DerivatoVero/falsoChiavefalsederivatoVero se il prezzo è calcolato da un altro listino.
SpecificaPerQuantitaVero/falsoChiavefalsespecqtaVero se il prezzo vale solo tra DaQuantita e AQuantita.
PackageTestoChiavevuotocodpackCodice della confezione (packaging) a cui si applica il prezzo.
DaQuantitaDecimaleChiave0daqtaQuantità minima per cui vale il prezzo.
AQuantitaDecimaleChiave0aqtaQuantità massima per cui vale il prezzo.
InPromozioneVero/falsoChiavefalseinpromoVero se è un prezzo promozionale.
CodicePromozioneTestoChiavevuotocodpromoCodice della promozione.
MostraCountDownVero/falso—falsemostracountdownVero se sul sito compare il conto alla rovescia della promozione.
PromozioneValidaDalData e ora—nessuna datapromovalidadalInizio della promozione.
PromozioneValidaAlData e ora—nessuna datapromovalidaalFine della promozione.
ImportoNoPromoDecimale—0importonopromoPrezzo pieno, da mostrare barrato accanto al prezzo in promozione.
PromoQtaMinimaDecimale—0promoqtaminimaQuantità minima per avere il prezzo promozionale.
PromoQtaMassimaDecimale—0promoqtamassimaQuantità massima a cui si applica il prezzo promozionale.
PromoLegataclienteVero/falso—falselegataclienteVero se la promozione vale solo per i clienti a cui è assegnata.

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": 20,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListProductPrice": [
    {
      "Articolo": "COD001",
      "Progressivo": 1,
      "StringaVariante": "",
      "Listino": "COD002",
      "UnitaMisura": "COD003",
      "Derivato": false,
      "SpecificaPerQuantita": false,
      "Package": "COD004",
      "DaQuantita": 1,
      "AQuantita": 1,
      "InPromozione": false,
      "CodicePromozione": "COD005"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 20,
  "GuidPC": "gestionale-01",
  "ObjectListProductPrice": [
    {
      "Articolo": "COD001",
      "Progressivo": 1,
      "StringaVariante": "",
      "Listino": "COD004",
      "UnitaMisura": "COD005",
      "Derivato": false,
      "SpecificaPerQuantita": false,
      "Package": "COD008",
      "DaQuantita": 1,
      "AQuantita": 1,
      "InPromozione": false,
      "CodicePromozione": "COD0012"
    }
  ]
}

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

Immagini degli articoli

ProductImage: le foto degli articoli e delle varianti, con la foto principale

Immagini degli articoli: le foto degli articoli e delle varianti, con la foto principale. Nel web service è il tipo PRODUCTIMAGE (valore 21 di DataType); gli oggetti sono della classe ProductImage e viaggiano nella lista ObjectListProductImage della richiesta e della risposta.

Ogni immagine è identificata da articolo, stringa della variante (vuota per l'articolo in generale) e indice. Il file viaggia dentro Image in Base64 e il server lo salva nella cartella delle immagini degli articoli. Con FotoDefault scegli la foto principale.

Scheda tecnica

VoceValore
Tipo di datoPRODUCTIMAGE = 21
ClasseProductImage
Lista nella richiesta e nella rispostaObjectListProductImage
Tabella letta da QUERYArticoliImmagini — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveArticolo + StringaVariante + Indice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassArticolo|StringaVariante|Indice
Chiave per le conferme di ricezioneArticolo|StringaVariante|Indice — come si usa
Controlli prima del salvataggioArticolo: «Articolo non specificato»

I campi di ProductImage

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
ArticoloTestoChiave, sìvuotoarticoloCodice dell'articolo. Codice dell'archivio Articoli. Se manca il server risponde «Articolo non specificato».
StringaVarianteTestoChiavevuotoformvarValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
IndiceInteroChiave0indiceNumero d'ordine del file per lo stesso articolo e la stessa variante.
ImageImageTrasmission—oggetto vuoto—Il file dell'immagine: nome e contenuto in Base64.
NomeTesto—vuotonomeNome o didascalia dell'immagine.
CatalogoTesto—vuotocatalogoCatalogo in cui compare l'immagine.
FotoDefaultVero/falso—falsedeffotoVero se è la foto principale.
URLExportFotoTesto—vuotourlexpfotoIndirizzo pubblico del file da usare nelle esportazioni; viene salvato così come lo invii.

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": 21,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListProductImage": [
    {
      "Articolo": "COD001",
      "StringaVariante": "",
      "Indice": 1,
      "Nome": "Esempio",
      "Catalogo": "ESEMPIO",
      "FotoDefault": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 21,
  "GuidPC": "gestionale-01",
  "ObjectListProductImage": [
    {
      "Articolo": "COD001",
      "StringaVariante": "",
      "Indice": 1
    }
  ]
}

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

File degli articoli

ProductFile: schede tecniche, manuali e certificati allegati agli articoli

File degli articoli: schede tecniche, manuali e certificati allegati agli articoli. Nel web service è il tipo PRODUCTFILE (valore 22 di DataType); gli oggetti sono della classe ProductFile e viaggiano nella lista ObjectListProductFile della richiesta e della risposta.

Come le immagini, ma per i documenti: schede tecniche, manuali, certificati, dichiarazioni. Il file viaggia in File in Base64, con un nome da mostrare e il raggruppamento in cui compare nella scheda del prodotto.

Scheda tecnica

VoceValore
Tipo di datoPRODUCTFILE = 22
ClasseProductFile
Lista nella richiesta e nella rispostaObjectListProductFile
Tabella letta da QUERYarticolifileass — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveArticolo + StringaVariante + Indice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassArticolo|StringaVariante|Indice
Chiave per le conferme di ricezioneArticolo|StringaVariante|Indice — come si usa
Controlli prima del salvataggioArticolo: «Articolo non specificato»

I campi di ProductFile

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
ArticoloTestoChiave, sìvuotoarticoloCodice dell'articolo. Codice dell'archivio Articoli. Se manca il server risponde «Articolo non specificato».
StringaVarianteTestoChiavevuotoformvarValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
IndiceInteroChiave0indiceNumero d'ordine del file per lo stesso articolo e la stessa variante.
FileImageTrasmission—oggetto vuoto—Il file: nome e contenuto in Base64.
NomeTesto—vuotonomeNome del file da mostrare sul sito.
RaggruppamentoTesto—vuotocodraggrCodice del raggruppamento in cui compare il file. Codice dell'archivio Raggruppamenti dei file.
URLExportFotoTesto—vuoto—Indirizzo pubblico del file da usare nelle esportazioni; viene salvato così come lo invii.

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": 22,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListProductFile": [
    {
      "Articolo": "COD001",
      "StringaVariante": "",
      "Indice": 1,
      "Nome": "Esempio",
      "Raggruppamento": "ESEMPIO",
      "URLExportFoto": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 22,
  "GuidPC": "gestionale-01",
  "ObjectListProductFile": [
    {
      "Articolo": "COD001",
      "StringaVariante": "",
      "Indice": 1
    }
  ]
}

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

Giacenze per articolo

GiacenzeArticoli: le giacenze lette con i filtri sugli articoli, anche per evento

Giacenze per articolo: le giacenze lette con i filtri sugli articoli, anche per evento. Nel web service è il tipo PRODUCTSTOCK (valore 25 di DataType); gli oggetti sono della classe GiacenzeArticoli e viaggiano nella lista ObjectListGiacenzeArticoli della richiesta e della risposta.

Questo tipo è di sola lettura e restituisce oggetti GiacenzeArticoli, gli stessi di Giacenze: la differenza è che la lettura passa dagli articoli, quindi rispetta i filtri per evento di QueryParameter e un SQLFilter può usare anche le colonne della tabella articoli. Per scrivere le giacenze usa Giacenze.

Scheda tecnica

VoceValore
Tipo di datoPRODUCTSTOCK = 25
ClasseGiacenzeArticoli
Lista nella richiesta e nella rispostaObjectListGiacenzeArticoli
Tabella letta da QUERYGiacenzeArticoli — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3)
Campi chiaveArticolo + StringaVarianti + Deposito — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per le conferme di ricezioneArticolo|StringaVarianti|Deposito — come si usa
Controlli prima del salvataggioArticolo: «Articolo non specificato»
Deposito: «Deposito non specificato»

I campi di GiacenzeArticoli

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
ArticoloTestoChiave, sìvuotocodicearticoloCodice dell'articolo. Codice dell'archivio Articoli. Se manca il server risponde «Articolo non specificato».
StringaVariantiTestoChiavevuotostringavariantiValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
DepositoTestoChiave, sìvuotodepositoCodice del deposito. Codice dell'archivio Depositi. Se manca il server risponde «Deposito non specificato».
EsistenzaDecimale—0esistenzaQuantità fisicamente presente nel deposito.
DisponibilitaDecimale—0disponibilitaQuantità vendibile, al netto di quella impegnata.

Esempi

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

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

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

Giacenze

GiacenzeArticoli: esistenza e disponibilità di ogni articolo e variante per deposito

Giacenze: esistenza e disponibilità di ogni articolo e variante per deposito. Nel web service è il tipo GIACENZEARTICOLI (valore 32 di DataType); gli oggetti sono della classe GiacenzeArticoli e viaggiano nella lista ObjectListGiacenzeArticoli della richiesta e della risposta.

Una riga per articolo, variante e deposito, con esistenza (quello che c'è fisicamente) e disponibilità (quello che si può vendere, al netto dell'impegnato). È il tipo da usare per tenere allineate le quantità del sito o di un marketplace.

Scheda tecnica

VoceValore
Tipo di datoGIACENZEARTICOLI = 32
ClasseGiacenzeArticoli
Lista nella richiesta e nella rispostaObjectListGiacenzeArticoli
Tabella letta da QUERYGiacenzeArticoli — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveArticolo + StringaVarianti + Deposito — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassArticolo|StringaVarianti|Deposito
Chiave per le conferme di ricezioneArticolo|StringaVarianti|Deposito — come si usa
Controlli prima del salvataggioArticolo: «Articolo non specificato»
Deposito: «Deposito non specificato»

I campi di GiacenzeArticoli

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
ArticoloTestoChiave, sìvuotocodicearticoloCodice dell'articolo. Codice dell'archivio Articoli. Se manca il server risponde «Articolo non specificato».
StringaVariantiTestoChiavevuotostringavariantiValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
DepositoTestoChiave, sìvuotodepositoCodice del deposito. Codice dell'archivio Depositi. Se manca il server risponde «Deposito non specificato».
EsistenzaDecimale—0esistenzaQuantità fisicamente presente nel deposito.
DisponibilitaDecimale—0disponibilitaQuantità vendibile, al netto di quella impegnata.

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": 32,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListGiacenzeArticoli": [
    {
      "Articolo": "COD001",
      "StringaVarianti": "",
      "Deposito": "COD002",
      "Esistenza": 1,
      "Disponibilita": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 32,
  "GuidPC": "gestionale-01",
  "ObjectListGiacenzeArticoli": [
    {
      "Articolo": "COD001",
      "StringaVarianti": "",
      "Deposito": "COD003"
    }
  ]
}

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

Statistiche degli articoli

ArticoliStats: i codici degli articoli registrati nelle statistiche del sito

Statistiche degli articoli: i codici degli articoli registrati nelle statistiche del sito. Nel web service è il tipo ARTICOLISTATS (valore 49 di DataType); gli oggetti sono della classe ArticoliStats e viaggiano nella lista ObjectListArticoliStats della richiesta e della risposta.

Tipo di sola scrittura: non si legge con QUERY.

Scheda tecnica

VoceValore
Tipo di datoARTICOLISTATS = 49
ClasseArticoliStats
Lista nella richiesta e nella rispostaObjectListArticoliStats
Operazioni ammesseINSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Controlli prima del salvataggioCodice: «Codice non specificato»

I campi di ArticoliStats

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».

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": 49,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListArticoliStats": [
    {
      "Codice": "COD001"
    }
  ]
}

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 49,
  "GuidPC": "gestionale-01",
  "ObjectListArticoliStats": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Raggruppamenti dei file

RaggruppamentoFile: i gruppi in cui si ordinano i file allegati agli articoli

Raggruppamenti dei file: i gruppi in cui si ordinano i file allegati agli articoli. Nel web service è il tipo RAGGRUPPAMENTOFILE (valore 95 di DataType); gli oggetti sono della classe RaggruppamentoFile e viaggiano nella lista ObjectListRaggruppamentoFile della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoRAGGRUPPAMENTOFILE = 95
ClasseRaggruppamentoFile
Lista nella richiesta e nella rispostaObjectListRaggruppamentoFile
Tabella letta da QUERYRaggruppamentoFile — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di RaggruppamentoFile

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 95,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListRaggruppamentoFile": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 95,
  "GuidPC": "gestionale-01",
  "ObjectListRaggruppamentoFile": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Promozioni

Promozioni: le promozioni con periodo di validità

Promozioni: le promozioni con periodo di validità. Nel web service è il tipo PROMOZIONI (valore 117 di DataType); gli oggetti sono della classe Promozioni e viaggiano nella lista ObjectListPromozioni della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoPROMOZIONI = 117
ClassePromozioni
Lista nella richiesta e nella rispostaObjectListPromozioni
Tabella letta da QUERYPromozioni — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Promozioni

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ImageImageTrasmission—null—Immagine, come file in Base64.
DescrizioneDettagliataTesto—vuotodescrizionedettDescrizione estesa, anche in HTML.
ValidaDalData e ora—nessuna datavalidadalValida dal.
ValidaAlData e ora—nessuna datavalidaalValida al.
ListinoTesto—vuotolistinoCodice del listino. Codice dell'archivio Listini.
MostraCountDownVero/falso—falsemostracountdownVero se sul sito compare il conto alla rovescia della promozione.
ProdottiInclusiElenco di PromozioniCorpo—elenco vuoto—Prodotti inclusi: elenco di oggetti PromozioniCorpo.

Classe annidata PromozioniCorpo

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceArticoloTesto—vuotoCodice dell'articolo. Codice dell'archivio Articoli.
UnitaMisuraTesto—vuotoCodice dell'unità di misura. Codice dell'archivio Unità di misura.
StringaVariantiTesto—vuotoValori della variante, separati come nel gestionale; vuoto per l'articolo senza variante.
TipoCalcoloTesto—vuotoModalità di calcolo.
TipoIncrementoDecrementoTesto—vuotoTipo incremento decremento.
Valore1Decimale—0Valore 1.
Valore2Decimale—0Valore 2.
QtaMinimaDecimale—0Quantità minima.
QtaMassimaDecimale—0Quantità massima.
LegataClienteVero/falso—falseLegata cliente.
ApplicataATutteVariantiVero/falso—falseApplicata a tutte varianti.
PercentualeProvvigioneDecimale—0Percentuale provvigione.

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": 117,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListPromozioni": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "DescrizioneDettagliata": "Descrizione di esempio",
      "ValidaDal": "2026-03-15T00:00:00",
      "ValidaAl": "2026-03-15T00:00:00",
      "Listino": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 117,
  "GuidPC": "gestionale-01",
  "ObjectListPromozioni": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Unità di misura

UnitaMisura: le unità di misura degli articoli

Unità di misura: le unità di misura degli articoli. Nel web service è il tipo UNITAMISURA (valore 123 di DataType); gli oggetti sono della classe UnitaMisura e viaggiano nella lista ObjectListUnitaMisura della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUNITAMISURA = 123
ClasseUnitaMisura
Lista nella richiesta e nella rispostaObjectListUnitaMisura
Tabella letta da QUERYUnitaMisura — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di UnitaMisura

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 123,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUnitaMisura": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 123,
  "GuidPC": "gestionale-01",
  "ObjectListUnitaMisura": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie provvigionali

CategoriaProvvigionale: le categorie con cui si calcolano le provvigioni

Categorie provvigionali: le categorie con cui si calcolano le provvigioni. Nel web service è il tipo CATEGORIAPROVVIGIONALE (valore 125 di DataType); gli oggetti sono della classe CategoriaProvvigionale e viaggiano nella lista ObjectListCategoriaProvvigionale della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCATEGORIAPROVVIGIONALE = 125
ClasseCategoriaProvvigionale
Lista nella richiesta e nella rispostaObjectListCategoriaProvvigionale
Tabella letta da QUERYcategorieprov — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CategoriaProvvigionale

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ValidoDalData e ora—nessuna datadadataInizio del periodo di validità.
ValidoAlData e ora—nessuna dataadataFine del periodo di validità.
PercentualeDecimale—0percPercentuale.

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": 125,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCategoriaProvvigionale": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ValidoDal": "2026-03-15T00:00:00",
      "ValidoAl": "2026-03-15T00:00:00",
      "Percentuale": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 125,
  "GuidPC": "gestionale-01",
  "ObjectListCategoriaProvvigionale": [
    {
      "Codice": "COD001"
    }
  ]
}

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

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.

Tipi di documento

DocumentType: le tipologie di documento con serie, registri e comportamento

Tipi di documento: le tipologie di documento con serie, registri e comportamento. Nel web service è il tipo DOCUMENTTYPE (valore 24 di DataType); gli oggetti sono della classe DocumentType e viaggiano nella lista ObjectListDocumentType della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDOCUMENTTYPE = 24
ClasseDocumentType
Lista nella richiesta e nella rispostaObjectListDocumentType
Tabella letta da QUERYTipologieDocumenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DocumentType

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ConsideraScontiPerAggiornamentoPrezziListinoVero/falso—false—Considera sconti per aggiornamento prezzi listino.
RegistroDiDefaultTesto—vuoto—Registro di predefinito.
InviaEmailRientroDisponibilitaPerPrenotazioniVero/falso—false—Invia email rientro disponibilità per prenotazioni.
ChiediInviaEmailRientroDisponibilitaPerPrenotazioniVero/falso—false—Chiedi invia email rientro disponibilità per prenotazioni.
PrintCartelliniVero/falso—false—Print cartellini.
PrintCartelliniUnoPerRigaVero/falso—false—Print cartellini uno per riga.
PrintCartelliniChiediVero/falso—false—Print cartellini chiedi.
PrintCartelliniListinoTesto—vuoto—Print cartellini listino.
AvvisaDoppioInserimentoVero/falso—falseavvisadoppioinsAvvisa doppio inserimento.
TipoDocProponiBarcodeVero/falso—falseproponibarcodeTipo doc proponi barcode.
TipoDocNumerazioneAutoVero/falso—falseindnumautoTipo doc numerazione auto.
TipoDocNumerazioneAutoCodProgressivoTesto—vuotonumautoprogrTipo doc numerazione auto codice progressivo.
TipoDocProtocollazioneAutoVero/falso—falseindprotocolloTipo doc protocollazione auto.
TipoDocProtocollazioneCodProgressivoTesto—vuotoprotocolloprogrTipo doc protocollazione codice progressivo.
TipoDocControllaConsecutivitaDataVero/falso—falseindcontrdataTipo doc controlla consecutivita data.
TipoDocCollegaFlussiVero/falso—falsecollegaflussiTipo doc collega flussi.
TipoDocCollegaFlussiSchemaTesto—vuotocollegaflussischemaTipo doc collega flussi schema.
TipoDocCollegaFlussiFaseIntero—0collegaflussifaseTipo doc collega flussi fase.
TipoDocCollegaFlussiValoreIntero—0collegaflussivaloreTipo doc collega flussi valore.
TipoDocCollegaFlussiIncFaseIntero—0collegaflussiincfaseTipo doc collega flussi inc fase.
TipoDocCollegaFlussiIncValoreIntero—0collegaflussiincvaloreTipo doc collega flussi inc valore.
TipoDocCollegaFlussiIncChiudiIntero—0collegaflussiincchiudiTipo doc collega flussi inc chiudi.
TipoDocCausaleMagazzinoTesto—vuotocmagTipo doc causale magazzino.
TipoDocCausaleMagazzinoGeneraDocumentoTesto—vuotocmaggendocTipo doc causale magazzino genera documento.
TipoDocCausaleContabileTesto—vuotoccontTipo doc causale contabile.
TipoDocDefNoteTesto—vuotodefnoteTipo doc predefinito note.
TipoDocDefAspettoBeniTesto—vuotodefaspettoTipo doc predefinito aspetto beni.
TipoDocDefCausaleTrasportoTesto—vuotodefcausaleTipo doc predefinito causale trasporto.
TipoDocDefTrasportoAMezzoTesto—vuotodefamezzoTipo doc predefinito trasporto a mezzo.
TipoDocDefPortoTesto—vuotodefportoTipo doc predefinito porto.
TipoDocDefSpedizioniere1Testo—vuotodefsped1Tipo doc predefinito spedizioniere 1.
TipoDocDefSpedizioniere2Testo—vuotodefsped2Tipo doc predefinito spedizioniere 2.
TipoDocDefSerieTesto—vuotoseriedefaultTipo doc predefinito serie.
TipoDocDefProponiDataOraVero/falso—falsedefproponiTipo doc predefinito proponi data ora.
TipoDocDefNumCopieIntero—0numcopiedefTipo doc predefinito numero copie.
TipoDocDefStatoDocumentoTesto—vuotostatodocTipo doc predefinito stato documento.
TipoDocDefSezioneContabileTesto—vuotosezionecontTipo doc predefinito sezione contabile.
TipoDocChangeStatoControparteVero/falso—falsecambiaanagdopoTipo doc change stato controparte.
TipoDocChangeStatoControparteCodiceTesto—vuototipoanagdopoTipo doc change stato controparte codice.
TipoDocDefCodiceIVATesto—vuotocodivadefTipo doc predefinito codice IVA.
CodiceDocumentoFatturaPATesto—vuotocodtipodocfattpaCodice documento fattura PA.
CodiceDocumentoFormatoDIFTesto—vuotocoddifCodice documento formato DIF.
BloccaNumerazioneVero/falso—falsebloccanumerazioneBlocca numerazione.
BloccaProtocollazioneVero/falso—falsebloccaprotocollazioneBlocca protocollazione.
AddebitaPerCategorieMerceologicheVero/falso—falseaddebcatmercAddebita per categorie merceologiche.
AbilitaAvvisoDiRitiroVero/falso—falseabilitaavvisoritiroAbilita avviso di ritiro.
AvvisaPrezziAZeroVero/falso—falseavvisaprezzizeroAvvisa prezzi a zero.
AvvisaPrezziAZeroBloccaInserimentoVero/falso—falsebloccaprezzizeroAvvisa prezzi a zero blocca inserimento.
ModelloStampaPerEmailTesto—vuotomodellomailModello stampa per email.
StampaDescrizioneMacchinaSuCorpoDocumentoVero/falso—falsestampadescrmacchinaStampa descrizione macchina su corpo documento.
StampaCaratteristicheTecnicheSuCorpoDocumentoVero/falso—falsestampacartecStampa caratteristiche tecniche su corpo documento.
CausaleContabileObbligatoriaVero/falso—falsecauscontabileobbligatoriaCausale contabile obbligatoria.
VerificaEsistenzaValoriFatturaElettronicaVero/falso—falsecontrollaesistenzariffeVerifica esistenza valori fattura elettronica.
BloccaInserimentoSenzaValoriFatturaElettronicaVero/falso—falsebloccainserimentosenzafeBlocca inserimento senza valori fattura elettronica.
NonGenerareRigaDichiarazioneIntentoVero/falso—falsenongenrigadichiarazioniintentoNon generare riga dichiarazione intento.
NonStampareDescrizioneRigaVero/falso—falsenonstamparedescrizionerigaNon stampare descrizione riga.
EscludiControlloBolliVero/falso—falseescludicontrollobolliEscludi controllo bolli.
ControparteDefaultTesto——contropartedefControparte predefinito.
EscludiImpostaDiConsumoVero/falso—falseescludiimpostadiconsumoEscludi imposta di consumo.
EmailSostitutivaPerInvioTesto—vuotoemailsostinvioEmail sostitutiva per invio.
DepositoDiDafaultTesto—vuotodepositodefDeposito di dafault.
AttivaControlloImpostaDiCosumoVero/falso—falsecontrollaimpostaconsumoAttiva controllo imposta di cosumo.
DisattivaMessaggiInsolutoNonBloccantiVero/falso—falsedismessnonblocinsolutoDisattiva messaggi insoluto non bloccanti.

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": 24,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDocumentType": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "ConsideraScontiPerAggiornamentoPrezziListino": false,
      "RegistroDiDefault": "ESEMPIO",
      "InviaEmailRientroDisponibilitaPerPrenotazioni": false,
      "ChiediInviaEmailRientroDisponibilitaPerPrenotazioni": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 24,
  "GuidPC": "gestionale-01",
  "ObjectListDocumentType": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Stati del documento

StatoDocumento: gli stati di avanzamento dei documenti, come in lavorazione o spedito

Stati del documento: gli stati di avanzamento dei documenti, come in lavorazione o spedito. Nel web service è il tipo STATODOCUMENTO (valore 26 di DataType); gli oggetti sono della classe StatoDocumento e viaggiano nella lista ObjectListStatoDocumento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSTATODOCUMENTO = 26
ClasseStatoDocumento
Lista nella richiesta e nella rispostaObjectListStatoDocumento
Tabella letta da QUERYStatoDocumento — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di StatoDocumento

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 26,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListStatoDocumento": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 26,
  "GuidPC": "gestionale-01",
  "ObjectListStatoDocumento": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Raggruppamenti statistici

RaggruppamentoStatistico: i raggruppamenti con cui si analizzano i documenti

Raggruppamenti statistici: i raggruppamenti con cui si analizzano i documenti. Nel web service è il tipo RAGGRUPPAMENTOSTATISTICO (valore 28 di DataType); gli oggetti sono della classe RaggruppamentoStatistico e viaggiano nella lista ObjectListRaggruppamentoStatistico della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoRAGGRUPPAMENTOSTATISTICO = 28
ClasseRaggruppamentoStatistico
Lista nella richiesta e nella rispostaObjectListRaggruppamentoStatistico
Tabella letta da QUERYRaggruppamentoStatisticoDocumento — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di RaggruppamentoStatistico

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 28,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListRaggruppamentoStatistico": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 28,
  "GuidPC": "gestionale-01",
  "ObjectListRaggruppamentoStatistico": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Canali di ricevimento

CanaleRicevimentoDocumento: i canali da cui arriva un documento, come sito, telefono o agente

Canali di ricevimento: i canali da cui arriva un documento, come sito, telefono o agente. Nel web service è il tipo CANALERICEVIMENTODOCUMENTO (valore 29 di DataType); gli oggetti sono della classe CanaleRicevimentoDocumento e viaggiano nella lista ObjectListCanaleRicevimentoDocumento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCANALERICEVIMENTODOCUMENTO = 29
ClasseCanaleRicevimentoDocumento
Lista nella richiesta e nella rispostaObjectListCanaleRicevimentoDocumento
Tabella letta da QUERYCanaleRicevimentoDocumento — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CanaleRicevimentoDocumento

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 29,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCanaleRicevimentoDocumento": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 29,
  "GuidPC": "gestionale-01",
  "ObjectListCanaleRicevimentoDocumento": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Righe predefinite

RighePredefinitePerDoc: le righe che si aggiungono da sole ai documenti

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

VoceValore
Tipo di datoRIGHEPREDEFINITEPERDOC = 45
ClasseRighePredefinitePerDoc
Lista nella richiesta e nella rispostaObjectListRighePredefiniteDoc
Tabella letta da QUERYRighePerDoc — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «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.

CampoTipoObbligatorioPredefinitoColonnaA cosa serve
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
TipoRigaTesto—vuototiporigaTipo della riga.
ImportoDecimale—0importoImporto.
IVAInclusaVero/falso—falseivainclusaVero se gli importi comprendono l'IVA.
CodiceIVATesto—vuotocodiceivaCodice 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.

Zone di spedizione

ZoneSpedizione: le zone geografiche usate per calcolare le spedizioni

Zone di spedizione: le zone geografiche usate per calcolare le spedizioni. Nel web service è il tipo METODOSPEDIZIONEZONE (valore 50 di DataType); gli oggetti sono della classe ZoneSpedizione e viaggiano nella lista ObjectListMetodoSpedizioneZone della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoMETODOSPEDIZIONEZONE = 50
ClasseZoneSpedizione
Lista nella richiesta e nella rispostaObjectListMetodoSpedizioneZone
Tabella letta da QUERYMetodoSpedizioneZone — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»

I campi di ZoneSpedizione

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
TipoConfigurazioneTesto—vuototipoconfTipo configurazione.
ElencoNazioniElenco di Testo—elenco vuotonazioneElenco nazioni.
ElencoRegioniElenco di Testo—elenco vuotoregioneElenco regioni.
ElencoCAPElenco di Testo—elenco vuotocapElenco CAP.

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": 50,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListMetodoSpedizioneZone": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "TipoConfigurazione": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 50,
  "GuidPC": "gestionale-01",
  "ObjectListMetodoSpedizioneZone": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Metodi di spedizione

MetodoSpedizione: i metodi di spedizione con costi per peso, importo e destinazione

Metodi di spedizione: i metodi di spedizione con costi per peso, importo e destinazione. Nel web service è il tipo METODOSPEDIZIONE (valore 51 di DataType); gli oggetti sono della classe MetodoSpedizione e viaggiano nella lista ObjectListMetodoSpedizione della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoMETODOSPEDIZIONE = 51
ClasseMetodoSpedizione
Lista nella richiesta e nella rispostaObjectListMetodoSpedizione
Tabella letta da QUERYMetodoSpedizione — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»

I campi di MetodoSpedizione

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
DescrizioneDettagliataTesto—vuotodescrizionedettDescrizione estesa, anche in HTML.
NoteTesto—vuotonoteNote libere.
IconaImageTrasmission—oggetto vuoto—Icona.
CodiceIVATesto—vuotocodiceivaCodice IVA. Codice dell'archivio Codici IVA.
IVAInclusaVero/falso—falseivainclusaVero se gli importi comprendono l'IVA.
GiorniStimatoPreparazioneIntero—0giornistimatopreparazioneGiorni stimato preparazione.
GiorniStimatoConsegnaIntero—0giornistimatoconsegnaGiorni stimato consegna.
TipoGestioneTesto—"I"tipogestioneTipo gestione.
RitiroPressoNSDepositoVero/falso——ritiropressonsdepositoRitiro presso NS deposito.
AbilitaClienteGestitoDirettamenteVero/falso—falseabilitaclientegestitoAbilita cliente gestito direttamente.
ListaMetodoSpedizioneImportiElenco di MetodoSpedizioneImporti—elenco vuoto—Metodo spedizione importi: elenco di oggetti MetodoSpedizioneImporti.

Classe annidata MetodoSpedizioneImporti

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

CampoTipoObbligatorioPredefinitoA cosa serve
ListinoTesto—vuotoCodice del listino. Codice dell'archivio Listini.
ZonaTesto—vuotoZona. Codice dell'archivio Zone.
ProgressivoIntero—0Numero progressivo della riga all'interno del record principale.
DaDecimale—0Da.
ADecimale—0A.
ImportoDecimale—0Importo.

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": 51,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListMetodoSpedizione": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "DescrizioneDettagliata": "Descrizione di esempio",
      "Note": "ESEMPIO",
      "CodiceIVA": "COD002",
      "IVAInclusa": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 51,
  "GuidPC": "gestionale-01",
  "ObjectListMetodoSpedizione": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Buoni sconto

BuoniSconti: i buoni sconto con importo, validità e utilizzi

Buoni sconto: i buoni sconto con importo, validità e utilizzi. Nel web service è il tipo BUONISCONTI (valore 52 di DataType); gli oggetti sono della classe BuoniSconti e viaggiano nella lista ObjectListBuoniSconti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoBUONISCONTI = 52
ClasseBuoniSconti
Lista nella richiesta e nella rispostaObjectListBuoniSconti
Tabella letta da QUERYBuonoSconto — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
ValidoDal: «Data inizio validità non specificata»
ValidoAl: «Data fine validità non specificata»
Descrizione: «Descrizione non specificato»

I campi di BuoniSconti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
ValidoDalData e oraSìnessuna datavalidodalInizio del periodo di validità. Se manca il server risponde «Data inizio validità non specificata».
ValidoAlData e oraSìnessuna datavalidoalFine del periodo di validità. Se manca il server risponde «Data fine validità non specificata».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoCalcoloTesto—vuototipocalcoloModalità di calcolo.
TipoCalcoloValoreDecimale—0tipocalcolovaloreTipo calcolo valore.
ReiterativitaTesto—vuotoreiterativitaReiterativita.
ReiterativitaNumeroVolteIntero—0reiterativitanumerovolteReiterativita numero volte.
TipoAbilitazioneTesto—vuototipoabilitazioneTipo abilitazione.
ApplicaSoloAMerceVero/falso—falseapplicasoloamerceApplica solo a merce.
ListaClientiElenco di Testo—elenco vuotoclienteElenco clienti.

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": 52,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListBuoniSconti": [
    {
      "Codice": "COD001",
      "ValidoDal": "2026-03-15T00:00:00",
      "ValidoAl": "2026-03-15T00:00:00",
      "Descrizione": "Descrizione di esempio",
      "TipoCalcolo": "ESEMPIO",
      "TipoCalcoloValore": 1,
      "Reiterativita": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 52,
  "GuidPC": "gestionale-01",
  "ObjectListBuoniSconti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

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.

Causali di trasporto

TrasportoCausale: le causali del trasporto, come vendita o reso

Causali di trasporto: le causali del trasporto, come vendita o reso. Nel web service è il tipo TRASPORTOCAUSALE (valore 118 di DataType); gli oggetti sono della classe TrasportoCausale e viaggiano nella lista ObjectListTrasportoCausale della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTRASPORTOCAUSALE = 118
ClasseTrasportoCausale
Lista nella richiesta e nella rispostaObjectListTrasportoCausale
Tabella letta da QUERYtraspcausali — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TrasportoCausale

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoMovimentoPMTesto—vuototipomovpmTipo movimento PM.

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": 118,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTrasportoCausale": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "TipoMovimentoPM": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 118,
  "GuidPC": "gestionale-01",
  "ObjectListTrasportoCausale": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Mezzi di trasporto

TrasportoMezzo: chi trasporta la merce: mittente, destinatario, vettore

Mezzi di trasporto: chi trasporta la merce: mittente, destinatario, vettore. Nel web service è il tipo TRASPORTOMEZZO (valore 119 di DataType); gli oggetti sono della classe TrasportoMezzo e viaggiano nella lista ObjectListTrasportoMezzo della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTRASPORTOMEZZO = 119
ClasseTrasportoMezzo
Lista nella richiesta e nella rispostaObjectListTrasportoMezzo
Tabella letta da QUERYtraspmezzi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TrasportoMezzo

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 119,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTrasportoMezzo": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 119,
  "GuidPC": "gestionale-01",
  "ObjectListTrasportoMezzo": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Porti

TrasportoPorto: il porto della spedizione, franco o assegnato

Porti: il porto della spedizione, franco o assegnato. Nel web service è il tipo TRASPORTOPORTO (valore 120 di DataType); gli oggetti sono della classe TrasportoPorto e viaggiano nella lista ObjectListTrasportoPorto della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTRASPORTOPORTO = 120
ClasseTrasportoPorto
Lista nella richiesta e nella rispostaObjectListTrasportoPorto
Tabella letta da QUERYtraspporto — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TrasportoPorto

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 120,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTrasportoPorto": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 120,
  "GuidPC": "gestionale-01",
  "ObjectListTrasportoPorto": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Spedizionieri

Spedizioniere: i corrieri e gli spedizionieri con i loro dati

Spedizionieri: i corrieri e gli spedizionieri con i loro dati. Nel web service è il tipo SPEDIZIONIERE (valore 124 di DataType); gli oggetti sono della classe Spedizioniere e viaggiano nella lista ObjectListSpedizioniere della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSPEDIZIONIERE = 124
ClasseSpedizioniere
Lista nella richiesta e nella rispostaObjectListSpedizioniere
Tabella letta da QUERYSpedizionieri — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
RagioneSociale: «Ragione sociale non specificato»

I campi di Spedizioniere

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
RagioneSocialeTestoSìvuotoragsocialeRagione sociale. Se manca il server risponde «Ragione sociale non specificato».
PartitaIVATesto—vuotopivaPartita IVA.
CodiceFiscaleTesto—vuotocodfiscaleCodice fiscale.
IndirizzoTesto—vuotoindirizzoIndirizzo (via e numero civico).
CAPTesto—vuotocapCodice di avviamento postale.
CittaTesto—vuotocittaCittà.
ProvinciaTesto—vuotoprovSigla della provincia.
RegioneTesto—vuotoregioneRegione.
Telefono1Testo—vuototelefono1Primo numero di telefono.
Telefono2Testo—vuototelefono2Secondo numero di telefono.
CellulareTesto—vuotocellNumero di cellulare.
FaxTesto—vuotofaxNumero di fax.
Email1Testo—vuotoemail1Primo indirizzo email.
Email2Testo—vuotoemail2Secondo indirizzo email.
AutistaTesto—vuotoautistaAutista.
CodiceAutorizzazioneMinisterialeTesto—vuotocodautminCodice autorizzazione ministeriale.
IndirizzoLatitudineDecimale—0indirizzolatIndirizzo latitudine.
IndirizzoLongitudineDecimale—0indirizzolongIndirizzo longitudine.
FotoImageTrasmission—oggetto vuoto—Fotografia, come file in Base64.

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": 124,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListSpedizioniere": [
    {
      "Codice": "COD001",
      "RagioneSociale": "Esempio",
      "PartitaIVA": "ESEMPIO",
      "CodiceFiscale": "COD002",
      "Indirizzo": "ESEMPIO",
      "CAP": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 124,
  "GuidPC": "gestionale-01",
  "ObjectListSpedizioniere": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Dipendenti

Dipendenti: dipendenti, commessi e agenti, con i loro dati

Dipendenti: dipendenti, commessi e agenti, con i loro dati. Nel web service è il tipo DIPENDENTI (valore 30 di DataType); gli oggetti sono della classe Dipendenti e viaggiano nella lista ObjectListDipendenti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDIPENDENTI = 30
ClasseDipendenti
Lista nella richiesta e nella rispostaObjectListDipendenti
Tabella letta da QUERYDipendenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Nome: «Nome non specificato»
Cognome: «Cognome non specificato»

I campi di Dipendenti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
NomeTestoSìvuotonomeNome. Se manca il server risponde «Nome non specificato».
CognomeTestoSìvuotocognomeCognome. Se manca il server risponde «Cognome non specificato».
DataAssunzioneData e ora—nessuna datadataassData assunzione.
DataFineRapportoData e ora—nessuna datadatafineData fine rapporto.
Telefono1Testo—vuototelefono1Primo numero di telefono.
Telefono2Testo—vuototelefono1Secondo numero di telefono.
CellulareTesto—vuotocellNumero di cellulare.
FaxTesto—vuotofaxNumero di fax.
Email1Testo—vuotoemail1Primo indirizzo email.
Email2Testo—vuotoemail2Secondo indirizzo email.
CLSIDTesto—vuotoclsidCLSID.
ResponsabileVero/falso—falseresponsabileResponsabile.
DepositoDefaultTesto—vuotodepositodefDeposito predefinito.
CodiceBarreTesto—vuotocodabarreCodice barre.
RuoloAgenteVero/falso—falseruoloagenteRuolo agente.
RuoloCommessoVero/falso—falseruolocommessoRuolo commesso.
RuoloAmministrativoVero/falso—falseruoloamministrativoRuolo amministrativo.
RuoloCapoareaVero/falso—falseruolocapoareaRuolo capoarea.
RuoloTecnicoVero/falso—falseruolotecnicoRuolo tecnico.
RuoloFunzionarioVero/falso—falseruolofunzionarioRuolo funzionario.
PECTesto—vuotopecIndirizzo di posta elettronica certificata.
PIvaTesto—vuotopivaP IVA.
UsernameTesto—vuotousernameNome utente.
PasswordTesto—vuotopasswordPassword.
SerieWEBTesto—vuotoseriewebSerie web.
SoloVisualizzazioneVero/falso—falsewebsolovisualizzazioneSolo visualizzazione.
IndirizzoTesto—vuotoindirizzoIndirizzo (via e numero civico).
IndirizzoLatitudineDecimale—0indirizzolatIndirizzo latitudine.
IndirizzoLongitudineDecimale—0indirizzolongIndirizzo longitudine.
RegioneTesto—vuotoregioneRegione.
CAPTesto—vuotocapCodice di avviamento postale.
CittaTesto—vuotocittaCittà.
ProvinciaTesto—vuotoprovSigla della provincia.
FotoImageTrasmission—oggetto vuoto—Fotografia, come file in Base64.
DomicilioIndirizzoTesto—vuotoindirizzodomDomicilio indirizzo.
DomicilioIndirizzoLatitudineDecimale—0indirizzolatdomDomicilio indirizzo latitudine.
DomicilioIndirizzoLongitudineDecimale—0indirizzolongdomDomicilio indirizzo longitudine.
DomicilioRegioneTesto—vuotoregionedomDomicilio regione.
DomicilioCAPTesto—vuotocapdomDomicilio CAP.
DomicilioCittaTesto—vuotocittadomDomicilio città.
DomicilioProvinciaTesto—vuotoprovdomDomicilio provincia.
IBANTesto—vuotoibanIBAN.
CapNascitaTesto—vuotocapnascCAP nascita.
CittaNascitaTesto—vuotocittanascCittà nascita.
ProvinciaNascitaTesto—vuotoprovnascProvincia nascita.
DataDiNascitaData e ora—nessuna datadatanascData di nascita.
SessoTesto—vuotosessoSesso.
CodiceFiscaleTesto—vuotocodicefiscaleCodice fiscale.
TitoloTesto—vuototitoloTitolo.
RepartoTesto—vuotorepartoReparto. Codice dell'archivio Reparti.
CostoOraDecimale—0costooraCosto ora.
IDSigilloTesto—vuotoidsigilloID sigillo.
IDNumeroSigilloTesto—vuotoidnumsigilloID numero sigillo.
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
AccountTesto—vuotoaccountAccount.
ExportPalmareVero/falso—falseexportpalmareExport palmare.
ListDipendentiCondizioniEconomicheDipendentiCondizioniEconomiche—oggetto vuoto—Elenco dipendenti condizioni economiche.
ListDipendentiCondizioniEconomicheCategorieProvvigionaliElenco di DipendentiCondizioniEconomicheCategorieProvvigionali—elenco vuoto—Dipendenti condizioni economiche categorie provvigionali: elenco di oggetti DipendentiCondizioniEconomicheCategorieProvvigionali.
ListDipendentiCondizioniEconomicheScaglioniElenco di DipendentiCondizioniEconomicheScaglioni—elenco vuoto—Dipendenti condizioni economiche scaglioni: elenco di oggetti DipendentiCondizioniEconomicheScaglioni.
ListDipendentiImportOrdiniElenco di DipendentiImportOrdini—elenco vuoto—Dipendenti import ordini: elenco di oggetti DipendentiImportOrdini.
ListDipendentiListiniAssociatiElenco di Testo—elenco vuotocodlistinoElenco dipendenti listini associati.
ListDipendentiAttestatiElenco di Testo—elenco vuotocodattestatiElenco dipendenti attestati.
ListDipendentiContrattiElenco di DipendentiContratti—elenco vuoto—Dipendenti contratti: elenco di oggetti DipendentiContratti.
ListDipendentiFerieElenco di DipendentiFerie—elenco vuoto—Dipendenti ferie: elenco di oggetti DipendentiFerie.
ListDipendentiComunicazioniElenco di DipendentiComunicazioni—elenco vuoto—Dipendenti comunicazioni: elenco di oggetti DipendentiComunicazioni.

Classe annidata DipendentiCondizioniEconomiche

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoCalcoloTesto—vuotoModalità di calcolo.
TipoMaturazioneTesto—vuotoTipo maturazione.
BonusAcquisizioneClientiVero/falso—falseBonus acquisizione clienti.
BonusAcquisizioneClientiNumeroClientiIntero—0Bonus acquisizione clienti numero clienti.
BonusAcquisizioneClientiImportoNumeroClientiDecimale—0Bonus acquisizione clienti importo numero clienti.

Classe annidata DipendentiCondizioniEconomicheCategorieProvvigionali

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

CampoTipoObbligatorioPredefinitoA cosa serve
CategoriaProvvigionaleTesto—vuotoCategoria provvigionale. Codice dell'archivio Categorie provvigionali.
PercentualeDecimale—0Percentuale.
DaPercentualeScontoDecimale—0Da percentuale sconto.
APercentualeScontoDecimale—0A percentuale sconto.

Classe annidata DipendentiCondizioniEconomicheScaglioni

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

CampoTipoObbligatorioPredefinitoA cosa serve
DaImportoDecimale—0Da importo.
AImportoDecimale—0A importo.
PercentualeDecimale—0Percentuale.

Classe annidata DipendentiImportOrdini

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoTesto—vuotoTipo.
DepositoTesto—vuotoCodice del deposito. Codice dell'archivio Depositi.

Classe annidata DipendentiContratti

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataContrattoData e ora—nessuna dataData contratto.
DataInizioData e ora—nessuna dataData di inizio.
DataFineData e ora—nessuna dataData di fine.
DataAvvisoData e ora—nessuna dataData avviso.
NonAvvisareVero/falso—falseNon avvisare.
RiferimentoNumeroTesto—vuotoRiferimento numero.
TipologiaContrattoTesto—vuotoTipologia contratto.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
ListaFileAllegatiElenco di ImageTrasmission—elenco vuotoFile allegati.

Classe annidata DipendentiFerie

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoTesto—"f"Tipo.
DaDataData e ora—nessuna dataDa data.
ADataData e ora—nessuna dataA data.
DaOraData e ora—nessuna dataOra di inizio.
AOraData e ora—nessuna dataOra di fine.
MotivoTesto—vuotoMotivo.
MotivoDescrizioneTesto—vuotoDescrizione di Motivo, riportata per comodità di chi legge.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
ListaFileAllegatiElenco di ImageTrasmission—elenco vuotoFile allegati.

Classe annidata DipendentiComunicazioni

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataData e ora—nessuna dataData.
TitoloTesto—vuotoTitolo.
CorpoTesto—vuotoCorpo.
ListaFileAllegatiElenco di ImageTrasmission—elenco vuotoFile allegati.

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": 30,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDipendenti": [
    {
      "Codice": "COD001",
      "Nome": "Esempio",
      "Cognome": "ESEMPIO",
      "DataAssunzione": "2026-03-15T00:00:00",
      "DataFineRapporto": "2026-03-15T00:00:00",
      "Telefono1": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 30,
  "GuidPC": "gestionale-01",
  "ObjectListDipendenti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Clienti e fornitori

ClientiFornitori: l'anagrafica completa di clienti e fornitori, con referenti, dati bancari e condizioni

Clienti e fornitori: l'anagrafica completa di clienti e fornitori, con referenti, dati bancari e condizioni. Nel web service è il tipo CLIENTIFORNITORI (valore 34 di DataType); gli oggetti sono della classe ClientiFornitori e viaggiano nella lista ObjectListClientiFornitori della richiesta e della risposta.

La chiave è formata da codice e tipo (C cliente, F fornitore). Oltre all'anagrafica con sede legale e operativa, la classe porta referenti, privacy e consensi, condizioni commerciali (pagamento, listino, sconti, fido), dati bancari, dati per la pubblica amministrazione, documento di riconoscimento e gli elenchi di referenti, dichiarazioni d'intento, accordi commerciali, sconti legati a condizione e allegati.

Scheda tecnica

VoceValore
Tipo di datoCLIENTIFORNITORI = 34
ClasseClientiFornitori
Lista nella richiesta e nella rispostaObjectListClientiFornitori
Tabella letta da QUERYclientifornitori — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice + Tipo + Progressivo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice|Tipo|Progressivo
Chiave per le conferme di ricezioneTipo|Codice — come si usa

I campi di ClientiFornitori

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
CodiceTestoChiavevuotocodiceCodice del cliente o del fornitore.
TipoTestoChiavevuototipoC per cliente, F per fornitore.
ProgressivoInteroChiave——Progressivo dell'anagrafica.
TipologiaSoggettoTesto—vuototiposoggTipo di soggetto: persona fisica o giuridica.
RagioneSocialeTesto—vuotodescrizioneRagione sociale.
NomeTesto—vuotodescrizioneNome.
CognomeTesto—vuotodescrizioneCognome.
ObsoletoVero/falso—false—Vero se il record non è più in uso: resta in archivio ma non viene proposto.
DataObsoletoData e ora—nessuna datadatafineData da cui il record è obsoleto.
SedeLegaleIndirizzoTesto—vuotoindirizzoSede legale indirizzo.
SedeLegaleCapTesto—vuotocapSede legale CAP.
SedeLegaleCittaTesto—vuotocittaSede legale città.
SedeLegaleProvinciaTesto—vuotoprovinciaSede legale provincia.
SedeLegaleRegioneTesto—vuotoregioneSede legale regione. Codice dell'archivio Regioni.
SedeLegaleNazioneTesto—vuotostatoSede legale nazione. Codice dell'archivio Nazioni.
SedeLegaleGPSLatDecimale—0indirizzogpslatSede legale GPS latitudine.
SedeLegaleGPSLongDecimale—0indirizzogpslngSede legale GPS longitudine.
SedeOperativaIndirizzoTesto—vuotosedeopindirizzoSede operativa indirizzo.
SedeOperativaCapTesto—vuotosedeopcapSede operativa CAP.
SedeOperativaCittaTesto—vuotosedeopcittaSede operativa città.
SedeOperativaProvinciaTesto—vuotosedeopprovinciaSede operativa provincia.
SedeOperativaRegioneTesto—vuotosedeopregioneSede operativa regione. Codice dell'archivio Regioni.
SedeOperativaNazioneTesto—vuotosedeopnazioneSede operativa nazione. Codice dell'archivio Nazioni.
SedeOperativaGPSLatDecimale—0sedeopgpslatSede operativa GPS latitudine.
SedeOperativaGPSLongDecimale—0sedeopgpslongSede operativa GPS longitudine.
CodiceFiscaleTesto—vuotocfopiCodice fiscale.
PartitaIVATesto—vuotopartivaPartita IVA.
SoggettoNonIVAVero/falso—false—Vero per i soggetti senza partita IVA.
CodiceUfficioIPATesto—vuotocodindicepaCodice destinatario o codice ufficio IPA per la fattura elettronica.
NumeroRegAlboImpreseCooperativeTesto—vuotonumregalbocoopNumero reg albo imprese cooperative.
TipologiaAnagraficaTesto—vuototipologiaTipologia anagrafica. Codice dell'archivio Tipologie anagrafiche.
TipologiaAnagraficaDescrizioneTesto—vuoto—Descrizione di TipologiaAnagrafica, riportata per comodità di chi legge.
CategoriaAnagraficaTesto—vuotocategoriaCategoria anagrafica. Codice dell'archivio Categorie anagrafiche.
AffidabilitaTesto—vuotoaffidabilitaAffidabilità. Codice dell'archivio Affidabilità.
AffidabilitaDescrizioneTesto—vuoto—Descrizione di Affidabilita, riportata per comodità di chi legge.
ZonaTesto—vuotozonaZona. Codice dell'archivio Zone.
SottozonaTesto—vuotosottozonaSottozona. Codice dell'archivio Sottozone.
SpedizioniereAbitualeTesto—vuotospedabSpedizioniere abituale. Codice dell'archivio Spedizionieri.
SedeDestinazioneAbitualeTesto—vuotodestabSede destinazione abituale. Codice dell'archivio Destinazioni diverse.
OrigineImportazioneTesto—vuotoorigineimportazioneOrigine importazione. Codice dell'archivio Origini dei contatti.
LogoAziendaImageTrasmission—null—Logo azienda.
PrivacyFiniContabiliVero/falso—false—Privacy fini contabili.
PrivacyPubbCartaceoVero/falso—false—Privacy pubb cartaceo.
PrivacyPubbEmailVero/falso—false—Privacy pubb email.
PrivacyPubbSMSVero/falso—false—Privacy pubb SMS.
PrivacyPubbWhatsAppVero/falso—false—Privacy pubb whats app.
PrivacyStampaDatiSensibiliVero/falso—false—Privacy stampa dati sensibili.
OrariUfficioTesto—vuotoorariuffOrari di ufficio.
Telefono1Testo—vuototelefono1Primo numero di telefono.
Telefono2Testo—vuototelefono2Secondo numero di telefono.
FaxTesto—vuotofaxNumero di fax.
CellulareAziendaleTesto—vuotocellCellulare aziendale.
WhatsAppAziendaleTesto—vuotowhatsappWhats app aziendale.
EmailTesto—vuotoemail1Indirizzo email.
PECTesto—vuotoemailpecIndirizzo di posta elettronica certificata.
ReferenteAmministrativoNomeeCognomeTesto—vuotoreferentiReferente amministrativo nomee cognome.
ReferenteAmministrativoTelefonoTesto—vuotoreferenteamministrativotelefonoReferente amministrativo telefono.
ReferenteAmministrativoInternoCentralinoTesto—vuotoreferenteamministrativointernocentralinoReferente amministrativo interno centralino.
ReferenteAmministrativoCellulareTesto—vuotoreferenteamministrativocellulareReferente amministrativo cellulare.
ReferenteAmministrativoEmailTesto—vuotoemail2Referente amministrativo email.
ReferenteAmministrativoPECTesto—vuotoreferenteamministrativopecReferente amministrativo PEC.
ReferenteAmministrativoWhatsAppTesto—vuotoreferenteamministrativowhatsappReferente amministrativo whats app.
ReferenteCommercialeNomeeCognomeTesto—vuotoreferentecommercialenomeecognomeReferente commerciale nomee cognome.
ReferenteCommercialeTelefonoTesto—vuotoreferentecommercialetelefonoReferente commerciale telefono.
ReferenteCommercialeInternoCentralinoTesto—vuotoreferentecommercialeinternocentralinoReferente commerciale interno centralino.
ReferenteCommercialeCellulareTesto—vuotoreferentecommercialecellulareReferente commerciale cellulare.
ReferenteCommercialeEmailTesto—vuotoemail3Referente commerciale email.
ReferenteCommercialePECTesto—vuotoreferentecommercialepecReferente commerciale PEC.
ReferenteCommercialeWhatsAppTesto—vuotoreferentecommercialewhatsappReferente commerciale whats app.
ReferenteTecnicoNomeeCognomeTesto—vuotoreferentetecniconomeecognomeReferente tecnico nomee cognome.
ReferenteTecnicoTelefonoTesto—vuotoreferentetecnicotelefonoReferente tecnico telefono.
ReferenteTecnicoInternoCentralinoTesto—vuotoreferentetecnicointernocentralinoReferente tecnico interno centralino.
ReferenteTecnicoCellulareTesto—vuotoreferentetecnicocellulareReferente tecnico cellulare.
ReferenteTecnicoEmailTesto—vuotoemail4Referente tecnico email.
ReferenteTecnicoPECTesto—vuotoreferentetecnicopecReferente tecnico PEC.
ReferenteTecnicoWhatsAppTesto—vuotoreferentetecnicowhatsappReferente tecnico whats app.
ReferenteLogisticoNomeeCognomeTesto—vuotoreferentelogisticonomeecognomeReferente logistico nomee cognome.
ReferenteLogisticoTelefonoTesto—vuotoreferentelogisticotelefonoReferente logistico telefono.
ReferenteLogisticoInternoCentralinoTesto—vuotoreferentelogisticointernocentralinoReferente logistico interno centralino.
ReferenteLogisticoCellulareTesto—vuotoreferentelogisticocellulareReferente logistico cellulare.
ReferenteLogisticoEmailTesto—vuotoemail5Referente logistico email.
ReferenteLogisticoPECTesto—vuotoreferentelogisticopecReferente logistico PEC.
ReferenteLogisticoWhatsAppTesto—vuotoreferentelogisticowhatsappReferente logistico whats app.
PagamentoTesto—vuotopagamentoCodice della condizione di pagamento. Codice dell'archivio Pagamenti.
PagamentoSostitutivoTesto—vuotopagamentoprincPagamento sostitutivo. Codice dell'archivio Pagamenti.
AgenteTesto—vuotoagenteCodice dell'agente.
AgenteDescrizioneTesto—vuoto—Descrizione di Agente, riportata per comodità di chi legge.
PercentualeProvvigioneDecimale—0provpercPercentuale di provvigione dell'agente.
PercentualeRitenutaAccontoDecimale—0percritPercentuale ritenuta acconto.
ImportoFidoDecimale—0fidoFido concesso.
ImportoFidoSostitutivoDecimale—0fidoImporto fido sostitutivo.
PercentualeSconto1Decimale—0scontoPercentuale sconto 1.
PercentualeSconto2Decimale—0sconto2Percentuale sconto 2.
PercentualeSconto3Decimale—0sconto3Percentuale sconto 3.
ContoPropostoVenditaTesto—vuotocontrovConto proposto vendita.
ContoPropostoAcquistaTesto—vuotocontroaConto proposto acquista.
ContoTesto—vuotocontoConto.
ContoCorrenteDefaultTesto—vuotocontocorrenteappoggioConto corrente predefinito.
AnagraficaDocumentiRiepilogativiVero/falso—false—Anagrafica documenti riepilogativi.
SplitPaymentVero/falso—false—Split payment.
AggiornaPrezziListinoAssociatoVero/falso—false—Aggiorna prezzi listino associato.
AssoggettatoRAEVero/falso—false—Assoggettato RAE.
EscludiEsportazioneTracciatiVenditaVero/falso—false—Escludi esportazione tracciati vendita.
EscludiControlloInsolutoVero/falso—false—Escludi controllo insoluto.
ProponiNelleEsportazioniAnagraficheVero/falso—false—Proponi nelle esportazioni anagrafiche.
BloccatoAssistenzaScadenzeInsoluteVero/falso—false—Bloccato assistenza scadenze insolute.
AvvisaInMovimentazioneVero/falso—false—Avvisa in movimentazione.
IncludiAvvisiRientroDisponibilitàVero/falso—false—Includi avvisi rientro disponibilit.
ListinoTesto—vuotolistinoCodice del listino. Codice dell'archivio Listini.
ProponiUltimoImportoPraticatoVero/falso—false—Proponi ultimo importo praticato.
ProponiUltimoImportoPraticatoScontiAParteVero/falso—false—Proponi ultimo importo praticato sconti a parte.
ProponiUltimoImportoPraticatoConsideraSoloDocumentiVero/falso—false—Proponi ultimo importo praticato considera solo documenti.
EscludiDaAddebitoAggiuntivoCategorieVero/falso—falseescludicatmercaddebEscludi da addebito aggiuntivo categorie.
ImportiAssistenzaImportoCostoOrarioDecimale—0asscostoorarioImporti assistenza importo costo orario.
ImportiAssistenzaPercScontoCostoOrarioDecimale—0assscontocoImporti assistenza percentuale sconto costo orario.
ImportiAssistenzaImportoOraViaggioDecimale—0asscostooraviaggioImporti assistenza importo ora viaggio.
ImportiAssistenzaPercScontoOraViaggioDecimale—0assscontoviaggioImporti assistenza percentuale sconto ora viaggio.
ImportiAssistenzaImportoPerKMDecimale—0assimportoperkmImporti assistenza importo per km.
ImportiAssistenzaPercScontoPerKMDecimale—0assscontokmImporti assistenza percentuale sconto per km.
ImportiAssistenzaPercorrenzaKMDecimale—0assdistkmImporti assistenza percorrenza km.
ImportiAssistenzaMinutiViaggioDecimale—0assoreviaggioImporti assistenza minuti viaggio.
ImportiAssistenzaDirittoDiChiamataDecimale—0assdirittochiamataImporti assistenza diritto di chiamata.
VariabileTabellare1Testo—vuototestot1Variabile tabellare 1.
VariabileTabellare2Testo—vuototestot2Variabile tabellare 2.
VariabileTabellare3Testo—vuototestot3Variabile tabellare 3.
VariabileTabellare4Testo—vuototestot4Variabile tabellare 4.
VariabileDescrittiva1Testo—vuototesto1Variabile descrittiva 1.
VariabileDescrittiva2Testo—vuototesto2Variabile descrittiva 2.
VariabileDescrittiva3Testo—vuototesto3Variabile descrittiva 3.
VariabileDescrittiva4Testo—vuototesto4Variabile descrittiva 4.
VariabileDescrittiva5Testo—vuototesto5Variabile descrittiva 5.
VariabileDescrittiva6Testo—vuototesto6Variabile descrittiva 6.
VariabileDescrittiva7Testo—vuototesto7Variabile descrittiva 7.
VariabileDescrittiva8Testo—vuototesto8Variabile descrittiva 8.
NoteTesto—vuotonoteNote libere.
NoteSpedizioneTesto—vuotonotespedNote per la spedizione.
MessaggioAttivoTesto—vuotonoteassMessaggio attivo.
NoteImperativaTesto—vuotonoteimpNote imperativa.
DataContattoData e ora—nessuna datadatacontattoData contatto.
DataAcquisizioneClienteData e ora—nessuna datadataacqData acquisizione cliente.
DataUltimaEmailData e ora—nessuna datadataultemailData ultima email.
DataUltimaTelefonataData e ora—nessuna datadataulttelData ultima telefonata.
DataUltimaFaxData e ora—nessuna datadataultfaxData ultima fax.
LiberoContatti1Testo—vuotolibero1Libero contatti 1.
LiberoContatti2Testo—vuotolibero2Libero contatti 2.
LiberoContatti3Testo—vuotolibero3Libero contatti 3.
LiberoContatti4Testo—vuotolibero4Libero contatti 4.
REATesto—vuotoreaREA.
CCIAATesto—vuotocciaaCCIAA.
SitoWebAziendaleTesto—vuotositoSito web aziendale.
CambiaSerieReverseChargeVero/falso—false—Cambia serie reverse charge.
SerieReverseChargeTesto—vuotoseriercSerie reverse charge.
EsteroVero/falso—false—Vero per i soggetti esteri.
EsteroCodiceIVATesto—vuotocodiceivaesteroEstero codice IVA.
EscludiDaAddebitoCategorieMerceologicheVero/falso—false—Escludi da addebito categorie merceologiche.
CodiceISTATNascitaTesto—vuoto—Codice ISTAT nascita.
CapDiNascitaTesto—vuotocapnascCAP di nascita.
CittaDiNascitaTesto—vuotocittanascCittà di nascita.
ProvinciaDiNascitaTesto—vuotoprovnascProvincia di nascita.
DataDiNascitaData e ora—nessuna datadatanascData di nascita.
SessoPersonaFisicaTesto—vuotosessoSesso persona fisica.
CLSIDTesto—vuotoclsidCLSID.
SpeseSuDocumento1Decimale—0importospesedoc1Spese su documento 1.
SpeseSuDocumento2Decimale—0importospesedoc2Spese su documento 2.
SpeseSuDocumento3Decimale—0importospesedoc3Spese su documento 3.
SpeseSuDocumento4Decimale—0importospesedoc4Spese su documento 4.
SpeseSuDocumento5Decimale—0importospesedoc5Spese su documento 5.
SpeseSuDocumento6Decimale—0importospesedoc6Spese su documento 6.
DatiBancariABITesto—vuotobancaDati bancari ABI.
DatiBancariCABTesto—vuotofilialeDati bancari CAB.
DatiBancariContoCorrenteTesto—vuotocontocorrenteDati bancari conto corrente.
DatiBancariCINTesto—vuotocinDati bancari CIN.
DatiBancariIBANTesto—vuotoibancontroDati bancari IBAN.
DatiBancariSWIFTTesto—vuotoswiftDati bancari SWIFT.
DatiBancariPaeseTesto—vuotopaeseDati bancari paese.
DatiBancariNumPaeseTesto—vuotonumpaeseDati bancari numero paese.
PATipovaloreFatturaPATesto—vuotopatipovalorefatturapaPA tipovalore fattura PA.
PAIdDocumentoTesto—vuotopaiddocumentoPA ID documento.
PADataIDDocumentoData e ora—nessuna datapadataiddocumentoPA data ID documento.
PANumerorigaIntero—0panumerorigaPA numeroriga.
PACodiceCUPTesto—vuotopacodicecupPA codice CUP.
PACodiceCIGTesto—vuotopacodicecigPA codice CIG.
PACommessaTesto—vuotopacommessaPA commessa.
PARifAmm126Testo—vuotoparifamm126PA rif amm 126.
PARifAmm21178Testo—vuotoparifamm21178PA rif amm 21178.
PARifAmm22115Testo—vuotoparifamm22115PA rif amm 22115.
ContoDescrizioneTesto—vuoto—Descrizione di Conto, riportata per comodità di chi legge.
ContoPropostoVenditaDescrizioneTesto—vuoto—Descrizione di ContoPropostoVendita, riportata per comodità di chi legge.
ContoPropostoAcquistaDescrizioneTesto—vuoto—Descrizione di ContoPropostoAcquista, riportata per comodità di chi legge.
CategoriaAnagraficaDescrizioneTesto—vuoto—Descrizione di CategoriaAnagrafica, riportata per comodità di chi legge.
ListinoDescrizioneTesto—vuotodeslistinoDescrizione di Listino, riportata per comodità di chi legge.
OrigineImportazioneDescrizioneTesto—vuoto—Descrizione di OrigineImportazione, riportata per comodità di chi legge.
PagamentoDescrizioneTesto—vuotodespagamentoDescrizione di Pagamento, riportata per comodità di chi legge.
PagamentoSostitutivoDescrizioneTesto—vuotodespagamentoDescrizione di PagamentoSostitutivo, riportata per comodità di chi legge.
SottozonaDescrizioneTesto—vuoto—Descrizione di Sottozona, riportata per comodità di chi legge.
SpedizioniereAbitualeDescrizioneTesto—vuoto—Descrizione di SpedizioniereAbituale, riportata per comodità di chi legge.
VariabileTabellare1DescrittivaTesto—vuoto—Descrizione di VariabileTabellare1, riportata per comodità di chi legge.
VariabileTabellare2DescrittivaTesto—vuoto—Descrizione di VariabileTabellare2, riportata per comodità di chi legge.
VariabileTabellare3DescrittivaTesto—vuoto—Descrizione di VariabileTabellare3, riportata per comodità di chi legge.
VariabileTabellare4DescrittivaTesto—vuoto—Descrizione di VariabileTabellare4, riportata per comodità di chi legge.
ZonaDescrizioneTesto—vuoto—Descrizione di Zona, riportata per comodità di chi legge.
SedeDestinazioneAbitualeDescrizioneTesto—vuoto—Descrizione di SedeDestinazioneAbituale, riportata per comodità di chi legge.
SedeLegaleNazioneDescrizioneTesto—vuoto—Descrizione di SedeLegaleNazione, riportata per comodità di chi legge.
SedeLegaleRegioneDescrizioneTesto—vuoto—Descrizione di SedeLegaleRegione, riportata per comodità di chi legge.
SedeOperativaNazioneDescrizioneTesto—vuoto—Descrizione di SedeOperativaNazione, riportata per comodità di chi legge.
SedeOperativaRegioneDescrizioneTesto—vuoto—Descrizione di SedeOperativaRegione, riportata per comodità di chi legge.
SpedizioniImportoDirittoFissoDecimale—0impdirfissoSpedizioni importo diritto fisso.
SpedizioniRapportoPesoVolumeDecimale—0rapppesovolumeSpedizioni rapporto peso volume.
AddebitaVuotiVero/falso—trueaddebitavuotiAddebita vuoti.
ImportFETipoCodiceTesto——importfetipocodiceImport fattura elettronica tipo codice.
ImportFETipoImportTesto——importfetipoimportImport fattura elettronica tipo import.
ImportFETipoValidaTesto——importfetipovalidaImport fattura elettronica tipo valida.
ImportFECampoTesto——importfecampoImport fattura elettronica campo.
SottocontoRigheFuoriMagazzinoImportFETesto—vuotoimportfecontrorighefuoriSottoconto righe fuori magazzino import fattura elettronica.
SottocontoRigheDescrittiveConImportoImportFETesto—vuotoimportfecontrorighedescrittiveSottoconto righe descrittive con importo import fattura elettronica.
GruppoAziendaleAppartenenzaTesto—vuotogruppocliforGruppo aziendale appartenenza. Codice dell'archivio Gruppi aziendali.
CanaleRicevimentoDefaultTesto—vuotocanalericevimentodefaultCanale ricevimento predefinito. Codice dell'archivio Canali di ricevimento.
StampaOrarioInChiaroVero/falso—falsestampaorarioinchiaroStampa orario in chiaro.
EscludiImpostaDiConsumoVero/falso—falseescludiimpostadiconsumoEscludi imposta di consumo.
CodiceEsportazioneTesto—vuotocodiceesportazioneCodice da usare nei tracciati di esportazione.
TipoGenerazioneFatturaPerSmaltimentoTesto—"S"tipogenerazionefatturapersmaltimentoTipo generazione fattura per smaltimento.
NumeroOrdinaleRivenditaGeneriMonopolioTesto—vuotonumeroordinalerivenditagenerimonopolioNumero ordinale rivendita generi monopolio.
CMNRRivenditaGeneriMonopolioTesto—vuotocmnrrivenditagenerimonopolioCMNR rivendita generi monopolio.
GuidPostazioneTesto—vuoto—Identificativo della postazione che ha creato il record.
ScontoMassimoApplicabileDecimale—0scontomassimoapplicabileSconto massimo applicabile.
MetodoSpedizioneDefaultTesto—vuotometodospedizionedefaultMetodo spedizione predefinito. Codice dell'archivio Metodi di spedizione.
DHMNoMovimentaRegistroVero/falso—falsenomovimentaregNo movimenta registro.
DHMASLRifTesto—vuotoaslrifDHMASL rif.
DHMAddebitaAdozioneVero/falso—falseaddebitaadozioneAddebita adozione.
DHMAddebitaSmaltimentoVero/falso—falseaddebitasmaltimentoAddebita smaltimento.
DHMPrezzoPerGiorno1Decimale—0pz1Prezzo per giorno 1.
DHMPrezzoPerGiorno1DaCaniDecimale—0da1Prezzo per giorno 1 da cani.
DHMPrezzoPerGiorno2Decimale—0pz2Prezzo per giorno 2.
DHMPrezzoPerGiorno2DaCaniDecimale—0da2Prezzo per giorno 2 da cani.
DHMPrezzoPerGiorno3Decimale—0pz3Prezzo per giorno 3.
DHMPrezzoPerGiorno3DaCaniDecimale—0da3Prezzo per giorno 3 da cani.
DHMPrezzoPerGiorno4Decimale—0pz4Prezzo per giorno 4.
DHMPrezzoPerGiorno4DaCaniDecimale—0da4Prezzo per giorno 4 da cani.
SeriePerDocumentiTesto—vuotoseriefattSerie per documenti.
DHMMassimoNumeroCaniIntero—0maxnumMassimo numero cani.
DHMPrimaRigaInDocumentiTesto—vuotoprimarigafattPrima riga in documenti.
DHMDataInizioPeriodoUltimaFatturaData e ora—nessuna datadataultfattdaData inizio periodo ultima fattura.
DHMDataFinePeriodoUltimaFatturaData e ora—nessuna datadataultfattaData fine periodo ultima fattura.
DHMImportoVuotiPagantiPresenzeMassimeIntero—0presenzemassimeImporto vuoti paganti presenze massime.
DHMImportoVuotiPagantiImportoPerGiornoPresenzeMassimeDecimale—0importopergiornopresenzemassimeImporto vuoti paganti importo per giorno presenze massime.
DHMListinoIncenerimentoTesto—vuotolistinoincenerimentoListino incenerimento.
DHMCadenzaFatturazioneMantenimentoTesto—vuotocadenzafattCadenza fatturazione mantenimento.
DHMCadenzaFatturazioneInterventoTesto—vuotocadenzafattintCadenza fatturazione intervento.
DHMMantenimentoFissoMensileImportoDecimale—0mantimpmeseMantenimento fisso mensile importo.
DHMMantenimentoFissoMensileDescrizioneTesto—vuotomantdescmeseMantenimento fisso mensile descrizione.
DHMInterventiFissoMensileImportoDecimale—0intimpmeseInterventi fisso mensile importo.
DHMInterventiFissoMensileDescrizioneTesto—vuotointdescmeseInterventi fisso mensile descrizione.
DHMMantenimentoTipoFatturazioneTesto—vuototipofattMantenimento tipo fatturazione.
DHMMantenimentoTipoFatturazioneForfaitGiorniInclusiIntero—0giorniinclMantenimento tipo fatturazione forfait giorni inclusi.
DHMMantenimentoTipoFatturazioneForfaitImportoDecimale—0importoforfMantenimento tipo fatturazione forfait importo.
DHMMantenimentoTipoFatturazioneForfaitImportoEccedenzaDecimale—0importoeccedenzaMantenimento tipo fatturazione forfait importo eccedenza.
DHMMantenimentoTipoDettaglioAnaliticoTesto—vuototipodettanaliticoMantenimento tipo dettaglio analitico.
DHMMantenimentoTipoDettaglioTesto—vuototipogenefattMantenimento tipo dettaglio.
DHMPraticheIncenerimentoTipoAddebitoDirittoDiChiamataTesto—vuototipoaddebdirchPratiche incenerimento tipo addebito diritto di chiamata.
DHMPraticheIncenerimentoImportoDirittoChiamataDecimale—0importodirchPratiche incenerimento importo diritto chiamata.
DHMPraticheIncenerimentoImportoDirittoChiamataFestiviDecimale—0importodirchfestPratiche incenerimento importo diritto chiamata festivi.
DHMNonAddebitareCertificatiDiSmaltimentoAPraticheDiIncenerimentoVero/falso—falsenonaddebitacertsmaltNon addebitare certificati di smaltimento a pratiche di incenerimento.
DHMPraticheIncenerimentoImportoRestituzioneDecimale—0importorestituzionePratiche incenerimento importo restituzione.
DHMPraticheIncenerimentoImportoRestituzioneFestivoDecimale—0importorestituzionefestPratiche incenerimento importo restituzione festivo.
EscludiArrotondamentoVero/falso—falseescludiarrotondamentoEscludi arrotondamento.
DHMEsponiAZeroVero/falso—falseesponiazeroEsponi a zero.
DHMTipoFatturazioneInterventiTesto—vuototipofattinterventiTipo fatturazione interventi.
DHMUsaDescrizioneUnivocaPerAddebitiSuAnimaliVero/falso—falseusadescrunivocaaddebUsa descrizione univoca per addebiti su animali.
DocumentoDiRiconoscimentoNumeroTesto—vuotodocriconoscimentonumeroDocumento di riconoscimento numero.
DocumentoDiRiconoscimentoTipoDocumentoTesto—vuotodocriconoscimentotipodocDocumento di riconoscimento tipo documento. Codice dell'archivio Tipi di documento di riconoscimento.
DocumentoDiRiconoscimentoTipoDocumentoDescrizioneTesto—vuotodestipodocricDescrizione di DocumentoDiRiconoscimentoTipoDocumento, riportata per comodità di chi legge.
DocumentoDiRiconoscimentoRilasciatoDaTesto—vuotodocriconoscimentorilasciatodaDocumento di riconoscimento rilasciato da.
DocumentoDiRiconoscimentoDataRilascioData e ora—nessuna datadocriconoscimentodatarilDocumento di riconoscimento data rilascio.
DocumentoDiRiconoscimentoDataScadenzaData e ora—nessuna datadocriconoscimentodatascadenzaDocumento di riconoscimento data scadenza.
TipoProposizioneFatturaPATesto—vuototipopropfatturapaTipo proposizione fattura PA.
TipoProposizioneGaraAppaltoTesto—vuototipopropgaraappaltoTipo proposizione gara appalto.
ArticoloDefaultTesto—vuotoarticolodefaultArticolo predefinito.
PagamentoIntegratedCardVero/falso—falsepagamentointegratedcardPagamento integrated card.
FidelityFidelityParameter—oggetto vuoto—Fidelity.
ListaReferentiElenco di Referenti—elenco vuoto—Referenti del cliente o del fornitore.
ListaDichiarazioniDIntentoElenco di DichiarazioniDIntento—elenco vuoto—Dichiarazioni d intento: elenco di oggetti DichiarazioniDIntento.
ListaAccordiCommercialiElenco di AccordiCommerciali—elenco vuoto—Accordi commerciali: elenco di oggetti AccordiCommerciali.
ListaScontiLegatiACondizioneElenco di ScontiLegatiACondizione—elenco vuoto—Sconti legati a condizione: elenco di oggetti ScontiLegatiACondizione.
LISTAFileAllegatiElenco di ImageTrasmission—elenco vuoto—File allegati: elenco di oggetti ImageTrasmission.
ListaAutorizzazioniSmaltimentoElenco di AutorizzazioniSmaltimentoRifiuti—elenco vuoto—Autorizzazioni smaltimento: elenco di oggetti AutorizzazioniSmaltimentoRifiuti.
ListaGaraDiAppaltoElenco di GaraDiAppalto—elenco vuoto—Gara di appalto: elenco di oggetti GaraDiAppalto.
ListaListiniPerCertificatiSmaltimentoElenco di DHMListiniPerCertificatiSmaltimento—elenco vuoto—Listini per certificati smaltimento: elenco di oggetti DHMListiniPerCertificatiSmaltimento.
ListaPrezziPerInterventiAccalappiamentoElenco di DHMPrezziPerInterventiAccalappiamento—elenco vuoto—Prezzi per interventi accalappiamento: elenco di oggetti DHMPrezziPerInterventiAccalappiamento.
ListaPrezziPerTipologieAnimaliElenco di DHMPrezziPerTipologieAnimali—elenco vuoto—Prezzi per tipologie animali: elenco di oggetti DHMPrezziPerTipologieAnimali.

Classe annidata FidelityParameter

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

CampoTipoObbligatorioPredefinitoA cosa serve
BarcodeTesto—vuotoBarcode.
ValidoDalData e ora—nessuna dataInizio del periodo di validità.
ValidoAlData e ora—nessuna dataFine del periodo di validità.

Classe annidata Referenti

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

CampoTipoObbligatorioPredefinitoA cosa serve
NomeTesto—vuotoNome.
CognomeTesto—vuotoCognome.
RuoloTesto—vuotoRuolo.
Telefono1Testo—vuotoPrimo numero di telefono.
Telefono2Testo—vuotoSecondo numero di telefono.
Cellulare1Testo—vuotoCellulare 1.
Cellulare2Testo—vuotoCellulare 2.
FaxTesto—vuotoNumero di fax.
Email1Testo—vuotoPrimo indirizzo email.
Email2Testo—vuotoSecondo indirizzo email.
Email3Testo—vuotoEmail 3.
SitoTesto—vuotoSito.
NomeUtenteTesto—vuotoNome utente.
PasswordTesto—vuotoPassword.
DataRegistrazioneData e ora—nessuna dataData registrazione.
NoteTesto—vuotoNote libere.

Classe annidata DichiarazioniDIntento

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

CampoTipoObbligatorioPredefinitoA cosa serve
EsercizioTesto—vuotoEsercizio. Codice dell'archivio Esercizi.
EsercizioDescrizioneTesto—vuotoDescrizione di Esercizio, riportata per comodità di chi legge.
CodiceIVAEsenzioneTesto—vuotoCodice IVA esenzione.
CodiceIVAEsenzioneDescrizioneTesto—vuotoDescrizione di CodiceIVAEsenzione, riportata per comodità di chi legge.
NumeroTesto—vuotoNumero.
DataData e ora—nessuna dataData.
ProtocolloTesto—vuotoProtocollo.
DataProtocolloData e ora—nessuna dataData protocollo.
ValidoDalData e ora—nessuna dataInizio del periodo di validità.
ValidoAlData e ora—nessuna dataFine del periodo di validità.
ImportoPlafondDecimale—0Importo plafond.
DescrizioneStampaTesto—vuotoDescrizione stampa.

Classe annidata AccordiCommerciali

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

CampoTipoObbligatorioPredefinitoA cosa serve
ArticoloCodiceTesto—vuotoArticolo codice.
ArticoloDescrizioneTesto—vuotoArticolo descrizione.
ArticoloFormVarTesto—vuotoArticolo form var.
ValidoDalData e ora—nessuna dataInizio del periodo di validità.
ValidoAlData e ora—nessuna dataFine del periodo di validità.
ImportoDecimale—0Importo.

Classe annidata ScontiLegatiACondizione

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

CampoTipoObbligatorioPredefinitoA cosa serve
CampoTesto—vuotoCampo.
ValoreTesto—vuotoValore.
ScontiStringaTesto—vuotoSconti stringa.

Classe annidata AutorizzazioniSmaltimentoRifiuti

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

CampoTipoObbligatorioPredefinitoA cosa serve
SedeTesto—vuotoSede.
NumeroTesto—vuotoNumero.
CategoriaTesto—vuotoCodice della categoria a cui appartiene il record.
TipoTesto—"S"Tipo.
DataScadenzaAutorizzazioneData e ora—nessuna dataData scadenza autorizzazione.

Classe annidata GaraDiAppalto

Elemento usato dentro ClientiFornitori. 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.
TipoGaraTesto—vuotoTipo gara.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
AvvisoDataData e ora—nessuna dataAvviso data.
AvvisoNonAvvisareVero/falso—falseAvviso non avvisare.
EsitoAggiudicazioneTesto—vuotoEsito aggiudicazione.
EsitoDataAggiudicazioneData e ora—nessuna dataEsito data aggiudicazione.
EsitoAggiudicatarioTesto—vuotoEsito aggiudicatario.
EsitoImportoDecimale—0Esito importo.
EsitoValidaDalData e ora—nessuna dataEsito valida dal.
EsitoValidaAlData e ora—nessuna dataEsito valida al.
DatiFatturaTipoTesto—vuotoDati fattura tipo.
DatiFatturaIdDocumentoTesto—vuotoDati fattura ID documento.
DatiFatturaDataData e ora—nessuna dataDati fattura data.
DatiFatturaNumeroRigaIntero—0Dati fattura numero riga.
DatiFatturaCodiceCUPTesto—vuotoDati fattura codice CUP.
DatiFatturaCIGTesto—vuotoDati fattura CIG.
DatiFatturaCodiceCommessaConvenzioneTesto—vuotoDati fattura codice commessa convenzione.
DatiFatturaRifAmmCampo126Testo—vuotoDati fattura rif amm campo 126.
DatiFatturaRifAmmCampo21178Testo—vuotoDati fattura rif amm campo 21178.
DatiFatturaRifAmmCampo22115Testo—vuotoDati fattura rif amm campo 22115.
DatiFatturaAltriDatiGestionaliList(Of ClientiFornitori.PAAltriDatiGestionaliBlocco22116)—elenco vuotoDati fattura altri dati gestionali.
LISTAFileAllegatiElenco di ImageTrasmission—elenco vuotoFile allegati: elenco di oggetti ImageTrasmission.

Classe annidata PAAltriDatiGestionaliBlocco22116

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoDatoTesto—vuotoTipo dato.
RiferimentoTestoTesto—vuotoRiferimento testo.
RiferimentoNumeroDecimale—0Riferimento numero.
RiferimentoDataData e ora—nessuna dataRiferimento data.

Classe annidata DHMListiniPerCertificatiSmaltimento

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoTesto—"A"Tipo.
TipoDescrizioneTesto—"Animali"Descrizione di Tipo, riportata per comodità di chi legge.
TipoCertificatoTesto—vuotoTipo certificato.
TipoCertificatoDescrizioneTesto—vuotoDescrizione di TipoCertificato, riportata per comodità di chi legge.
SpecieoMaterialeTesto—vuotoSpecieo materiale.
SpecieoMaterialeDescrizioneTesto—vuotoDescrizione di SpecieoMateriale, riportata per comodità di chi legge.
ImportoDecimale—0Importo.
ImportoFestivoDecimale—0Importo festivo.
DaPesoDecimale—0Da peso.
APesoDecimale—0A peso.

Classe annidata DHMPrezziPerInterventiAccalappiamento

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoInterventoTesto—vuotoTipo intervento.
TipoInterventoDescrizioneTesto—vuotoDescrizione di TipoIntervento, riportata per comodità di chi legge.
TariffazioneSpecialeTesto—vuotoTariffazione speciale.
TariffazioneSpecialeDescrizioneTesto—vuotoDescrizione di TariffazioneSpeciale, riportata per comodità di chi legge.
EsitoTesto—vuotoEsito.
EsitoDescrizioneTesto—vuotoDescrizione di Esito, riportata per comodità di chi legge.
ImportoDecimale—0Importo.
NumeroInterventiInclusiGaraIntero—0Numero interventi inclusi gara.

Classe annidata DHMPrezziPerTipologieAnimali

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodTipoCaneTesto—vuotoCodice tipo cane.
CodTipoCaneDescrizioneTesto—vuotoDescrizione di CodTipoCane, riportata per comodità di chi legge.
ImportoDecimale—0Importo.

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": 34,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListClientiFornitori": [
    {
      "Codice": "COD001",
      "Tipo": "C",
      "Progressivo": 1,
      "TipologiaSoggetto": "ESEMPIO",
      "RagioneSociale": "Esempio",
      "Nome": "Esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 34,
  "GuidPC": "gestionale-01",
  "ObjectListClientiFornitori": [
    {
      "Codice": "COD001",
      "Tipo": "C",
      "Progressivo": 1
    }
  ]
}

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

Categorie anagrafiche

CategorieClienteFornitore: le categorie con cui si classificano clienti e fornitori

Categorie anagrafiche: le categorie con cui si classificano clienti e fornitori. Nel web service è il tipo CATEGORIECLIENTEFORNITORE (valore 35 di DataType); gli oggetti sono della classe CategorieClienteFornitore e viaggiano nella lista ObjectListCategorieClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCATEGORIECLIENTEFORNITORE = 35
ClasseCategorieClienteFornitore
Lista nella richiesta e nella rispostaObjectListCategorieClienteFornitore
Tabella letta da QUERYCategoriaCliFor — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CategorieClienteFornitore

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ColoreIntero—0coloreColore, in esadecimale.

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": 35,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCategorieClienteFornitore": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Colore": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 35,
  "GuidPC": "gestionale-01",
  "ObjectListCategorieClienteFornitore": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipologie anagrafiche

TipoClienteFornitore: le tipologie di clienti e fornitori, come privato o rivenditore

Tipologie anagrafiche: le tipologie di clienti e fornitori, come privato o rivenditore. Nel web service è il tipo TIPOLOGIECLIENTEFORNITORE (valore 36 di DataType); gli oggetti sono della classe TipoClienteFornitore e viaggiano nella lista ObjectListTipoClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTIPOLOGIECLIENTEFORNITORE = 36
ClasseTipoClienteFornitore
Lista nella richiesta e nella rispostaObjectListTipoClienteFornitore
Tabella letta da QUERYTipologiaCliFor — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TipoClienteFornitore

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ColoreIntero—0coloreColore, in esadecimale.

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": 36,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTipoClienteFornitore": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Colore": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 36,
  "GuidPC": "gestionale-01",
  "ObjectListTipoClienteFornitore": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Comuni

Comuni: l'archivio dei comuni con CAP, provincia e codici

Comuni: l'archivio dei comuni con CAP, provincia e codici. Nel web service è il tipo COMUNI (valore 37 di DataType); gli oggetti sono della classe Comuni e viaggiano nella lista ObjectListComuni della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCOMUNI = 37
ClasseComuni
Lista nella richiesta e nella rispostaObjectListComuni
Tabella letta da QUERYComuni — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveID — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassID
Chiave per le conferme di ricezioneID — come si usa
Controlli prima del salvataggioID: «Identificativo non specificato»
Citta: «Descrizione non specificato»

I campi di Comuni

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
IDInteroChiave, sì0idNumero identificativo interno. Se manca il server risponde «Identificativo non specificato».
CodiceCittaTesto—vuotocodcittaCodice città.
CittaTestoSìvuotocittaCittà. Se manca il server risponde «Descrizione non specificato».
ProvinciaTesto—vuotoprovSigla della provincia.
CAPTesto—vuotocapCodice di avviamento postale.
CodRegioneTesto—vuotocodregioneCodice regione.
CapoluogoProvinciaVero/falso—falsecapoprovCapoluogo provincia.
CapoluogoRegioneVero/falso—falsecaporegioneCapoluogo regione.
ElencoCAPTesto—vuotoelencocapElenco CAP.
ZonaItaliaTesto—vuotozonaitaliaZona italia.
PopolazioneIntero lungo—0popolazionePopolazione.
NazionePerCodiceFiscaleVero/falso—falsenazionepercodfiscNazione per codice fiscale.

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": 37,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListComuni": [
    {
      "ID": 1,
      "CodiceCitta": "COD001",
      "Citta": "ESEMPIO",
      "Provincia": "ESEMPIO",
      "CAP": "ESEMPIO",
      "CodRegione": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 37,
  "GuidPC": "gestionale-01",
  "ObjectListComuni": [
    {
      "ID": 1
    }
  ]
}

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

Zone dei comuni

ComuniZone: le zone in cui sono raggruppati i comuni

Zone dei comuni: le zone in cui sono raggruppati i comuni. Nel web service è il tipo COMUNIZONE (valore 38 di DataType); gli oggetti sono della classe ComuniZone e viaggiano nella lista ObjectListComuniZone della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCOMUNIZONE = 38
ClasseComuniZone
Lista nella richiesta e nella rispostaObjectListComuniZone
Tabella letta da QUERYComuniZone — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di ComuniZone

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 38,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListComuniZone": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 38,
  "GuidPC": "gestionale-01",
  "ObjectListComuniZone": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Regioni

Regioni: l'archivio delle regioni

Regioni: l'archivio delle regioni. Nel web service è il tipo REGIONI (valore 39 di DataType); gli oggetti sono della classe Regioni e viaggiano nella lista ObjectListRegioni della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoREGIONI = 39
ClasseRegioni
Lista nella richiesta e nella rispostaObjectListRegioni
Tabella letta da QUERYRegioni — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Regioni

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CodiceIstatTesto—vuotocodistatCodice ISTAT.

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": 39,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListRegioni": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CodiceIstat": "COD002"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 39,
  "GuidPC": "gestionale-01",
  "ObjectListRegioni": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Gruppi aziendali

GruppiClienteFornitore: i gruppi a cui appartengono clienti e fornitori

Gruppi aziendali: i gruppi a cui appartengono clienti e fornitori. Nel web service è il tipo GRUPPICLIENTEFORNITORE (valore 40 di DataType); gli oggetti sono della classe GruppiClienteFornitore e viaggiano nella lista ObjectListGruppiClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoGRUPPICLIENTEFORNITORE = 40
ClasseGruppiClienteFornitore
Lista nella richiesta e nella rispostaObjectListGruppiClienteFornitore
Tabella letta da QUERYGruppiClientiFornitori — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di GruppiClienteFornitore

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 40,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListGruppiClienteFornitore": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 40,
  "GuidPC": "gestionale-01",
  "ObjectListGruppiClienteFornitore": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Destinazioni diverse

DestinazioniDiverse: gli indirizzi di consegna di clienti e fornitori

Destinazioni diverse: gli indirizzi di consegna di clienti e fornitori. Nel web service è il tipo DESTINAZIONIDIVERSE (valore 44 di DataType); gli oggetti sono della classe DestinazioniDiverse e viaggiano nella lista ObjectListDestinazioniDiverse della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDESTINAZIONIDIVERSE = 44
ClasseDestinazioniDiverse
Lista nella richiesta e nella rispostaObjectListDestinazioniDiverse
Tabella letta da QUERYDestinazionidiv — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodiceClienteFornitore + TipoClienteFornitore + Codice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodiceClienteFornitore|TipoClienteFornitore|Codice
Chiave per le conferme di ricezioneCodiceClienteFornitore|TipoClienteFornitore|Codice — come si usa
Controlli prima del salvataggioCodiceClienteFornitore: «Codice cliente o fornitore non specificato»
TipoClienteFornitore: «Tipo cliente o fornitore non specificato»
Codice: «Codice non specificato»

I campi di DestinazioniDiverse

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
CodiceClienteFornitoreTestoChiave, sìvuotocodcliforCodice del cliente o del fornitore. Se manca il server risponde «Codice cliente o fornitore non specificato».
TipoClienteFornitoreTestoChiave, sìvuototipocliforC per cliente, F per fornitore. Se manca il server risponde «Tipo cliente o fornitore non specificato».
CodiceTestoChiave, sìvuotocodiceCodice della destinazione, univoco per il cliente o fornitore. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
DescrizionePersonalizzataTesto—vuotodescrpersDescrizione personalizzata.
IndirizzoTesto—vuotoindirizzoIndirizzo (via e numero civico).
CapTesto—vuotocapCodice di avviamento postale.
CittaTesto—vuotocittaCittà.
ProvinciaTesto—vuotoprovSigla della provincia.
RegioneTesto—vuotoregioneRegione.
NazioneTesto—vuotonazioneCodice della nazione.
IndirizzoGPSlngDecimale—0indirizzogpslngIndirizzo GP slng.
IndirizzoGPSlatDecimale—0indirizzogpslatIndirizzo GP slat.
ReferentiTesto—vuotoreferentiNomi dei referenti.
Telefono1Testo—vuototelefono1Primo numero di telefono.
Telefono2Testo—vuototelefono2Secondo numero di telefono.
CellulareTesto—vuotocellulareNumero di cellulare.
FaxTesto—vuotofaxNumero di fax.
OrariUfficioTesto—vuotoorariuffOrari di ufficio.
NoteTesto—vuotonoteNote libere.
AssistenzaDistanzaKMDecimale—0assdistkmAssistenza distanza km.
AssistenzaOreViaggioDecimale—0assoreviaggioAssistenza ore viaggio.
NoteSpedizioneTesto—vuotonotespedNote per la spedizione.
Email1Testo—vuotoemail1Primo indirizzo email.
Email2Testo—vuotoemail2Secondo indirizzo email.
WhatsappTesto—vuotowhatsappNumero WhatsApp.
PecTesto—vuotopecIndirizzo di posta elettronica certificata.
CodiceCorrispondenzaTesto—vuotocodicecorrCodice corrispondenza.
CodiceEsportazioneTesto—vuotocodiceesportazioneCodice da usare nei tracciati di esportazione.
ObsoletoVero/falso—falseobsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
ObsoletoDalData e ora—nessuna dataobsoletodalData da cui il record è obsoleto.

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": 44,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDestinazioniDiverse": [
    {
      "CodiceClienteFornitore": "COD001",
      "TipoClienteFornitore": "C",
      "Codice": "COD002",
      "Descrizione": "Descrizione di esempio",
      "DescrizionePersonalizzata": "Descrizione di esempio",
      "Indirizzo": "ESEMPIO",
      "Cap": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 44,
  "GuidPC": "gestionale-01",
  "ObjectListDestinazioniDiverse": [
    {
      "CodiceClienteFornitore": "COD001",
      "TipoClienteFornitore": "C",
      "Codice": "COD003"
    }
  ]
}

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

Nazioni

Nazioni: l'archivio delle nazioni con i codici

Nazioni: l'archivio delle nazioni con i codici. Nel web service è il tipo NAZIONI (valore 47 di DataType); gli oggetti sono della classe Nazioni e viaggiano nella lista ObjectListNazioni della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoNAZIONI = 47
ClasseNazioni
Lista nella richiesta e nella rispostaObjectListNazioni
Tabella letta da QUERYNazioni — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Nazioni

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CodiceUNICOTesto—vuotocodiceunicoCodice UNICO.
CodiceINTRATesto—vuotocodiceintraCodice INTRA.

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": 47,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListNazioni": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CodiceUNICO": "COD002",
      "CodiceINTRA": "COD003"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 47,
  "GuidPC": "gestionale-01",
  "ObjectListNazioni": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Province

Province: l'archivio delle province con le sigle

Province: l'archivio delle province con le sigle. Nel web service è il tipo PROVINCE (valore 48 di DataType); gli oggetti sono della classe Province e viaggiano nella lista ObjectListProvince della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoPROVINCE = 48
ClasseProvince
Lista nella richiesta e nella rispostaObjectListProvince
Tabella letta da QUERYProvincie — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Province

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoTesto—vuototipoTipo.
SiglaTesto—vuotosiglaSigla.
CodiceISTATTesto—vuotocodistatCodice ISTAT.

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": 48,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListProvince": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Tipo": "ESEMPIO",
      "Sigla": "ESEMPIO",
      "CodiceISTAT": "COD002"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 48,
  "GuidPC": "gestionale-01",
  "ObjectListProvince": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di documento di riconoscimento

TipoDocumentoRiconoscimento: carta d'identità, patente, passaporto e gli altri documenti

Tipi di documento di riconoscimento: carta d'identità, patente, passaporto e gli altri documenti. Nel web service è il tipo TIPODOCUMENTORICONOSCIMENTO (valore 63 di DataType); gli oggetti sono della classe TipoDocumentoRiconoscimento e viaggiano nella lista ObjectListTipoDocumentoRiconoscimento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTIPODOCUMENTORICONOSCIMENTO = 63
ClasseTipoDocumentoRiconoscimento
Lista nella richiesta e nella rispostaObjectListTipoDocumentoRiconoscimento
Tabella letta da QUERYTipiDocumentoRiconoscimento — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TipoDocumentoRiconoscimento

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 63,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTipoDocumentoRiconoscimento": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 63,
  "GuidPC": "gestionale-01",
  "ObjectListTipoDocumentoRiconoscimento": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Zone

ZonaClienteFornitore: le zone commerciali di clienti e fornitori

Zone: le zone commerciali di clienti e fornitori. Nel web service è il tipo ZONACLIENTEFORNITORE (valore 121 di DataType); gli oggetti sono della classe ZonaClienteFornitore e viaggiano nella lista ObjectListZonaClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoZONACLIENTEFORNITORE = 121
ClasseZonaClienteFornitore
Lista nella richiesta e nella rispostaObjectListZonaClienteFornitore
Tabella letta da QUERYzoneclifor — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di ZonaClienteFornitore

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 121,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListZonaClienteFornitore": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 121,
  "GuidPC": "gestionale-01",
  "ObjectListZonaClienteFornitore": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Origini dei contatti

OrigineImportazioneClienteFornitore: da dove arriva un cliente o un fornitore, come sito o fiera

Origini dei contatti: da dove arriva un cliente o un fornitore, come sito o fiera. Nel web service è il tipo ORIGINEIMPORTAZIONECLIENTEFORNITORE (valore 122 di DataType); gli oggetti sono della classe OrigineImportazioneClienteFornitore e viaggiano nella lista ObjectListOrigineImportazioneClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoORIGINEIMPORTAZIONECLIENTEFORNITORE = 122
ClasseOrigineImportazioneClienteFornitore
Lista nella richiesta e nella rispostaObjectListOrigineImportazioneClienteFornitore
Tabella letta da QUERYWEBOrigini — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di OrigineImportazioneClienteFornitore

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 122,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListOrigineImportazioneClienteFornitore": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 122,
  "GuidPC": "gestionale-01",
  "ObjectListOrigineImportazioneClienteFornitore": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Affidabilità

AffidabilitaClienteFornitore: le classi di affidabilità di clienti e fornitori

Affidabilità: le classi di affidabilità di clienti e fornitori. Nel web service è il tipo AFFIDABILITACLIENTEFORNITORE (valore 126 di DataType); gli oggetti sono della classe AffidabilitaClienteFornitore e viaggiano nella lista ObjectListAffidabilitaClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoAFFIDABILITACLIENTEFORNITORE = 126
ClasseAffidabilitaClienteFornitore
Lista nella richiesta e nella rispostaObjectListAffidabilitaClienteFornitore
Tabella letta da QUERYAffidabilita — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di AffidabilitaClienteFornitore

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ListaPagamentiAbilitatiElenco di AffidabilitaPagamenti—elenco vuoto—Pagamenti abilitati: elenco di oggetti AffidabilitaPagamenti.

Classe annidata AffidabilitaPagamenti

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

CampoTipoObbligatorioPredefinitoA cosa serve
ProgressivoIntero—0Numero progressivo della riga all'interno del record principale.
CodicePagamentoTesto—vuotoCodice pagamento.

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": 126,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListAffidabilitaClienteFornitore": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 126,
  "GuidPC": "gestionale-01",
  "ObjectListAffidabilitaClienteFornitore": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Sottozone

SottoZonaClienteFornitore: le sottozone, legate alla loro zona

Sottozone: le sottozone, legate alla loro zona. Nel web service è il tipo SOTTOZONACLIENTEFORNITORE (valore 127 di DataType); gli oggetti sono della classe SottoZonaClienteFornitore e viaggiano nella lista ObjectListSottoZonaClienteFornitore della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSOTTOZONACLIENTEFORNITORE = 127
ClasseSottoZonaClienteFornitore
Lista nella richiesta e nella rispostaObjectListSottoZonaClienteFornitore
Tabella letta da QUERYSottozone — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodiceZona + Codice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodiceZona|Codice
Chiave per le conferme di ricezioneCodiceZona|Codice — come si usa
Controlli prima del salvataggioCodiceZona: «Codice zona non specificato»
Codice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di SottoZonaClienteFornitore

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
CodiceZonaTestoChiave, sìvuotocodzonaCodice zona. Codice dell'archivio Zone. Se manca il server risponde «Codice zona non specificato».
DescrizioneZonaTesto—vuoto—Descrizione zona.
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 127,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListSottoZonaClienteFornitore": [
    {
      "CodiceZona": "COD001",
      "DescrizioneZona": "Descrizione di esempio",
      "Codice": "COD002",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 127,
  "GuidPC": "gestionale-01",
  "ObjectListSottoZonaClienteFornitore": [
    {
      "CodiceZona": "COD001",
      "Codice": "COD002"
    }
  ]
}

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

Codici IVA

IVA: aliquote, detraibilità, natura per la fattura elettronica ed esigibilità

Codici IVA: aliquote, detraibilità, natura per la fattura elettronica ed esigibilità. Nel web service è il tipo IVA (valore 4 di DataType); gli oggetti sono della classe IVA e viaggiano nella lista ObjectListIVA della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoIVA = 4
ClasseIVA
Lista nella richiesta e nella rispostaObjectListIVA
Tabella letta da QUERYIva — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di IVA

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
PercentualeIVADecimale—0percAliquota, in percentuale.
PercentualeIVADetraibilitaDecimale—0percdetrPercentuale di detraibilità.
ReverseChargeVero/falso—falserevchargeVero per le operazioni in inversione contabile.
ObsoletoVero/falso—falseobsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
DataObsoletoData e ora—nessuna datadataobData da cui il record è obsoleto.
NaturaEsenzionetracciatoSDITesto—vuotonaturaNatura dell'operazione per la fattura elettronica (N1, N2.1...).
CodiceExportTesto—vuotocodexpCodice da usare nei tracciati di esportazione.
EscludiDaCalcoloBolliVero/falso—falseescludidabolliVero per escludere gli importi dal calcolo del bollo.
EsigibilitaIVATesto—"I"esigibilitaEsigibilità dell'IVA (immediata, differita, scissione).
AttivoVero/falso—falseattivoVero se il record è attivo.

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": 4,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListIVA": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "PercentualeIVA": 1,
      "PercentualeIVADetraibilita": 1,
      "ReverseCharge": false,
      "Obsoleto": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 4,
  "GuidPC": "gestionale-01",
  "ObjectListIVA": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Causali contabili

CausaleContabile: le causali delle registrazioni in contabilità

Causali contabili: le causali delle registrazioni in contabilità. Nel web service è il tipo CAUSALICONTABILI (valore 11 di DataType); gli oggetti sono della classe CausaleContabile e viaggiano nella lista ObjectListCausaleContabile della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCAUSALICONTABILI = 11
ClasseCausaleContabile
Lista nella richiesta e nella rispostaObjectListCausaleContabile
Tabella letta da QUERYCausaliContabili — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di CausaleContabile

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
CodiceTestoChiave, sì—codiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSì—descrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
IndicatoreGenerazioneScadenzeTesto——genscadenzeIndicatore generazione scadenze.
IndicatoreOperativitaTesto——operativitaIndicatore operativita.
IndicatoreTipoRegistroIVATesto——tiporegistroIndicatore tipo registro IVA.
IndicatoreTipoCausaleTesto——tipocausaleIndicatore tipo causale.
IndicatoreMovimentoINTRATesto——movimintraIndicatore movimento INTRA.
IndicatoreCespitiTesto——cespitiIndicatore cespiti.
IndicatoreRitenuteTesto——ritenuteIndicatore ritenute.
GeneraRegistrazioneInPrimaNotaVero/falso——esptopnGenera registrazione in prima nota.
PercentualeIndetraibileDecimale——percindetrPercentuale indetraibile.
StampaRigheRegistrazioneSuMastriniVero/falso——stampainmastriniStampa righe registrazione su mastrini.
CalcoloAutomaticoIVAVero/falso——calcolaautoivaCalcolo automatico IVA.
ProponiRighePerSegnoVero/falso——proprighesegnoProponi righe per segno.
SottocontoContropartitaInsolutiTesto——controinsolutiSottoconto contropartita insoluti.
CodExportAltriSoftwareTesto——codexpCodice export altri software.
CodExportAltriSoftwareRegistroIVADefaultTesto——codexpregCodice export altri software registro IVA predefinito.
CodExportAltriSoftwareAltroCodiceRigheVero/falso——exportaltrocodicerigheCodice export altri software altro codice righe.
CodExportAltriSoftwareAltroCodiceRigheCodiceTesto——exportaltrocodicerighecodiceCodice export altri software altro codice righe codice.
IndicatoreGenerazioneScadenzeNegativeVero/falso———Indicatore generazione scadenze negative.
SegnoDAIVATesto———Segno DAIVA.
ModificaTipoScadenzaVero/falso——modtiposcadModifica tipo scadenza.
ModificaTipoScadenzaTipoRimessaTesto——tiposcadModifica tipo scadenza tipo rimessa.
FiscaleTipoTesto——fiscaletipoFiscale tipo.
FiscaleQuadroTesto——fiscalequadroFiscale quadro.
FiscaleCodiceSuQuadroTesto——fiscalecodiceaddquadroFiscale codice su quadro.
TipoDocumentoAssociatoTesto——tipodocassociatoTipo documento associato.
NonStampareRegistriIVAVero/falso——nonstampareregistriivaNon stampare registri IVA.
ObsoletoVero/falso——obsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
DataObsoletoData e ora——obsoletodalData da cui il record è obsoleto.
SottocontiPropostiElenco di CausaleContabileSottocontiProposti———Sottoconti proposti: elenco di oggetti CausaleContabileSottocontiProposti.
ParametrizzazioneCodiciIVAElenco di CausaleContabileParametrizzazioneCodiciIVA———Parametrizzazione codici IVA: elenco di oggetti CausaleContabileParametrizzazioneCodiciIVA.
RegistrazioniIVAExportElenco di CausaleContabileRegistrazioniIVAExport———Registrazioni IVA export: elenco di oggetti CausaleContabileRegistrazioniIVAExport.

Classe annidata CausaleContabileSottocontiProposti

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

CampoTipoObbligatorioPredefinitoA cosa serve
SegnoTesto—"D"Segno dell'operazione.
SottocontoTesto—vuotoSottoconto.
IndiceRigaIntero—0Indice riga.

Classe annidata CausaleContabileParametrizzazioneCodiciIVA

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

CampoTipoObbligatorioPredefinitoA cosa serve
CodiceIVATesto—"D"Codice IVA. Codice dell'archivio Codici IVA.
TipoOperazioneTesto—vuotoTipo operazione.
ValoreDecimale—0Valore.

Classe annidata CausaleContabileRegistrazioniIVAExport

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

CampoTipoObbligatorioPredefinitoA cosa serve
RegIVATesto—vuotoReg IVA.
SerieTesto—vuotoSerie.
CodiceExpTesto—vuotoCodice exp.

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": 11,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListCausaleContabile": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "IndicatoreGenerazioneScadenze": "ESEMPIO",
      "IndicatoreOperativita": "ESEMPIO",
      "IndicatoreTipoRegistroIVA": "ESEMPIO",
      "IndicatoreTipoCausale": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 11,
  "GuidPC": "gestionale-01",
  "ObjectListCausaleContabile": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Sezioni contabili

SezioneContabile: le sezioni dei registri IVA e contabili

Sezioni contabili: le sezioni dei registri IVA e contabili. Nel web service è il tipo SEZIONECONTABILE (valore 27 di DataType); gli oggetti sono della classe SezioneContabile e viaggiano nella lista ObjectListSezioneContabile della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoSEZIONECONTABILE = 27
ClasseSezioneContabile
Lista nella richiesta e nella rispostaObjectListSezioneContabile
Tabella letta da QUERYSezioniContabili — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di SezioneContabile

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 27,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListSezioneContabile": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 27,
  "GuidPC": "gestionale-01",
  "ObjectListSezioneContabile": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Pagamenti

Pagamenti: le condizioni di pagamento con scadenze, spese e metodi abilitati sul sito

Pagamenti: le condizioni di pagamento con scadenze, spese e metodi abilitati sul sito. Nel web service è il tipo PAGAMENTI (valore 31 di DataType); gli oggetti sono della classe Pagamenti e viaggiano nella lista ObjectListPagamenti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoPAGAMENTI = 31
ClassePagamenti
Lista nella richiesta e nella rispostaObjectListPagamenti
Tabella letta da QUERYPagamenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Pagamenti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CalcoloSpeseVero/falso—falsecalcolospeseCalcolo spese.
TipoCalcoloTesto—vuototipocalcModalità di calcolo.
ValoreCalcoloDecimale—0valcalcValore calcolo.
VoceSpesaIntero—0vocespesaVoce spesa.
TipoRimesseTesto—vuototiporimesseTipo rimesse.
ScontoDecimale—0scontoSconto.
RichiediContoAziendaleVero/falso—falsericcontoRichiedi conto aziendale.
ControllaFidoVero/falso—falsecontrollafidoControlla fido.
AbilitaVenditaWEBVero/falso—falseabilitavendwebAbilita vendita web.
AbilitaVenditaBancoVero/falso—falseabilitavendbancAbilita vendita banco.
CalcoloGiorniTesto—vuotocalcologiorniCalcolo giorni.
MesiEsclusiTesto—vuotomesiesclMesi esclusi.
GiornoMeseSuccessivoIntero—0giornomesesuccGiorno mese successivo.
GiornoMeseSuccessivoEsclusiIntero—0giornomesesuccnoesclGiorno mese successivo esclusi.
AggiungiGiornoAScadenzaIntero—0giornoaddscadAggiungi giorno a scadenza.
AbilitaBancaClienteFornitoriVero/falso—falseabilitabancacliforAbilita banca cliente fornitori.
AbilitaPaypalVero/falso—falseabilitapaypalAbilita PayPal.
AbilitaGooglePayVero/falso—falseabilitagooglepayAbilita Google pay.
AbilitaKlarnaVero/falso—falseabilitaklarnaAbilita Klarna.
AbilitaNexiVero/falso—falseabilitanexiAbilita Nexi.
AbilitaCartaVero/falso—falseabilitacartaAbilita carta.
TipocartaTesto—vuototipocartaTipocarta.
UsernameCartaTesto—vuotousernamecartaUsername carta.
PasswordCartaTesto—vuotopasswordcartaPassword carta.
NoteTesto—vuotonoteNote libere.
ValoreScontrinoTesto—vuotovalorescontrinoValore scontrino.
AbilitaClienteGestitoDirettamenteVero/falso—falseabilitaclientegestitoAbilita cliente gestito direttamente.
ListaCorpoElenco di PagamentiCorpo—elenco vuoto—Corpo: elenco di oggetti PagamentiCorpo.

Classe annidata PagamentiCorpo

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipologiaTesto—vuotoTipologia.
InizioRimessaTesto—vuotoInizio rimessa.
NumeroGiorniIntero—0Numero giorni.
ValoreRataDecimale—0Valore rata.
ArrotondamentoDataTesto—vuotoArrotondamento data.
GeneraIncassoContestualeVero/falso—falseGenera incasso contestuale.
SottocontoIncassoTesto—vuotoSottoconto incasso.
SezioneContabileIncassoTesto—vuotoSezione contabile incasso.
ClassificazioneTesto—vuotoCodice della classificazione.

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": 31,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListPagamenti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CalcoloSpese": false,
      "TipoCalcolo": "ESEMPIO",
      "ValoreCalcolo": 1,
      "VoceSpesa": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 31,
  "GuidPC": "gestionale-01",
  "ObjectListPagamenti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Esercizi

Esercizi: gli esercizi contabili e di magazzino

Esercizi: gli esercizi contabili e di magazzino. Nel web service è il tipo ESERCIZI (valore 33 di DataType); gli oggetti sono della classe Esercizi e viaggiano nella lista ObjectListEsercizi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoESERCIZI = 33
ClasseEsercizi
Lista nella richiesta e nella rispostaObjectListEsercizi
Tabella letta da QUERYEsercizi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Esercizi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
DataInizioData e ora—nessuna datadatainizioData di inizio.
DataFineData e ora—nessuna datadatafineData di fine.
ChiusoMagazzinoVero/falso—falsechiusoChiuso magazzino.
ChiusoContabilitaVero/falso—falsechiusocontabChiuso contabilita.
CodiceEspIVATesto—vuotocodespivaCodice esp IVA.
CodiceEspContabileTesto—vuotocodespcontabCodice esp contabile.

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": 33,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListEsercizi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "DataInizio": "2026-03-15T00:00:00",
      "DataFine": "2026-03-15T00:00:00",
      "ChiusoMagazzino": false,
      "ChiusoContabilita": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 33,
  "GuidPC": "gestionale-01",
  "ObjectListEsercizi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipologie di costo e ricavo

TipologiaCostoRicavo: le tipologie di costo e ricavo dei documenti

Tipologie di costo e ricavo: le tipologie di costo e ricavo dei documenti. Nel web service è il tipo TIPOLOGIACOSTORICAVO (valore 43 di DataType); gli oggetti sono della classe TipologiaCostoRicavo e viaggiano nella lista ObjectListTipologiaCostoRicavo della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTIPOLOGIACOSTORICAVO = 43
ClasseTipologiaCostoRicavo
Lista nella richiesta e nella rispostaObjectListTipologiaCostoRicavo
Tabella letta da QUERYTipologiaAcquistoDoc — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TipologiaCostoRicavo

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 43,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTipologiaCostoRicavo": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 43,
  "GuidPC": "gestionale-01",
  "ObjectListTipologiaCostoRicavo": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Piano dei conti

ContoDelPianoDeiConti: mastri, conti e sottoconti della contabilità

Piano dei conti: mastri, conti e sottoconti della contabilità. Nel web service è il tipo PIANODEICONTI (valore 46 di DataType); gli oggetti sono della classe ContoDelPianoDeiConti e viaggiano nella lista ObjectListPianoDeiConti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoPIANODEICONTI = 46
ClasseContoDelPianoDeiConti
Lista nella richiesta e nella rispostaObjectListPianoDeiConti
Tabella letta da QUERYPianoDeiConti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»

I campi di ContoDelPianoDeiConti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
CodicePadreTesto—vuotocodpadreCodice padre.
TipoContoTesto—vuototipocontoTipo conto.
TipoIntero—1tipoTipo.
UltimoIntero—0ultimoUltimo.
CodiceExportTesto—vuotocodexpCodice da usare nei tracciati di esportazione.
RappresentazioneBilancioTesto—vuotorapprbilancioRappresentazione bilancio.
ContoResocontoCassaTesto—vuotocontoresocontocassaConto resoconto cassa.
ObsoletoVero/falso—falseobsoletoVero se il record non è più in uso: resta in archivio ma non viene proposto.
ObsoletoDalData e ora—nessuna dataobsoletodalData da cui il record è obsoleto.

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": 46,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListPianoDeiConti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CodicePadre": "COD002",
      "TipoConto": "ESEMPIO",
      "Tipo": 1,
      "Ultimo": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 46,
  "GuidPC": "gestionale-01",
  "ObjectListPianoDeiConti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

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.

Rimesse sulle scadenze

DocumentiRimessaSuScadenza: gli incassi e i pagamenti registrati sulle scadenze

Rimesse sulle scadenze: gli incassi e i pagamenti registrati sulle scadenze. Nel web service è il tipo DOCUMENTIRIMESSASUSCADENZE (valore 54 di DataType); gli oggetti sono della classe DocumentiRimessaSuScadenza e viaggiano nella lista ObjectListDocumentiRimessaSuScadenza della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDOCUMENTIRIMESSASUSCADENZE = 54
ClasseDocumentiRimessaSuScadenza
Lista nella richiesta e nella rispostaObjectListDocumentiRimessaSuScadenza
Tabella letta da QUERYDocumentiPartite — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveDocRimessaTipo + DocRimessaEsercizio + DocRimessaSerie + DocRimessaRegistro + DocRimessaNumero + DocRimessaTipoControparte + DocRimessaControparte + DocRimessaProgressivo + DocRimessaProgrID — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassDocRimessaTipo|DocRimessaEsercizio|DocRimessaSerie|DocRimessaRegistro|DocRimessaNumero|DocRimessaTipoControparte|DocRimessaControparte|DocRimessaProgressivo|DocRimessaProgrID
Chiave per le conferme di ricezioneDocRimessaTipo|DocRimessaEsercizio|DocRimessaSerie|DocRimessaRegistro|DocRimessaNumero|DocRimessaControparte|DocRimessaTipoControparte|DocRimessaProgressivo|DocRimessaProgrID — come si usa
Controlli prima del salvataggioDocRimessaTipo: «Tipo documento non specificato»
DocRimessaEsercizio: «Esercizio documento non specificato»
DocRimessaNumero: «Numero documento non specificato»
DocRimessaTipoControparte: «Tipo controparte non specificato»
DocRimessaControparte: «Controparte non specificato»
Data: «Data non specificata»

I campi di DocumentiRimessaSuScadenza

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
DocRimessaTipoTestoChiave, sìvuototipoDoc rimessa tipo. Se manca il server risponde «Tipo documento non specificato».
DocRimessaEsercizioTestoChiave, sìvuotoesercizioDoc rimessa esercizio. Se manca il server risponde «Esercizio documento non specificato».
DocRimessaSerieTestoChiavevuotoserieDoc rimessa serie.
DocRimessaRegistroTestoChiavevuotoregDoc rimessa registro.
DocRimessaNumeroIntero lungoChiave, sì0numeroDoc rimessa numero. Se manca il server risponde «Numero documento non specificato».
DocRimessaTipoControparteTestoChiave, sìvuototipocliforDoc rimessa tipo controparte. Se manca il server risponde «Tipo controparte non specificato».
DocRimessaControparteTestoChiave, sìvuotocontroparteDoc rimessa controparte. Se manca il server risponde «Controparte non specificato».
DocRimessaProgressivoInteroChiave0progressivoDoc rimessa progressivo.
DocRimessaProgrIDInteroChiave0progridDoc rimessa progr ID.
TipoScadenzaTesto—vuototiposcadenzaTipo scadenza.
DataData e oraSìnessuna datadataData. Se manca il server risponde «Data non specificata».
OraData e ora—nessuna dataoraOra.
ImportoDecimale—0importoImporto.
EffettoPagamentoEffettiIncassoPagamento—null—Effetto pagamento.
NumassegnoTesto—vuotonumassegnoNumassegno.
BancaTesto—vuotobancaBanca.
FilialeTesto—vuotofilialeFiliale.
DataassegnoData e ora—nessuna datadataassDataassegno.
DataVersamentoData e ora—nessuna datadataversData versamento.
ControPartitaTesto—vuotocontropartitaContro partita.
SezioneContabileTesto—vuotosezcontabileSezione contabile. Codice dell'archivio Sezioni contabili.
NoteTesto—vuotonoterimNote libere.
ImportoSpeseDecimale—0speseimportoImporto spese.
SpeseContropartitaTesto—vuotospesecontroSpese contropartita.
InsolutoVero/falso—falseinsolutoInsoluto.
UserInsertTesto—vuotouserinsertUser insert.
DataOfUserInsertData e ora—nessuna datadatainsData of user insert.
OraOfUserInsertData e ora—nessuna dataorainsOra of user insert.
UserModifyTesto—vuotousermodifyUser modify.
ImportoAbbuonoDecimale—0importoabbuonoImporto abbuono.
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.

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": 54,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDocumentiRimessaSuScadenza": [
    {
      "DocRimessaTipo": "COD001",
      "DocRimessaEsercizio": "COD002",
      "DocRimessaSerie": "COD003",
      "DocRimessaRegistro": "COD004",
      "DocRimessaNumero": 1,
      "DocRimessaTipoControparte": "COD005",
      "DocRimessaControparte": "COD006",
      "DocRimessaProgressivo": 1,
      "DocRimessaProgrID": 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": 54,
  "GuidPC": "gestionale-01",
  "SQLFilter": "DocumentiPartite.Tipo = 'COD001'",
  "QueryParameter": {
    "IgnoreImportRecord": true,
    "StartingRecord": 1,
    "LimitRecord": 100
  }
}

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 54,
  "GuidPC": "gestionale-01",
  "ObjectListDocumentiRimessaSuScadenza": [
    {
      "DocRimessaTipo": "COD001",
      "DocRimessaEsercizio": "COD002",
      "DocRimessaSerie": "COD003",
      "DocRimessaRegistro": "COD004",
      "DocRimessaNumero": 1,
      "DocRimessaTipoControparte": "COD006",
      "DocRimessaControparte": "COD007",
      "DocRimessaProgressivo": 1,
      "DocRimessaProgrID": 1
    }
  ]
}

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

Effetti

EffettiIncassoPagamento: ricevute bancarie e altri effetti di incasso e pagamento

Effetti: ricevute bancarie e altri effetti di incasso e pagamento. Nel web service è il tipo EFFETTIINCASSOPAGAMENTO (valore 55 di DataType); gli oggetti sono della classe EffettiIncassoPagamento e viaggiano nella lista ObjectListEffettiIncassoPagamento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoEFFETTIINCASSOPAGAMENTO = 55
ClasseEffettiIncassoPagamento
Lista nella richiesta e nella rispostaObjectListEffettiIncassoPagamento
Tabella letta da QUERYEffetti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveIDEffetto — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassIDEffetto
Chiave per le conferme di ricezioneIDEffetto — come si usa
Controlli prima del salvataggioIDEffetto: «Id effetto non specificata»
DataEmissione: «Data non specificata»

I campi di EffettiIncassoPagamento

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
IDEffettoInteroChiave, sì0idID effetto. Se manca il server risponde «Id effetto non specificata».
TipoEffettoTesto—vuototipoeffettoTipo effetto.
DataEmissioneData e oraSìnessuna datadataemissioneData emissione. Se manca il server risponde «Data non specificata».
DataScadenzaData e ora—nessuna datadatascadenzaData scadenza.
ContoAssegnazioneTesto—vuotocontoassegnazioneConto assegnazione.
NumeroTesto—vuotonumeroNumero.
ABITesto—vuotoabiABI.
CABTesto—vuotocabCAB.
ImportoDecimale—0importoImporto.
DataVersamentoData e ora—nessuna datadataversData versamento.
InsolutoVero/falso—falseinsolutoInsoluto.
DataInserimentoData e ora—nessuna datadatainsData di inserimento.
NoteTesto—vuotonoteNote libere.
EmittenteTesto—vuotointestatarioEmittente.
TipoCliForTesto—vuototipocliforTipo cli for.
CodiceCliForTesto—vuotocodicecliforCodice cli for.
FileAllegatiElenco di ImageTrasmission—elenco vuoto—File allegati.

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": 55,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListEffettiIncassoPagamento": [
    {
      "IDEffetto": 1,
      "TipoEffetto": "ESEMPIO",
      "DataEmissione": "2026-03-15T00:00:00",
      "DataScadenza": "2026-03-15T00:00:00",
      "ContoAssegnazione": "ESEMPIO",
      "Numero": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 55,
  "GuidPC": "gestionale-01",
  "ObjectListEffettiIncassoPagamento": [
    {
      "IDEffetto": 1
    }
  ]
}

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

Classificazione delle scadenze

ClassificazioneScadenze: le classi con cui si ordinano le scadenze

Classificazione delle scadenze: le classi con cui si ordinano le scadenze. Nel web service è il tipo CLASSIFICAZIONESCADENZE (valore 56 di DataType); gli oggetti sono della classe ClassificazioneScadenze e viaggiano nella lista ObjectListClassificazioneScadenze della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCLASSIFICAZIONESCADENZE = 56
ClasseClassificazioneScadenze
Lista nella richiesta e nella rispostaObjectListClassificazioneScadenze
Tabella letta da QUERYClassificazioneScadenze — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di ClassificazioneScadenze

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ColoreIntero lungo—0coloreColore, in esadecimale.

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": 56,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListClassificazioneScadenze": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Colore": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 56,
  "GuidPC": "gestionale-01",
  "ObjectListClassificazioneScadenze": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di rimessa

TipoRimessa: i tipi di rimessa, come bonifico, contanti o assegno

Tipi di rimessa: i tipi di rimessa, come bonifico, contanti o assegno. Nel web service è il tipo TIPORIMESSA (valore 57 di DataType); gli oggetti sono della classe TipoRimessa e viaggiano nella lista ObjectListTipoRimessa della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoTIPORIMESSA = 57
ClasseTipoRimessa
Lista nella richiesta e nella rispostaObjectListTipoRimessa
Tabella letta da QUERYTipoRimessa — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di TipoRimessa

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CreaEffettoVero/falso—falsecreaeffettoCrea effetto.
RibaVero/falso—falseribaRiba.
CreaInsolutoVero/falso—falsecreainsolutoCrea insoluto.
SaldoControDocVero/falso—falsesaldocontrodocSaldo contro doc.
ModalitaPagamentoFatturaPATesto—vuotomodpagamentofattpaModalità pagamento fattura PA.

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": 57,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListTipoRimessa": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CreaEffetto": false,
      "Riba": false,
      "CreaInsoluto": false,
      "SaldoControDoc": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 57,
  "GuidPC": "gestionale-01",
  "ObjectListTipoRimessa": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tariffazioni speciali

DHMTariffazioneSpeciale: le tariffe speciali applicate agli animali

Tariffazioni speciali: le tariffe speciali applicate agli animali. Nel web service è il tipo DHMTARIFFAZIONESPECIALE (valore 58 di DataType); gli oggetti sono della classe DHMTariffazioneSpeciale e viaggiano nella lista ObjectListDHMTariffazioneSpeciale della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTARIFFAZIONESPECIALE = 58
ClasseDHMTariffazioneSpeciale
Lista nella richiesta e nella rispostaObjectListDHMTariffazioneSpeciale
Tabella letta da QUERYDHMTariffazioneSpeciale — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTariffazioneSpeciale

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 58,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTariffazioneSpeciale": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 58,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTariffazioneSpeciale": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di certificato di smaltimento

DHMTipiCertificatiSmaltimento: i certificati di smaltimento e incenerimento

Tipi di certificato di smaltimento: i certificati di smaltimento e incenerimento. Nel web service è il tipo DHMTIPICERTIFICATISMALTIMENTO (valore 59 di DataType); gli oggetti sono della classe DHMTipiCertificatiSmaltimento e viaggiano nella lista ObjectListDHMTipiCertificatiSmaltimento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPICERTIFICATISMALTIMENTO = 59
ClasseDHMTipiCertificatiSmaltimento
Lista nella richiesta e nella rispostaObjectListDHMTipiCertificatiSmaltimento
Tabella letta da QUERYDHMTipiCertificati — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipiCertificatiSmaltimento

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
DescrizioneStampaTesto—vuotodescrstampaDescrizione stampa.
ArticoloRiferimentoTesto—vuotoarticolorifArticolo riferimento.
AbilitaRestituzioneVero/falso—falseabilitarestituzioneAbilita restituzione.

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": 59,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipiCertificatiSmaltimento": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "DescrizioneStampa": "Descrizione di esempio",
      "ArticoloRiferimento": "ESEMPIO",
      "AbilitaRestituzione": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 59,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipiCertificatiSmaltimento": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di intervento

DHMTipiInterventi: gli interventi di accalappiamento e recupero

Tipi di intervento: gli interventi di accalappiamento e recupero. Nel web service è il tipo DHMTIPIINTERVENTI (valore 60 di DataType); gli oggetti sono della classe DHMTipiInterventi e viaggiano nella lista ObjectListDHMTipiInterventi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPIINTERVENTI = 60
ClasseDHMTipiInterventi
Lista nella richiesta e nella rispostaObjectListDHMTipiInterventi
Tabella letta da QUERYDHMTipiInterventi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipiInterventi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CodiceArticoloTesto—vuotocodarticoloCodice dell'articolo. Codice dell'archivio Articoli.

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": 60,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipiInterventi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CodiceArticolo": "COD002"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 60,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipiInterventi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipologie di fatturazione

DHMTipologiaFatturazioneAnimali: le tipologie con cui si fatturano gli animali ospitati

Tipologie di fatturazione: le tipologie con cui si fatturano gli animali ospitati. Nel web service è il tipo DHMTIPOLOGIAFATTURAZIONEANIMALI (valore 61 di DataType); gli oggetti sono della classe DHMTipologiaFatturazioneAnimali e viaggiano nella lista ObjectListDHMTipologiaFatturazioneAnimali della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPOLOGIAFATTURAZIONEANIMALI = 61
ClasseDHMTipologiaFatturazioneAnimali
Lista nella richiesta e nella rispostaObjectListDHMTipologiaFatturazioneAnimali
Tabella letta da QUERYDHMTipocane — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipologiaFatturazioneAnimali

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
StampaDettaglioVero/falso—falsestampadettStampa dettaglio.
DescrizioneInStampaTesto—vuotodesstampaDescrizione in stampa.
ImportoBaseDecimale—0importoImporto base.

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": 61,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipologiaFatturazioneAnimali": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "StampaDettaglio": false,
      "DescrizioneInStampa": "Descrizione di esempio",
      "ImportoBase": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 61,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipologiaFatturazioneAnimali": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Specie animali

DHMSpecieAnimali: le specie degli animali, come cane o gatto

Specie animali: le specie degli animali, come cane o gatto. Nel web service è il tipo DHMSPECIEANIMALI (valore 62 di DataType); gli oggetti sono della classe DHMSpecieAnimali e viaggiano nella lista ObjectListDHMSpecieAnimali della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMSPECIEANIMALI = 62
ClasseDHMSpecieAnimali
Lista nella richiesta e nella rispostaObjectListDHMSpecieAnimali
Tabella letta da QUERYDHMTipiAnimali — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMSpecieAnimali

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 62,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMSpecieAnimali": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 62,
  "GuidPC": "gestionale-01",
  "ObjectListDHMSpecieAnimali": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Taglie

DHMTaglie: le taglie degli animali

Taglie: le taglie degli animali. Nel web service è il tipo DHMTAGLIE (valore 64 di DataType); gli oggetti sono della classe DHMTaglie e viaggiano nella lista ObjectListDHMTaglie della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTAGLIE = 64
ClasseDHMTaglie
Lista nella richiesta e nella rispostaObjectListDHMTaglie
Tabella letta da QUERYDHMTaglie — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTaglie

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
MQOccupatiDecimale—0mqoccupatiMQ occupati.
MQOccupatiPerPensionePrivatiDecimale—0mqoccupatiprivatiMQ occupati per pensione privati.

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": 64,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTaglie": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "MQOccupati": 1,
      "MQOccupatiPerPensionePrivati": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 64,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTaglie": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Razze

DHMRazze: le razze degli animali

Razze: le razze degli animali. Nel web service è il tipo DHMRAZZE (valore 65 di DataType); gli oggetti sono della classe DHMRazze e viaggiano nella lista ObjectListDHMRazze della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMRAZZE = 65
ClasseDHMRazze
Lista nella richiesta e nella rispostaObjectListDHMRazze
Tabella letta da QUERYDHMRazze — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»
SpecieAnimale: «Specie non specificata»

I campi di DHMRazze

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
SpecieAnimaleTestoSìvuototipoanimaleSpecie animale. Se manca il server risponde «Specie non specificata».

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": 65,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMRazze": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "SpecieAnimale": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 65,
  "GuidPC": "gestionale-01",
  "ObjectListDHMRazze": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di prelievo

DHMTipoPrelievi: i prelievi eseguiti sugli animali

Tipi di prelievo: i prelievi eseguiti sugli animali. Nel web service è il tipo DHMTIPOPRELIEVI (valore 66 di DataType); gli oggetti sono della classe DHMTipoPrelievi e viaggiano nella lista ObjectListDHMTipoPrelievi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPOPRELIEVI = 66
ClasseDHMTipoPrelievi
Lista nella richiesta e nella rispostaObjectListDHMTipoPrelievi
Tabella letta da QUERYDHMTipoPrelievi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipoPrelievi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 66,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipoPrelievi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 66,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipoPrelievi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Eventi degli animali

DHMEventiAssociatiAnimali: gli eventi che si registrano nella storia di un animale

Eventi degli animali: gli eventi che si registrano nella storia di un animale. Nel web service è il tipo DHMEVENTI (valore 67 di DataType); gli oggetti sono della classe DHMEventiAssociatiAnimali e viaggiano nella lista ObjectListDHMEventiAssociatiAnimali della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMEVENTI = 67
ClasseDHMEventiAssociatiAnimali
Lista nella richiesta e nella rispostaObjectListDHMEventiAssociatiAnimali
Tabella letta da QUERYDHMEventi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMEventiAssociatiAnimali

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSì—descrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoEventoScaricoTesto—"S"tipoeventoTipo evento scarico.
TipoRichiestaDatiAggiuntivaTesto—"N"riccontroTipo richiesta dati aggiuntiva.
SiglaInStampaTesto—vuotosiglainstampaSigla in stampa.
AttivaAlertVero/falso—falseattivaalertAttiva alert.
AttivaAlertNumeroGiorniIntero—0giorniAttiva alert numero giorni.
AttivaAlertMessaggioTesto—vuotomessaggioAttiva alert messaggio.
NonConteggiareGiornoScaricoSuFatturazioneVero/falso—falsenoncontgiornoscarNon conteggiare giorno scarico su fatturazione.

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": 67,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMEventiAssociatiAnimali": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "TipoEventoScarico": "ESEMPIO",
      "TipoRichiestaDatiAggiuntiva": "ESEMPIO",
      "SiglaInStampa": "ESEMPIO",
      "AttivaAlert": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 67,
  "GuidPC": "gestionale-01",
  "ObjectListDHMEventiAssociatiAnimali": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Enti sterilizzatori

DHMEntiSterilizzatori: gli enti che eseguono le sterilizzazioni

Enti sterilizzatori: gli enti che eseguono le sterilizzazioni. Nel web service è il tipo DHMENTISTERILIZZATORI (valore 68 di DataType); gli oggetti sono della classe DHMEntiSterilizzatori e viaggiano nella lista ObjectListDHMEntiSterilizzatori della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMENTISTERILIZZATORI = 68
ClasseDHMEntiSterilizzatori
Lista nella richiesta e nella rispostaObjectListDHMEntiSterilizzatori
Tabella letta da QUERYDHMEntiSterilizzatori — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMEntiSterilizzatori

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
RecapitiTelefoniciTesto—vuotorecapitiRecapiti telefonici.
EmailTesto—vuotoemailIndirizzo email.
NoteTesto—vuotonoteNote 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": 68,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMEntiSterilizzatori": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "RecapitiTelefonici": "ESEMPIO",
      "Email": "ESEMPIO",
      "Note": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 68,
  "GuidPC": "gestionale-01",
  "ObjectListDHMEntiSterilizzatori": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Strutture ospitanti

DHMStruttureOspitanti: i canili, i gattili e le strutture che ospitano gli animali

Strutture ospitanti: i canili, i gattili e le strutture che ospitano gli animali. Nel web service è il tipo DHMSTRUTTUREOSPITANTI (valore 69 di DataType); gli oggetti sono della classe DHMStruttureOspitanti e viaggiano nella lista ObjectListDHMStruttureOspitanti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMSTRUTTUREOSPITANTI = 69
ClasseDHMStruttureOspitanti
Lista nella richiesta e nella rispostaObjectListDHMStruttureOspitanti
Tabella letta da QUERYDHMStructOspitanti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMStruttureOspitanti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoTesto—vuototipoTipo.

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": 69,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMStruttureOspitanti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Tipo": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 69,
  "GuidPC": "gestionale-01",
  "ObjectListDHMStruttureOspitanti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Educatori cinofili

DHMEducatoriCinofili: gli educatori che seguono gli animali

Educatori cinofili: gli educatori che seguono gli animali. Nel web service è il tipo DHMEDUCATORICINOFILI (valore 70 di DataType); gli oggetti sono della classe DHMEducatoriCinofili e viaggiano nella lista ObjectListDHMEducatoriCinofili della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMEDUCATORICINOFILI = 70
ClasseDHMEducatoriCinofili
Lista nella richiesta e nella rispostaObjectListDHMEducatoriCinofili
Tabella letta da QUERYDHMEducatoriCinofili — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMEducatoriCinofili

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 70,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMEducatoriCinofili": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 70,
  "GuidPC": "gestionale-01",
  "ObjectListDHMEducatoriCinofili": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Stati degli animali

DHMStatoAnimali: gli stati in cui si trova un animale

Stati degli animali: gli stati in cui si trova un animale. Nel web service è il tipo DHMSTATOANIMALI (valore 71 di DataType); gli oggetti sono della classe DHMStatoAnimali e viaggiano nella lista ObjectListDHMStatoAnimali della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMSTATOANIMALI = 71
ClasseDHMStatoAnimali
Lista nella richiesta e nella rispostaObjectListDHMStatoAnimali
Tabella letta da QUERYDHMStatoAnimali — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMStatoAnimali

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 71,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMStatoAnimali": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 71,
  "GuidPC": "gestionale-01",
  "ObjectListDHMStatoAnimali": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di adottabilità

DHMTipoAdottabile: le condizioni con cui un animale è adottabile

Tipi di adottabilità: le condizioni con cui un animale è adottabile. Nel web service è il tipo DHMTIPOADOTTABILE (valore 72 di DataType); gli oggetti sono della classe DHMTipoAdottabile e viaggiano nella lista ObjectListDHMTipoAdottabile della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPOADOTTABILE = 72
ClasseDHMTipoAdottabile
Lista nella richiesta e nella rispostaObjectListDHMTipoAdottabile
Tabella letta da QUERYDHMTipoAdottabile — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipoAdottabile

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
ListaEventiElenco di DHMTipoAdottabileEventi—elenco vuoto—Eventi: elenco di oggetti DHMTipoAdottabileEventi.

Classe annidata DHMTipoAdottabileEventi

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

CampoTipoObbligatorioPredefinitoA cosa serve
ProgressivoIntero—0Numero progressivo della riga all'interno del record principale.
EventoTesto—vuotoEvento.
TipoOperazioneTesto—vuotoTipo operazione.
MessaggioTesto—vuotoMessaggio.

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": 72,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipoAdottabile": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 72,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipoAdottabile": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Affidatari

DHMAffidatari: le persone e gli enti a cui sono affidati gli animali

Affidatari: le persone e gli enti a cui sono affidati gli animali. Nel web service è il tipo DHMAFFIDATARI (valore 73 di DataType); gli oggetti sono della classe DHMAffidatari e viaggiano nella lista ObjectListDHMAffidatari della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMAFFIDATARI = 73
ClasseDHMAffidatari
Lista nella richiesta e nella rispostaObjectListDHMAffidatari
Tabella letta da QUERYDHMAffidatari — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice + Tipo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice|Tipo
Chiave per le conferme di ricezioneCodice|Tipo — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Nome: «Nome non specificato»
Cognome: «Cognome non specificato»
Tipo: «Tipo non specificato»

I campi di DHMAffidatari

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
TipoTestoChiave, sì"A"tipoTipo. Se manca il server risponde «Tipo non specificato».
NomeTestoSìvuotonomeNome. Se manca il server risponde «Nome non specificato».
CognomeTestoSìvuotocognomeCognome. Se manca il server risponde «Cognome non specificato».
ComuneNascitaISTATTesto——natoaComune nascita ISTAT.
ComuneNascitaTesto—vuotonatoacittaComune nascita.
NazioneNascitaTesto—vuotonazionenascNazione nascita.
DataDiNascitaData e ora—nessuna datanatoilData di nascita.
SessoTesto—vuotosessoSesso.
CodiceFiscaleTesto—vuotocfCodice fiscale.
NumeroDocumentoDiRiconoscimentoTesto—vuotodocumentoNumero documento di riconoscimento.
TipoDocumentoDiRiconoscimentoTesto—vuototipodocTipo documento di riconoscimento.
TipoDocumentoDiRiconoscimentoDescrizioneTesto—vuotodestipodocDescrizione di TipoDocumentoDiRiconoscimento, riportata per comodità di chi legge.
DocumentoDiRiconoscimentoRilasciatoDaTesto—vuotorilasciatoDocumento di riconoscimento rilasciato da.
DocumentoDiRiconoscimentoDataRilascioData e ora—nessuna datadatarilDocumento di riconoscimento data rilascio.
DocumentoDiRiconoscimentoDataScadenzaData e ora—nessuna datadatascadenzaDocumento di riconoscimento data scadenza.
IndirizzoTesto—vuotoindirizzoIndirizzo (via e numero civico).
CAPTesto—vuotocapCodice di avviamento postale.
CittaTesto—vuotocittaCittà.
ProvinciaTesto—vuotoprovSigla della provincia.
TelefonoTesto—vuototelefonoNumero di telefono.
NoteTesto—vuotonoteNote libere.
EmailTesto—vuotoemailIndirizzo email.
EmailPECTesto—vuotopecEmail PEC.
CategoriaAnagraficaTesto—vuotocategoriaCategoria anagrafica. Codice dell'archivio Categorie anagrafiche.
CategoriaAnagraficaDescrizioneTesto—vuotodescataffDescrizione di CategoriaAnagrafica, riportata per comodità di chi legge.
AziendaRagioneSocialeTesto—vuotoazragsocAzienda ragione sociale.
AziendaIndirizzoTesto—vuotoazindirizzoAzienda indirizzo.
AziendaCAPTesto—vuotoazcapAzienda CAP.
AziendaCittaTesto—vuotoazcittaAzienda città.
AziendaProvinciaTesto—vuotoazprovAzienda provincia.
AziendaPartitaIVATesto—vuotoazpartitaivaAzienda partita IVA.
AziendaCodiceFiscaleTesto—vuotoazcodfiscaleAzienda codice fiscale.
AziendaTelefonoTesto—vuotoaztelefonoAzienda telefono.
AziendaEmailTesto—vuotoazemailAzienda email.
AziendaPECTesto—vuotoazpecAzienda PEC.
ListaFileAllegatiElenco di ImageTrasmission—elenco vuoto—File allegati.

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": 73,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMAffidatari": [
    {
      "Codice": "COD001",
      "Tipo": "COD002",
      "Nome": "Esempio",
      "Cognome": "ESEMPIO",
      "ComuneNascitaISTAT": "ESEMPIO",
      "ComuneNascita": "ESEMPIO",
      "NazioneNascita": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 73,
  "GuidPC": "gestionale-01",
  "ObjectListDHMAffidatari": [
    {
      "Codice": "COD001",
      "Tipo": "COD002"
    }
  ]
}

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

Animali

DHMAnimali: la scheda completa dell'animale con vaccini, trattamenti, esami, spostamenti e addebiti

Animali: la scheda completa dell'animale con vaccini, trattamenti, esami, spostamenti e addebiti. Nel web service è il tipo DHMANIMALI (valore 74 di DataType); gli oggetti sono della classe DHMAnimali e viaggiano nella lista ObjectListDHMAnimali della richiesta e della risposta.

La scheda dell'animale di Dog House Management, identificata dal suo numero interno. Insieme ai dati dell'animale viaggiano gli elenchi della sua storia: prelievi, alimentazione, addebiti al cliente, vaccini, trattamenti, terapie, corsi, sgambamenti, avvisi, patologie, spostamenti tra strutture, rinuncia, scarico, esami e schede comportamentali.

Scheda tecnica

VoceValore
Tipo di datoDHMANIMALI = 74
ClasseDHMAnimali
Lista nella richiesta e nella rispostaObjectListDHMAnimali
Tabella letta da QUERYDHMCani — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveIdentificativo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassIdentificativo
Chiave per le conferme di ricezioneIdentificativo — come si usa
Controlli prima del salvataggioIdentificativo: «Identificativo non specificato»
ClienteFatturazione: «Cliente fatturazione non specificato»
SpecieAnimale: «Specie animale non specificata»
Razza: «Razza non specificata»
DataIngresso: «Data ingresso non specificata»
DestinazioneAnimale: «Destinazione animale non specificata»

I campi di DHMAnimali

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
IdentificativoTestoChiave, sìvuotoidIdentificativo. Se manca il server risponde «Identificativo non specificato».
ScaricatoVero/falso—falsemortoScaricato.
DataScaricoData e ora—nessuna datadatamorteData scarico.
DataInserimentoData e ora—nessuna datadatainsData di inserimento.
OraInserimentoData e ora—nessuna dataorainsOra di inserimento.
DestinazioneAnimaleTestoSìvuotodestinazioneanimaleDestinazione animale. Se manca il server risponde «Destinazione animale non specificata».
ClienteFatturazioneTestoSìvuotocodclienteCliente fatturazione. Se manca il server risponde «Cliente fatturazione non specificato».
ClienteFatturazioneDettaglioClientiFornitori—null—Cliente fatturazione dettaglio.
ClienteProprietarioTesto—vuotocomunesostCliente proprietario.
ClienteProprietarioDettaglioClientiFornitori—null—Cliente proprietario dettaglio.
MicrochipTesto—vuotonumchipMicrochip.
VecchioMicrochipTesto—vuotooldnumchipVecchio microchip.
NomeTesto—vuotonomeNome.
RazzaTestoSìvuotorazzaRazza. Se manca il server risponde «Razza non specificata».
TagliaTesto—vuototagliaTaglia.
NoteTesto—vuotonoteNote libere.
TatuaggioTesto—vuototatuaggioTatuaggio.
ColoreTesto—vuotocoloreColore, in esadecimale.
SessoTesto—vuotosessoSesso.
DataIngressoData e oraSìnessuna datadataData ingresso. Se manca il server risponde «Data ingresso non specificata».
NumeroBoxIntero—0nboxNumero del box.
StatoAnimaleTesto—vuotostatoanStato animale.
PesoKgDecimale—0kgPeso kg.
RegistroRifugioIntero—0progrregRegistro rifugio.
DataNascitaData e ora—nessuna datadatanascData nascita.
SterilizzatoCastratoVero/falso—falsestercastrSterilizzato castrato.
SegniParticolariTesto—vuotosegnpartSegni particolari.
SchieraTesto—vuotoschieraSchiera.
TipologiaFatturazione1Testo—vuototipocaneTipologia fatturazione 1.
DataInizioTipologiaFatturazione1Data e ora—nessuna datatipo1dalData inizio tipologia fatturazione 1.
DataFineTipologiaFatturazione1Data e ora—nessuna datatipo1alData fine tipologia fatturazione 1.
TipologiaFatturazione2Testo—vuototipocane2Tipologia fatturazione 2.
DataInizioTipologiaFatturazione2Data e ora—nessuna datatipo2dalData inizio tipologia fatturazione 2.
DataFineTipologiaFatturazione2Data e ora—nessuna datatipo2alData fine tipologia fatturazione 2.
TipologiaFatturazione3Testo—vuototipocane3Tipologia fatturazione 3.
DataInizioTipologiaFatturazione3Data e ora—nessuna datatipo3dalData inizio tipologia fatturazione 3.
DataFineTipologiaFatturazione3Data e ora—nessuna datatipo3alData fine tipologia fatturazione 3.
SchedaAccalappiamentoProtocolloTesto—vuotoschedaaccScheda accalappiamento protocollo.
SchedaAccalappiamentoDataCatturaData e ora—nessuna datadataaccScheda accalappiamento data cattura.
SchedaAccalappiamentoIndirizzoCatturaTesto—vuotoindirizzoaccScheda accalappiamento indirizzo cattura.
SchedaAccalappiamentoCittaCatturaTesto—vuotocittaaccScheda accalappiamento città cattura.
SchedaAccalappiamentoNoteTesto—vuotonoteaccalapScheda accalappiamento note.
TipoPeloTesto—vuototipopeloTipo pelo.
VisualizzaUtenteStandardVero/falso—falsevisutestandVisualizza utente standard.
VisualizzaUtenteComunaleVero/falso—falsevisutecomVisualizza utente comunale.
SpecieAnimaleTestoSìvuototipoanimaleSpecie animale. Se manca il server risponde «Specie animale non specificata».
DataSterilizzazioneData e ora—nessuna datadatasterData sterilizzazione.
EnteSterilizzazioneTesto—vuotoentesterEnte sterilizzazione.
OspitatoPressoAltraStrutturaVero/falso—falsepressoterziOspitato presso altra struttura.
StrutturaOspitanteTesto—vuotostrutturaospStruttura ospitante.
EsclusioneDaFatturaDataInizioData e ora—nessuna dataescldadataEsclusione da fattura data inizio.
EsclusioneDaFatturaDataFineData e ora—nessuna dataescladataEsclusione da fattura data fine.
RegistroSanitarioTesto—vuotoregsanRegistro sanitario.
DataInserimentoMicrochipData e ora—nessuna datadatainsmicrochipData inserimento microchip.
AdottabileVero/falso—falseadottabileAdottabile.
ModalitaIngressoTesto—vuotomodingressoModalità ingresso.
StatoMicrochipIngressoTesto—vuotostatomicrochipStato microchip ingresso.
GenitoriIDMadreTesto—vuotocodmadreGenitori ID madre.
GenitoriIDPadreTesto—vuotocodpadreGenitori ID padre.
AnagraficaDaNonConteggiareVero/falso—falsedanonconteggiareAnagrafica da non conteggiare.
TipologiaAdottabileTesto—vuototipologiaadottabileTipologia adottabile.
VeterinarioMicrochipTesto—vuotoveterinariomicrochipVeterinario microchip.
AlimentazioneDescrittivaTesto—vuotoalimentazioneAlimentazione descrittiva.
SchedaComportamentaleTesto—vuotoschedacomportScheda comportamentale.
AslDiRiferimentoTesto—vuotoaslrifASL di riferimento.
ROITesto—vuotoroiROI.
RSRTesto—vuotorsrRSR.
DepositoDNAVero/falso—falsedepdnaDeposito DNA.
DataUltimoCaloreData e ora—nessuna datadataultcaloreData ultimo calore.
DataUltimaMontaData e ora—nessuna datadataultmontaData ultima monta.
DataUltimaNascitaData e ora—nessuna datadataultnascitaData ultima nascita.
DataMinimaProssimaCaloreData e ora—nessuna datadataminproxcaloreData minima prossima calore.
DataMassimaProssimaCaloreData e ora—nessuna datadatamaxproxcaloreData massima prossima calore.
VideoYouTubeTesto—vuotovideoyoutubeVideo you tube.
VideoYouTube2Testo—vuotovideoyoutube2Video you tube 2.
VideoYouTube3Testo—vuotovideoyoutube3Video you tube 3.
MostraInHomeWebVero/falso—falsemostrainhomewebMostra in home web.
DimensioneGiroTestaDecimale—0dimgirotestaDimensione giro testa.
DimensioneLunghezzaDecimale—0dimlunghezzaDimensione lunghezza.
DimensioneGirocolloDecimale—0dimgirocolloDimensione girocollo.
DimensioneGirotoraceDecimale—0dimgirotoraceDimensione girotorace.
DimensioneAltezzaGarreseDecimale—0dimaltezzagarreseDimensione altezza garrese.
DisegnoAnimaleTesto—vuoto—Disegno animale.
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
DescrizioneDettagliataTesto—vuotodescrizionedettDescrizione estesa, anche in HTML.
EscludiExportVero/falso—falseescludiexportEscludi export.
ConsensoInformatoDescrizioneTesto—vuotoconsinfdescrizioneConsenso informato descrizione.
ConsensoInformatoListaElementiElenco di Testo—elenco vuotoconsinflistaelementiConsenso informato elenco elementi.
CategoriaAnimaleTesto—vuotocategoriaCategoria animale.
MicrochipNonLeggibileVero/falso—falsemicrochipnonleggibileMicrochip non leggibile.
PatologieDescrittiveTesto—vuotopatologiePatologie descrittive.
InterventoAccalappiamentoAssociatoAnnoIntero—0annoIntervento accalappiamento associato anno.
InterventoAccalappiamentoAssociatoNumeroIntero—0numeroIntervento accalappiamento associato numero.
RazzaDescrizioneTesto—vuotodesrazzaDescrizione di Razza, riportata per comodità di chi legge.
TagliaDescrizioneTesto—vuotodestagliaDescrizione di Taglia, riportata per comodità di chi legge.
StatoAnimaleDescrizioneTesto—vuotodesstatoanimaleDescrizione di StatoAnimale, riportata per comodità di chi legge.
TipologiaFatturazione1DescrizioneTesto—vuotodestipocane1Descrizione di TipologiaFatturazione1, riportata per comodità di chi legge.
SchieraDescrizioneTesto—vuotodesschieraDescrizione di Schiera, riportata per comodità di chi legge.
TipologiaFatturazione2DescrizioneTesto—vuotodestipocane2Descrizione di TipologiaFatturazione2, riportata per comodità di chi legge.
TipologiaFatturazione3DescrizioneTesto—vuotodestipocane3Descrizione di TipologiaFatturazione3, riportata per comodità di chi legge.
SpecieAnimaleDescrizioneTesto—vuotodesspecieDescrizione di SpecieAnimale, riportata per comodità di chi legge.
EnteSterilizzazioneDescrizioneTesto—vuotodesentesterDescrizione di EnteSterilizzazione, riportata per comodità di chi legge.
StrutturaOspitanteDescrizioneTesto—vuotodespressoterzistructDescrizione di StrutturaOspitante, riportata per comodità di chi legge.
ModalitaIngressoDescrizioneTesto—vuotodesmetodoingressoDescrizione di ModalitaIngresso, riportata per comodità di chi legge.
TipologiaAdottabileDescrizioneTesto—vuotodestipologiaadottabileDescrizione di TipologiaAdottabile, riportata per comodità di chi legge.
VeterinarioMicrochipDescrizioneTesto—vuotodesveterinariomicrochipDescrizione di VeterinarioMicrochip, riportata per comodità di chi legge.
AslDiRiferimentoDescrizioneTesto—vuotodesaslDescrizione di AslDiRiferimento, riportata per comodità di chi legge.
CategoriaAnimaleDescrizioneTesto—vuotodescategoriaDescrizione di CategoriaAnimale, riportata per comodità di chi legge.
EventoDiScaricoEventoScarico—oggetto vuotoeventocodiceEvento di scarico.
ListaPrelieviElenco di Prelievi—elenco vuoto—Prelievi: elenco di oggetti Prelievi.
ListaAlimentazioneElenco di Alimentazione—elenco vuoto—Alimentazione: elenco di oggetti Alimentazione.
ListaEsamiElenco di DHMEsami—elenco vuoto—Esami: elenco di oggetti DHMEsami.
ListaSchedeComportamentaliElenco di DHMSchedeComportamentali—elenco vuoto—Schede comportamentali: elenco di oggetti DHMSchedeComportamentali.
ListaAddebitiAClienteElenco di AddebitiACliente—elenco vuoto—Addebiti a cliente: elenco di oggetti AddebitiACliente.
ListaVacciniElenco di Vaccini—elenco vuoto—Vaccini: elenco di oggetti Vaccini.
ListaTrattamentiElenco di Trattamenti—elenco vuoto—Trattamenti: elenco di oggetti Trattamenti.
ListaTerapieElenco di Terapie—elenco vuoto—Terapie: elenco di oggetti Terapie.
ListaCorsiAddestramentoElenco di CorsiAddestramento—elenco vuoto—Corsi addestramento: elenco di oggetti CorsiAddestramento.
ListaSgambamentiElenco di Sgambamenti—elenco vuoto—Sgambamenti: elenco di oggetti Sgambamenti.
ListaAlertElenco di Alert—elenco vuoto—Alert: elenco di oggetti Alert.
ListaPatologieElenco di Patologie—elenco vuoto—Patologie: elenco di oggetti Patologie.
ListaSpostamentiStruttureElenco di SpostamentiStrutture—elenco vuoto—Spostamenti strutture: elenco di oggetti SpostamentiStrutture.
ListaRinunceElenco di Rinuncia—elenco vuoto—Rinunce: elenco di oggetti Rinuncia.

Classe annidata EventoScarico

Elemento usato dentro DHMAnimali. 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.
SiglaInStampaTesto—vuotoSigla in stampa.
DataData e ora—nessuna dataData.
ProgressivoAnnoIntero—0Progressivo anno.
ProgressivoNumeroIntero—0Progressivo numero.
NoteTesto—vuotoNote libere.
AffidatarioDHMAffidatari—oggetto vuotoAffidatario.
AffidoAltroIndirizzoTesto—vuotoAffido altro indirizzo.
AffidoEducatoreCinofiloCheFavorisceAdozioneTesto—vuotoAffido educatore cinofilo che favorisce adozione.
AffidoEducatoreCinofiloCheFavorisceAdozioneDescrizioneTesto——Descrizione di AffidoEducatoreCinofiloCheFavorisceAdozione, riportata per comodità di chi legge.
TrasferimentoStrutturaOspitanteTesto—vuotoTrasferimento struttura ospitante.
TrasferimentoStrutturaOspitanteDescrizioneTesto—vuotoDescrizione di TrasferimentoStrutturaOspitante, riportata per comodità di chi legge.
DecessoCausaStatisticaTesto—vuotoDecesso causa statistica.
DecessoCausaStatisticaDescrizioneTesto—vuotoDescrizione di DecessoCausaStatistica, riportata per comodità di chi legge.

Classe annidata Prelievi

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataData e ora—nessuna dataData.
EsitoTesto—vuotoEsito.
EsitoDescrittivoTesto—vuotoEsito descrittivo.
MalattiaTesto—vuotoMalattia.
MalattiaDescrizioneTesto—vuotoDescrizione di Malattia, riportata per comodità di chi legge.
TipoPrelievoTesto—vuotoTipo prelievo.
TipoPrelievoDescrizioneTesto—vuotoDescrizione di TipoPrelievo, riportata per comodità di chi legge.
OsservazioniTesto—vuotoOsservazioni.
UltimoPrelievoVero/falso—falseUltimo prelievo.
VeterinarioTesto—vuotoCodice del veterinario.
VeterinarioDescrizioneTesto—vuotoDescrizione di Veterinario, riportata per comodità di chi legge.
TestDiagnosticoDescrizioneTesto—vuotoDescrizione di TestDiagnostico, riportata per comodità di chi legge.
TestDiagnosticoTesto—vuotoTest diagnostico.
SintomaticoVero/falso—falseSintomatico.

Classe annidata Alimentazione

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

CampoTipoObbligatorioPredefinitoA cosa serve
ProdottoTesto—vuotoProdotto.
ProdottoDescrizioneTesto—vuotoDescrizione di Prodotto, riportata per comodità di chi legge.
GrammiDecimale—0Grammi.
OrarioData e ora—nessuna dataOrario.
DataInizioData e ora—nessuna dataData di inizio.
DataFineData e ora—nessuna dataData di fine.

Classe annidata DHMEsami

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoEsameTesto—vuotoTipo esame.
TipoEsameDescrizioneTesto—vuotoDescrizione di TipoEsame, riportata per comodità di chi legge.
DataData e ora—nessuna dataData.
AnamnesiTesto—vuotoAnamnesi.
MotivoTesto—vuotoMotivo.
DiagnosiTesto—vuotoDiagnosi.
PrognosiTesto—vuotoPrognosi.
VeterinarioTesto—vuotoCodice del veterinario.
VeterinarioDescrizioneTesto—vuotoDescrizione di Veterinario, riportata per comodità di chi legge.
FirmaVeterinarioTesto—vuotoFirma veterinario.
CodiciEsamiElenco di Testo—elenco vuotoCodici esami.
ValoriEsamiElenco di Testo—elenco vuotoValori esami.

Classe annidata DHMSchedeComportamentali

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

CampoTipoObbligatorioPredefinitoA cosa serve
TipoSchedaTesto—vuotoTipo scheda.
TipoSchedaDescrizioneTesto—vuotoDescrizione di TipoScheda, riportata per comodità di chi legge.
DataData e ora—nessuna dataData.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
InterventoEffettuatoTesto—vuotoIntervento effettuato.
CodiciValoriElenco di Testo—elenco vuotoCodici valori.
ValoriValoriCodiceElenco di Testo—elenco vuotoValori valori codice.
DescrizioniValoriElenco di Testo—elenco vuotoDescrizioni valori.
ValoriValoriElenco di Testo—elenco vuotoValori valori.

Classe annidata AddebitiACliente

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataData e ora—nessuna dataData.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
ImportoDecimale—0Importo.
EseguitoDaTesto—vuotoEseguito da.
EseguitoDaDescrizioneTesto—vuotoDescrizione di EseguitoDa, riportata per comodità di chi legge.
AddebitoVero/falso—falseAddebito.
CodiceProdottoTesto—vuotoCodice prodotto.
CodiceProdottoDescrizioneTesto—vuotoDescrizione di CodiceProdotto, riportata per comodità di chi legge.
QtaDecimale—0Quantità.
ADataAddebitoData e ora—nessuna dataA data addebito.
AddebitoGiornalieroVero/falso—falseAddebito giornaliero.
VeterinarioTesto—vuotoCodice del veterinario.
VeterinarioDescrizioneTesto—vuotoDescrizione di Veterinario, riportata per comodità di chi legge.

Classe annidata Vaccini

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

CampoTipoObbligatorioPredefinitoA cosa serve
VaccinoTesto—vuotoVaccino.
VaccinoDescrizioneTesto—vuotoDescrizione di Vaccino, riportata per comodità di chi legge.
DataData e ora—nessuna dataData.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
LottoTesto—vuotoLotto.
DataScadenzaLottoData e ora—nessuna dataData scadenza lotto.
VeterinarioTesto—vuotoCodice del veterinario.
VeterinarioDescrizioneTesto——Descrizione di Veterinario, riportata per comodità di chi legge.
UltimoVero/falso—falseUltimo.

Classe annidata Trattamenti

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

CampoTipoObbligatorioPredefinitoA cosa serve
TrattamentoTesto—vuotoTrattamento.
TrattamentoDescrizioneTesto—vuotoDescrizione di Trattamento, riportata per comodità di chi legge.
DataData e ora—nessuna dataData.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
VeterinarioTesto—vuotoCodice del veterinario.
VeterinarioDescrizioneTesto—vuotoDescrizione di Veterinario, riportata per comodità di chi legge.
UltimoVero/falso—falseUltimo.
LottoTesto—vuotoLotto.
DataScadenzaLottoData e ora—nessuna dataData scadenza lotto.

Classe annidata Terapie

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

CampoTipoObbligatorioPredefinitoA cosa serve
TerapiaTesto—vuotoTerapia.
DataInizioData e ora—nessuna dataData di inizio.
DataFineData e ora—nessuna dataData di fine.
PosologiaTesto—vuotoPosologia.
DaFareLunVero/falso—falseDa fare lun.
DaFareMarVero/falso—falseDa fare mar.
DaFareMerVero/falso—falseDa fare mer.
DaFareGioVero/falso—falseDa fare gio.
DaFareVenVero/falso—falseDa fare ven.
DaFareSabVero/falso—falseDa fare sab.
DaFareDomVero/falso—falseDa fare dom.
VeterinarioTesto—vuotoCodice del veterinario.
VeterinarioDescrizioneTesto—vuotoDescrizione di Veterinario, riportata per comodità di chi legge.

Classe annidata CorsiAddestramento

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

CampoTipoObbligatorioPredefinitoA cosa serve
CorsoTesto—vuotoCorso.
CorsoDescrizioneTesto—vuotoDescrizione di Corso, riportata per comodità di chi legge.
DataInizioData e ora—nessuna dataData di inizio.
DataFineData e ora—nessuna dataData di fine.
OreCorsoDecimale—0Ore corso.
ProgrammaTesto—vuotoProgramma.
EseguitoDaTesto—vuotoEseguito da.
EseguitoDaDescrizioneTesto—vuotoDescrizione di EseguitoDa, riportata per comodità di chi legge.
EsitoTesto—vuotoEsito.

Classe annidata Sgambamenti

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataData e ora—nessuna dataData.
SchieraTesto—vuotoSchiera.
SchieraDescrizioneTesto—vuotoDescrizione di Schiera, riportata per comodità di chi legge.
NumeroBoxIntero—0Numero del box.
NoteTesto—vuotoNote libere.
DaOraData e ora—nessuna dataOra di inizio.
AOraData e ora—nessuna dataOra di fine.
OperatoreTesto—vuotoOperatore.
OperatoreDescrizioneTesto—vuotoDescrizione di Operatore, riportata per comodità di chi legge.
AddestratoreTesto—vuotoAddestratore.
AddestratoreDescrizioneTesto—vuotoDescrizione di Addestratore, riportata per comodità di chi legge.

Classe annidata Alert

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

CampoTipoObbligatorioPredefinitoA cosa serve
TitoloTesto—vuotoTitolo.
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
DataAvvisoData e ora—nessuna dataData avviso.
LettoVero/falso—falseLetto.
LettoUtenteTesto—vuotoLetto utente.
LettoUtenteDescrizioneTesto—vuotoDescrizione di LettoUtente, riportata per comodità di chi legge.
LettoDataData e ora—nessuna dataLetto data.
LettoNoteTesto—vuotoLetto note.

Classe annidata Patologie

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

CampoTipoObbligatorioPredefinitoA cosa serve
PatologiaTesto—vuotoPatologia.
PatologiaDescrizioneTesto—vuotoDescrizione di Patologia, riportata per comodità di chi legge.

Classe annidata SpostamentiStrutture

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

CampoTipoObbligatorioPredefinitoA cosa serve
DaDataData e ora—nessuna dataDa data.
ADataData e ora—nessuna dataA data.
DestinazioneTesto—vuotoDestinazione.
DestinazioneDescrizioneTesto—vuotoDescrizione di Destinazione, riportata per comodità di chi legge.
EscludiFatturaVero/falso—falseEscludi fattura.
NoteTesto—vuotoNote libere.

Classe annidata Rinuncia

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

CampoTipoObbligatorioPredefinitoA cosa serve
DataData e ora—nessuna dataData.
DataIngressoData e ora—nessuna dataData ingresso.
AffidatarioDHMAffidatari—oggetto vuotoAffidatario.
CausaTesto—vuotoCausa.
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": 74,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMAnimali": [
    {
      "Identificativo": "COD001",
      "Scaricato": false,
      "DataScarico": "2026-03-15T00:00:00",
      "DestinazioneAnimale": "ESEMPIO",
      "ClienteFatturazione": "ESEMPIO",
      "Razza": "ESEMPIO",
      "DataIngresso": "2026-03-15T00:00:00",
      "SpecieAnimale": "ESEMPIO",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 74,
  "GuidPC": "gestionale-01",
  "ObjectListDHMAnimali": [
    {
      "Identificativo": "COD001"
    }
  ]
}

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

Metodi di ingresso

DHMMetodoIngresso: come un animale è entrato nella struttura

Metodi di ingresso: come un animale è entrato nella struttura. Nel web service è il tipo DHMMETODOINGRESSO (valore 75 di DataType); gli oggetti sono della classe DHMMetodoIngresso e viaggiano nella lista ObjectListDHMMetodoIngresso della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMMETODOINGRESSO = 75
ClasseDHMMetodoIngresso
Lista nella richiesta e nella rispostaObjectListDHMMetodoIngresso
Tabella letta da QUERYDHMMetodoIngresso — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMMetodoIngresso

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 75,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMMetodoIngresso": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 75,
  "GuidPC": "gestionale-01",
  "ObjectListDHMMetodoIngresso": [
    {
      "Codice": "COD001"
    }
  ]
}

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

ASL

DHMASL: le aziende sanitarie con cui lavora la struttura

ASL: le aziende sanitarie con cui lavora la struttura. Nel web service è il tipo DHMASL (valore 76 di DataType); gli oggetti sono della classe DHMASL e viaggiano nella lista ObjectListDHMASL della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMASL = 76
ClasseDHMASL
Lista nella richiesta e nella rispostaObjectListDHMASL
Tabella letta da QUERYDHMASL — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMASL

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
IndirizzoTesto—vuotoindirizzoIndirizzo (via e numero civico).
CapTesto—vuotocapCodice di avviamento postale.
CittaTesto—vuotocittaCittà.
ProvinciaTesto—vuotoprovSigla della provincia.
TelefonoTesto—vuototelefonoNumero di telefono.
ReferenteTesto—vuotoreferenteNome del referente.
Telefono2Testo—vuototel2Secondo numero di telefono.
CellulareTesto—vuotocellNumero di cellulare.
FaxTesto—vuotofaxNumero di fax.
EmailTesto—vuotoemailIndirizzo email.
SitoWEBTesto—vuotositowebIndirizzo del sito web.
PECTesto—vuotopecIndirizzo di posta elettronica certificata.
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
NoteTesto—vuotonoteNote 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": 76,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMASL": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Indirizzo": "ESEMPIO",
      "Cap": "ESEMPIO",
      "Citta": "ESEMPIO",
      "Provincia": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 76,
  "GuidPC": "gestionale-01",
  "ObjectListDHMASL": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Cause di decesso

DHMCauseDecesso: le cause di decesso degli animali

Cause di decesso: le cause di decesso degli animali. Nel web service è il tipo DHMCAUSEDECESSO (valore 77 di DataType); gli oggetti sono della classe DHMCauseDecesso e viaggiano nella lista ObjectListDHMCauseDecesso della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMCAUSEDECESSO = 77
ClasseDHMCauseDecesso
Lista nella richiesta e nella rispostaObjectListDHMCauseDecesso
Tabella letta da QUERYDHMCauseDecesso — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMCauseDecesso

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 77,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMCauseDecesso": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 77,
  "GuidPC": "gestionale-01",
  "ObjectListDHMCauseDecesso": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie di animali

DHMCategoriaAnimali: le categorie in cui si classificano gli animali

Categorie di animali: le categorie in cui si classificano gli animali. Nel web service è il tipo DHMCATEGORIAANIMALI (valore 78 di DataType); gli oggetti sono della classe DHMCategoriaAnimali e viaggiano nella lista ObjectListDHMCategoriaAnimali della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMCATEGORIAANIMALI = 78
ClasseDHMCategoriaAnimali
Lista nella richiesta e nella rispostaObjectListDHMCategoriaAnimali
Tabella letta da QUERYDHMCategoriaAnimali — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMCategoriaAnimali

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 78,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMCategoriaAnimali": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 78,
  "GuidPC": "gestionale-01",
  "ObjectListDHMCategoriaAnimali": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Schiere

DHMAnagraficaSchiere: l'anagrafica delle schiere di animali

Schiere: l'anagrafica delle schiere di animali. Nel web service è il tipo DHMANAGRAFICASCHIERE (valore 79 di DataType); gli oggetti sono della classe DHMAnagraficaSchiere e viaggiano nella lista ObjectListDHMAnagraficaSchiere della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMANAGRAFICASCHIERE = 79
ClasseDHMAnagraficaSchiere
Lista nella richiesta e nella rispostaObjectListDHMAnagraficaSchiere
Tabella letta da QUERYDHMAnagraficaSchiere — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»

I campi di DHMAnagraficaSchiere

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
OspitatoSuAltraStrutturaVero/falso—falseospitatoaltrastrutturaOspitato su altra struttura.
OspitatoSuAltraStrutturaCodiceStrutturaTesto—vuotoospitatoaltrastrutturastrutturaOspitato su altra struttura codice struttura.
AdibitoASgambamentoVero/falso—falsesgambamentoAdibito a sgambamento.
DisegnoMappeColoreTesto—vuotocoloreDisegno mappe colore.
DisegnoMappeLeftDecimale—0leftDisegno mappe left.
DisegnoMappeTopDecimale—0topDisegno mappe top.
DisegnoMappeWidthDecimale—0widthDisegno mappe width.
DisegnoMappeHeightDecimale—0heightDisegno mappe height.
ListaBoxElenco di DHMAnagraficaSchiereBox—elenco vuoto—Box: elenco di oggetti DHMAnagraficaSchiereBox.

Classe annidata DHMAnagraficaSchiereBox

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

CampoTipoObbligatorioPredefinitoA cosa serve
NumeroBoxIntero—0Numero del box.
MQDecimale—0MQ.
DestinazioneUtilizzoTesto—"C"Destinazione utilizzo.

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": 79,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMAnagraficaSchiere": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "OspitatoSuAltraStruttura": false,
      "OspitatoSuAltraStrutturaCodiceStruttura": "ESEMPIO",
      "AdibitoASgambamento": false,
      "DisegnoMappeColore": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 79,
  "GuidPC": "gestionale-01",
  "ObjectListDHMAnagraficaSchiere": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Veterinari della struttura

DHMVeterinariStruttura: i veterinari che operano nella struttura

Veterinari della struttura: i veterinari che operano nella struttura. Nel web service è il tipo DHMVETERINARISTRUTTURA (valore 80 di DataType); gli oggetti sono della classe DHMVeterinariStruttura e viaggiano nella lista ObjectListDHMVeterinariStruttura della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMVETERINARISTRUTTURA = 80
ClasseDHMVeterinariStruttura
Lista nella richiesta e nella rispostaObjectListDHMVeterinariStruttura
Tabella letta da QUERYDHMVeterinariStruttura — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMVeterinariStruttura

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 80,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMVeterinariStruttura": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 80,
  "GuidPC": "gestionale-01",
  "ObjectListDHMVeterinariStruttura": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Malattie

DHMMalattia: l'archivio delle malattie

Malattie: l'archivio delle malattie. Nel web service è il tipo DHMMALATTIA (valore 81 di DataType); gli oggetti sono della classe DHMMalattia e viaggiano nella lista ObjectListDHMMalattia della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMMALATTIA = 81
ClasseDHMMalattia
Lista nella richiesta e nella rispostaObjectListDHMMalattia
Tabella letta da QUERYDHMMalattia — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMMalattia

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoPrelievoTesto—vuototipoprelievoTipo prelievo.
NumeroGiorniPerDecorrenzaIntero—0giornidecprelieviNumero giorni per decorrenza.

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": 81,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMMalattia": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "TipoPrelievo": "ESEMPIO",
      "NumeroGiorniPerDecorrenza": 1
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 81,
  "GuidPC": "gestionale-01",
  "ObjectListDHMMalattia": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Destinazioni degli spostamenti

DHMDestinazioniStoricoSpostamenti: le destinazioni usate nello storico degli spostamenti

Destinazioni degli spostamenti: le destinazioni usate nello storico degli spostamenti. Nel web service è il tipo DHMDESTINAZIONISTORICOSPOSTAMENTI (valore 82 di DataType); gli oggetti sono della classe DHMDestinazioniStoricoSpostamenti e viaggiano nella lista ObjectListDHMDestinazioniStoricoSpostamenti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMDESTINAZIONISTORICOSPOSTAMENTI = 82
ClasseDHMDestinazioniStoricoSpostamenti
Lista nella richiesta e nella rispostaObjectListDHMDestinazioniStoricoSpostamenti
Tabella letta da QUERYDHMDestinazioniStoricoSpostamenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMDestinazioniStoricoSpostamenti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 82,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMDestinazioniStoricoSpostamenti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 82,
  "GuidPC": "gestionale-01",
  "ObjectListDHMDestinazioniStoricoSpostamenti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di esame

DHMEsame: gli esami che si eseguono sugli animali

Tipi di esame: gli esami che si eseguono sugli animali. Nel web service è il tipo DHMESAME (valore 83 di DataType); gli oggetti sono della classe DHMEsame e viaggiano nella lista ObjectListDHMEsame della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMESAME = 83
ClasseDHMEsame
Lista nella richiesta e nella rispostaObjectListDHMEsame
Tabella letta da QUERYDHMTipiEsame — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMEsame

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
RipetiEsameVero/falso—falseripesameRipeti esame.
RipetiEsameNumeroMesiIntero—0nummesiRipeti esame numero mesi.
RipetiEsameNumeroRipetizioniIntero—0ripvolteRipeti esame numero ripetizioni.
ArticoloAssociatoTesto—vuotoarticoloArticolo associato.
ListaPrezziListinoElenco di DHMEsamiPrezziListino—elenco vuoto—Prezzi listino: elenco di oggetti DHMEsamiPrezziListino.
ListaDettaglioValoriElenco di DHMEsamiDettaglio—elenco vuoto—Dettaglio valori: elenco di oggetti DHMEsamiDettaglio.

Classe annidata DHMEsamiPrezziListino

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

CampoTipoObbligatorioPredefinitoA cosa serve
ListinoTesto—vuotoCodice del listino. Codice dell'archivio Listini.
ListinoDescrizioneTesto—vuotoDescrizione di Listino, riportata per comodità di chi legge.
ImportoDecimale—0Importo.

Classe annidata DHMEsamiDettaglio

Elemento usato dentro DHMEsame. 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.
PosizioneIntero—0Posizione nell'ordinamento: i valori più bassi vengono prima.
TipoRisultatoTesto—vuotoTipo risultato.
TipoRisultatoNumericoIntervalloValoriMinimoIntero—0Tipo risultato numerico intervallo valori minimo.
TipoRisultatoNumericoIntervalloValoriMassimoIntero—0Tipo risultato numerico intervallo valori massimo.
TipoRisultatoNumericoIntervalloValoriSuffissoTesto—vuotoTipo risultato numerico intervallo valori suffisso.
TipoRisultatoElencoValoriElenco di Testo—elenco vuotoTipo risultato elenco valori.
SpecieIncluseElenco di Testo—elenco vuotoSpecie incluse.

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": 83,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMEsame": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "RipetiEsame": false,
      "RipetiEsameNumeroMesi": 1,
      "RipetiEsameNumeroRipetizioni": 1,
      "ArticoloAssociato": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 83,
  "GuidPC": "gestionale-01",
  "ObjectListDHMEsame": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Schede comportamentali

DHMSchedaComportamentale: i modelli delle schede comportamentali

Schede comportamentali: i modelli delle schede comportamentali. Nel web service è il tipo DHMSCHEDACOMPORTAMENTALE (valore 84 di DataType); gli oggetti sono della classe DHMSchedaComportamentale e viaggiano nella lista ObjectListDHMSchedaComportamentale della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMSCHEDACOMPORTAMENTALE = 84
ClasseDHMSchedaComportamentale
Lista nella richiesta e nella rispostaObjectListDHMSchedaComportamentale
Tabella letta da QUERYDHMSchedaComportamentaleArchivio — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMSchedaComportamentale

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CorpoElenco di DHMSchedaComportamentaleDettaglio—elenco vuoto—Corpo: elenco di oggetti DHMSchedaComportamentaleDettaglio.

Classe annidata DHMSchedaComportamentaleDettaglio

Elemento usato dentro DHMSchedaComportamentale. 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.
TipoEsitoTesto—vuotoTipo esito.
MinEsitoIntero—0Minimo esito.
MaxEsitoIntero—0Massimo esito.
SuffissoEsitoTesto—vuotoSuffisso esito.
ArrayValoriElenco di Testo—elenco vuotoArray valori.
ArrayValori2Elenco di Testo—elenco vuotoArray valori 2.
PosizioneIntero—0Posizione nell'ordinamento: i valori più bassi vengono prima.
IdentificaAdottabilitaVero/falso—falseIdentifica adottabilita.

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": 84,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMSchedaComportamentale": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 84,
  "GuidPC": "gestionale-01",
  "ObjectListDHMSchedaComportamentale": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Vaccini

DHMVaccini: l'archivio dei vaccini

Vaccini: l'archivio dei vaccini. Nel web service è il tipo DHMVACCINI (valore 85 di DataType); gli oggetti sono della classe DHMVaccini e viaggiano nella lista ObjectListDHMVaccini della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMVACCINI = 85
ClasseDHMVaccini
Lista nella richiesta e nella rispostaObjectListDHMVaccini
Tabella letta da QUERYDHMVaccini — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMVaccini

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
TipoTesto—vuototipoTipo.
NumeroGiorniPerDecorrenzaIntero—0giornidecprelieviNumero giorni per decorrenza.
UnicaDecorrenzaVero/falso—falsesolounaUnica decorrenza.

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": 85,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMVaccini": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Tipo": "ESEMPIO",
      "NumeroGiorniPerDecorrenza": 1,
      "UnicaDecorrenza": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 85,
  "GuidPC": "gestionale-01",
  "ObjectListDHMVaccini": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Corsi

DHMCorsi: i corsi di addestramento con date, docenti e presenze

Corsi: i corsi di addestramento con date, docenti e presenze. Nel web service è il tipo DHMCORSI (valore 86 di DataType); gli oggetti sono della classe DHMCorsi e viaggiano nella lista ObjectListDHMCorsi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMCORSI = 86
ClasseDHMCorsi
Lista nella richiesta e nella rispostaObjectListDHMCorsi
Tabella letta da QUERYDHMCorsi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMCorsi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
DataPubblicazioneData e ora—nessuna datadatapubblicazioneData pubblicazione.
DataInizioData e ora—nessuna datadatainizioData di inizio.
DataFineData e ora—nessuna datadatafineData di fine.
DataEsameData e ora—nessuna datadataesameData esame.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
ProgrammaCorsoPDFImageTrasmission—oggetto vuoto—Programma corso PDF.
SchedaIscrizionePDFImageTrasmission—oggetto vuoto—Scheda iscrizione PDF.
LocandinaPDFImageTrasmission—oggetto vuoto—Locandina PDF.
NumeroPagineIntero—0—Numero pagine.
VisualizzaInHomeVero/falso—falseinhomeVisualizza in home.
VisualizzaInAnteprimaVero/falso—falsevisanteprimaVisualizza in anteprima.
NumeroOreDecimale—0numerooreNumero ore.
NumeroMassimoAlunniIntero—0numeromaxalunniNumero massimo alunni.
NumeroMinimoAlunniIntero—0numerominalunniNumero minimo alunni.
ImportoDecimale—0importoImporto.
TipoTesto—vuototipoTipo.
VisibileWEBVero/falso—falseesportawebVisibile web.
ProgrammaCorsoPDFPagineBigElenco di ImageTrasmission—elenco vuoto—Programma corso PDF pagine big: elenco di oggetti ImageTrasmission.
ProgrammaCorsoPDFPagineFullElenco di ImageTrasmission—elenco vuoto—Programma corso PDF pagine full: elenco di oggetti ImageTrasmission.
ProgrammaCorsoPDFPagineThumbElenco di ImageTrasmission—elenco vuoto—Programma corso PDF pagine thumb: elenco di oggetti ImageTrasmission.
ListaAlunniElenco di DHMCorsiAlunniIscritti—elenco vuoto—Alunni: elenco di oggetti DHMCorsiAlunniIscritti.
DateCorsoElenco di DHMCorsiDate—elenco vuoto—Data corso: elenco di oggetti DHMCorsiDate.
ListaModuliCorsoElenco di DHMCorsiDateModuli—elenco vuoto—Moduli corso: elenco di oggetti DHMCorsiDateModuli.
ListaAccontiAlunniElenco di DHMCorsiAlunniIscrittiAcconti—elenco vuoto—Acconti alunni: elenco di oggetti DHMCorsiAlunniIscrittiAcconti.

Classe annidata DHMCorsiAlunniIscritti

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

CampoTipoObbligatorioPredefinitoA cosa serve
AlunnoTesto—vuotoCodice dell'animale iscritto al corso.
AnimaleTesto—vuotoAnimale.
DataIscrizioneData e ora—nessuna dataData iscrizione.
ImportoVersatoDecimale—0Importo versato.
ImportoDaPagareDecimale—0Importo da pagare.
NoteTesto—vuotoNote libere.

Classe annidata DHMCorsiDate

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

CampoTipoObbligatorioPredefinitoA cosa serve
DescrizioneTesto—vuotoDescrizione del record, mostrata nel gestionale e sul sito.
DataData e ora—nessuna dataData.
DaOraData e ora—nessuna dataOra di inizio.
AOraData e ora—nessuna dataOra di fine.
NumeroOreIntero—0Numero ore.
ListaDocentiElenco di Testo—elenco vuotoElenco docenti.
ListaPresenzeAlunniElenco di DHMAlunniPresenze—elenco vuotoPresenze alunni: elenco di oggetti DHMAlunniPresenze.

Classe annidata DHMAlunniPresenze

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

CampoTipoObbligatorioPredefinitoA cosa serve
AlunnoTesto—vuotoCodice dell'animale iscritto al corso.
NoteTesto—vuotoNote libere.

Classe annidata DHMCorsiDateModuli

Elemento usato dentro DHMCorsi. 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.

Classe annidata DHMCorsiAlunniIscrittiAcconti

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

CampoTipoObbligatorioPredefinitoA cosa serve
AlunnoTesto—vuotoCodice dell'animale iscritto al corso.
DataData e ora—nessuna dataData.
ImportoVersatoDecimale—0Importo versato.

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": 86,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMCorsi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "DataPubblicazione": "2026-03-15T00:00:00",
      "DataInizio": "2026-03-15T00:00:00",
      "DataFine": "2026-03-15T00:00:00",
      "DataEsame": "2026-03-15T00:00:00"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 86,
  "GuidPC": "gestionale-01",
  "ObjectListDHMCorsi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Trattamenti

DHMTrattamenti: l'archivio dei trattamenti

Trattamenti: l'archivio dei trattamenti. Nel web service è il tipo DHMTRATTAMENTI (valore 87 di DataType); gli oggetti sono della classe DHMTrattamenti e viaggiano nella lista ObjectListDHMTrattamenti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTRATTAMENTI = 87
ClasseDHMTrattamenti
Lista nella richiesta e nella rispostaObjectListDHMTrattamenti
Tabella letta da QUERYDHMTrattamenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTrattamenti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
NumeroGiorniPerDecorrenzaIntero—0giornidecprelieviNumero giorni per decorrenza.
UnicaDecorrenzaVero/falso—falsesolounaUnica decorrenza.
TipoTesto—vuototipoTipo.

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": 87,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTrattamenti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "NumeroGiorniPerDecorrenza": 1,
      "UnicaDecorrenza": false,
      "Tipo": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 87,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTrattamenti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipologie di corso

DHMCorsiTipologie: le tipologie dei corsi

Tipologie di corso: le tipologie dei corsi. Nel web service è il tipo DHMCORSITIPOLOGIE (valore 88 di DataType); gli oggetti sono della classe DHMCorsiTipologie e viaggiano nella lista ObjectListDHMCorsiTipologie della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMCORSITIPOLOGIE = 88
ClasseDHMCorsiTipologie
Lista nella richiesta e nella rispostaObjectListDHMCorsiTipologie
Tabella letta da QUERYDHMCorsiTipologie — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMCorsiTipologie

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 88,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMCorsiTipologie": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 88,
  "GuidPC": "gestionale-01",
  "ObjectListDHMCorsiTipologie": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Patologie

DHMPatologie: l'archivio delle patologie

Patologie: l'archivio delle patologie. Nel web service è il tipo DHMPATOLOGIE (valore 89 di DataType); gli oggetti sono della classe DHMPatologie e viaggiano nella lista ObjectListDHMPatologie della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMPATOLOGIE = 89
ClasseDHMPatologie
Lista nella richiesta e nella rispostaObjectListDHMPatologie
Tabella letta da QUERYDHMPatologie — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Nome: «Nome non specificato»

I campi di DHMPatologie

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
NomeTestoSìvuotonomeNome. Se manca il server risponde «Nome non specificato».
ClassificazioneTesto—vuotoclassificazioneCodice della classificazione.
SintomiTesto—vuotosintomiSintomi.
NoteTesto—vuotonoteNote libere.
ListaSpecieIncluseElenco di Testo—elenco vuotocodtipoElenco specie incluse.

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": 89,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMPatologie": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "Nome": "Esempio",
      "Classificazione": "ESEMPIO",
      "Sintomi": "ESEMPIO",
      "Note": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 89,
  "GuidPC": "gestionale-01",
  "ObjectListDHMPatologie": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Docenti dei corsi

DHMCorsiDocenti: i docenti dei corsi di addestramento

Docenti dei corsi: i docenti dei corsi di addestramento. Nel web service è il tipo DHMCORSIDOCENTI (valore 90 di DataType); gli oggetti sono della classe DHMCorsiDocenti e viaggiano nella lista ObjectListDHMCorsiDocenti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMCORSIDOCENTI = 90
ClasseDHMCorsiDocenti
Lista nella richiesta e nella rispostaObjectListDHMCorsiDocenti
Tabella letta da QUERYDHMCorsiDocenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Nome: «Nome non specificato»

I campi di DHMCorsiDocenti

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
NomeTestoSìvuotonomeNome. Se manca il server risponde «Nome non specificato».
DescrizioneBreveTesto—vuotodescrbreveDescrizione breve, per elenchi e anteprime.
CurriculumPDFImageTrasmission—oggetto vuoto—Curriculum PDF.
FotoImageTrasmission—oggetto vuoto—Fotografia, come file in Base64.

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": 90,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMCorsiDocenti": [
    {
      "Codice": "COD001",
      "Nome": "Esempio",
      "DescrizioneBreve": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 90,
  "GuidPC": "gestionale-01",
  "ObjectListDHMCorsiDocenti": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Foto degli animali

DHMAnimaliImage: le foto della scheda dell'animale

Foto degli animali: le foto della scheda dell'animale. Nel web service è il tipo DHMANIMALIIMAGE (valore 91 di DataType); gli oggetti sono della classe DHMAnimaliImage e viaggiano nella lista ObjectListDHMAnimaliImage della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMANIMALIIMAGE = 91
ClasseDHMAnimaliImage
Lista nella richiesta e nella rispostaObjectListDHMAnimaliImage
Tabella letta da QUERYDHMCaniFoto — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveAnimaleID + Progressivo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassAnimaleID|Progressivo
Chiave per le conferme di ricezioneAnimaleID|Progressivo — come si usa
Controlli prima del salvataggioAnimaleID: «Id animale non specificato»

I campi di DHMAnimaliImage

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
AnimaleIDTestoChiave, sìvuotoidcaneAnimale ID. Se manca il server risponde «Id animale non specificato».
ProgressivoInteroChiave0progressivoNumero progressivo della riga all'interno del record principale.
ImageImageTrasmission—oggetto vuoto—Immagine, come file in Base64.
FotoDefaultVero/falso—falsedeffotoVero se è la foto principale.

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": 91,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMAnimaliImage": [
    {
      "AnimaleID": "COD001",
      "Progressivo": 1,
      "FotoDefault": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 91,
  "GuidPC": "gestionale-01",
  "ObjectListDHMAnimaliImage": [
    {
      "AnimaleID": "COD001",
      "Progressivo": 1
    }
  ]
}

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

File degli animali

DHMAnimaliFile: i documenti allegati alla scheda dell'animale

File degli animali: i documenti allegati alla scheda dell'animale. Nel web service è il tipo DHMANIMALIFILE (valore 92 di DataType); gli oggetti sono della classe DHMAnimaliFile e viaggiano nella lista ObjectListDHMAnimaliFile della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMANIMALIFILE = 92
ClasseDHMAnimaliFile
Lista nella richiesta e nella rispostaObjectListDHMAnimaliFile
Tabella letta da QUERYDHMCaniFileAllegati — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveAnimaleID + Progressivo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassAnimaleID|Progressivo
Chiave per le conferme di ricezioneAnimaleID|Progressivo — come si usa
Controlli prima del salvataggioAnimaleID: «Id animale non specificato»

I campi di DHMAnimaliFile

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
AnimaleIDTestoChiave, sìvuotoidanimaleAnimale ID. Se manca il server risponde «Id animale non specificato».
ProgressivoInteroChiave0progressivoNumero progressivo della riga all'interno del record principale.
FileImageTrasmission—oggetto vuoto—File, trasmesso in Base64.
NomeTesto—vuotonomeoriginaleNome.

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": 92,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMAnimaliFile": [
    {
      "AnimaleID": "COD001",
      "Progressivo": 1,
      "Nome": "Esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 92,
  "GuidPC": "gestionale-01",
  "ObjectListDHMAnimaliFile": [
    {
      "AnimaleID": "COD001",
      "Progressivo": 1
    }
  ]
}

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

Utenti dell'area riservata

DHMUser: gli utenti registrati sul sito della struttura

Utenti dell'area riservata: gli utenti registrati sul sito della struttura. Nel web service è il tipo DHMUSER (valore 93 di DataType); gli oggetti sono della classe DHMUser e viaggiano nella lista ObjectListDHMUser della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMUSER = 93
ClasseDHMUser
Lista nella richiesta e nella rispostaObjectListDHMUser
Tabella letta da QUERYDHMECommUtenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveUsername — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassUsername
Chiave per le conferme di ricezioneUsername — come si usa
Controlli prima del salvataggioUsername: «Username non specificato»

I campi di DHMUser

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
UsernameTestoChiave, sìvuotousernameNome utente. Se manca il server risponde «Username non specificato».
PasswordTesto—vuotopasswordPassword.
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.
TipoUtenteTesto—vuototipoTipo utente.
Cellulare1Testo—vuotocellulare1Cellulare 1.
Cellulare2Testo—vuotocellulare2Cellulare 2.
EmailTesto—vuotoemailIndirizzo email.
PECTesto—vuotopecIndirizzo di posta elettronica certificata.
LimitaOperazioniVero/falso—falseabilitperdataLimita operazioni.
LimitaOperazioniDaDataData e ora—nessuna dataabilitperdatadadataLimita operazioni da data.
LimitaOperazioniADataData e ora—nessuna dataabilitperdataadataLimita operazioni a data.
LogoImageTrasmission—oggetto vuoto—Logo, come file in Base64.
StrutturaAssociataTesto—vuotostrutturaassociataStruttura associata.
OperatoreAssociatoTesto—vuototecnicoOperatore associato.
ClienteAssociatoTesto—vuotoclienteassCliente associato.
ClienteFatturazioneAssociatoTesto—vuotoclifattCliente fatturazione associato.
AlertInserimentoRichiestaTesto—vuototipoavvisoAlert inserimento richiesta.
AlertInserimentoEAutorizzazioneRichiestaTesto—vuototipoavvisoAlert inserimento e autorizzazione richiesta.
AlertAutorizzazioneRichiestaTesto—vuototipoavvisoAlert autorizzazione richiesta.
AlertAssegnazioneRichiestaTesto—vuototipoavvisoAlert assegnazione richiesta.
AlertConclusaRichiestaTesto—vuototipoavvisoAlert conclusa richiesta.
AlertInserimentoInterventoAvvisoStruttureTesto—vuototipoavvisoAlert inserimento intervento avviso strutture.
AlertConfermaRicezioneStrutturaTesto—vuototipoavvisoAlert conferma ricezione struttura.
ComuniAbilitatiAbilitaTuttiVero/falso—falseabilitatutticomuniComuni abilitati abilita tutti.
RaggruppamentoStatisticoOrdiniTesto——raggrstatordiniRaggruppamento statistico ordini.
AbilitazioniComuniElenco di Testo—elenco vuotocomuneAbilitazioni comuni.
ComuniAbilitatiElencoCAPElenco di Testo—elenco vuotocomuneComuni abilitati elenco CAP.
TipologieInterventiAbilitatiElenco di Testo—elenco vuototipointerventoTipologie interventi abilitati.

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": 93,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMUser": [
    {
      "Username": "utente@example.com",
      "Password": "ESEMPIO",
      "Descrizione": "Descrizione di esempio",
      "TipoUtente": "ESEMPIO",
      "Cellulare1": "ESEMPIO",
      "Cellulare2": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 93,
  "GuidPC": "gestionale-01",
  "ObjectListDHMUser": [
    {
      "Username": "utente@example.com"
    }
  ]
}

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

File degli utenti

DHMUserFileAllegati: i documenti caricati dagli utenti registrati

File degli utenti: i documenti caricati dagli utenti registrati. Nel web service è il tipo DHMUSERFILEALLEGATI (valore 94 di DataType); gli oggetti sono della classe DHMUserFileAllegati e viaggiano nella lista ObjectListDHMUserFileAllegati della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMUSERFILEALLEGATI = 94
ClasseDHMUserFileAllegati
Lista nella richiesta e nella rispostaObjectListDHMUserFileAllegati
Tabella letta da QUERYDHMECommUtentiFile — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveUsername + Progressivo — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassUsername|Progressivo
Chiave per le conferme di ricezioneUsername|Progressivo — come si usa
Controlli prima del salvataggioUsername: «Username non specificato»

I campi di DHMUserFileAllegati

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
UsernameTestoChiave, sìvuotousernameNome utente. Se manca il server risponde «Username non specificato».
ProgressivoInteroChiave0progressivoNumero progressivo della riga all'interno del record principale.
FileImageTrasmission—oggetto vuoto—File, trasmesso in Base64.
RaggruppamentoTesto—vuotoraggruppamentoCodice del raggruppamento. Codice dell'archivio Raggruppamenti dei file.
DescrizioneTesto—vuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito.

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": 94,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMUserFileAllegati": [
    {
      "Username": "utente@example.com",
      "Progressivo": 1,
      "Raggruppamento": "ESEMPIO",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 94,
  "GuidPC": "gestionale-01",
  "ObjectListDHMUserFileAllegati": [
    {
      "Username": "utente@example.com",
      "Progressivo": 1
    }
  ]
}

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

Tipi di vaccino

DHMTipoVaccino: le tipologie dei vaccini

Tipi di vaccino: le tipologie dei vaccini. Nel web service è il tipo DHMTIPOVACCINO (valore 115 di DataType); gli oggetti sono della classe DHMTipoVaccino e viaggiano nella lista ObjectListDHMTipoVaccino della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPOVACCINO = 115
ClasseDHMTipoVaccino
Lista nella richiesta e nella rispostaObjectListDHMTipoVaccino
Tabella letta da QUERYDHMTipoVaccini — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipoVaccino

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 115,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipoVaccino": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 115,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipoVaccino": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Tipi di trattamento

DHMTipoTrattamento: le tipologie dei trattamenti

Tipi di trattamento: le tipologie dei trattamenti. Nel web service è il tipo DHMTIPOTRATTAMENTO (valore 116 di DataType); gli oggetti sono della classe DHMTipoTrattamento e viaggiano nella lista ObjectListDHMTipoTrattamento della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoDHMTIPOTRATTAMENTO = 116
ClasseDHMTipoTrattamento
Lista nella richiesta e nella rispostaObjectListDHMTipoTrattamento
Tabella letta da QUERYDHMTipoTrattamenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di DHMTipoTrattamento

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 116,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListDHMTipoTrattamento": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 116,
  "GuidPC": "gestionale-01",
  "ObjectListDHMTipoTrattamento": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie del blog

Categorie del blog: le categorie degli articoli del blog

Categorie del blog: le categorie degli articoli del blog. Nel web service è il tipo UWPCATEGORIABLOG (valore 96 di DataType); gli oggetti sono della classe UWPCategoriaBlog e viaggiano nella lista ObjectListUWPCategoriaBlog della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIABLOG = 96
ClasseUWPCategoriaBlog
Lista nella richiesta e nella rispostaObjectListUWPCategoriaBlog
Tabella letta da QUERYUWPCategoriaBlog — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 96,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaBlog": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 96,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaBlog": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie dei contenuti

Categorie dei contenuti: le categorie dei contenuti del sito

Categorie dei contenuti: le categorie dei contenuti del sito. Nel web service è il tipo UWPCATEGORIACONTENUTO (valore 97 di DataType); gli oggetti sono della classe UWPCategoriaContenuto e viaggiano nella lista ObjectListUWPCategoriaContenuto della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIACONTENUTO = 97
ClasseUWPCategoriaContenuto
Lista nella richiesta e nella rispostaObjectListUWPCategoriaContenuto
Tabella letta da QUERYUWPCategoriaContenuto — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 97,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaContenuto": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 97,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaContenuto": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie dei download

Categorie dei download: le categorie dei file scaricabili

Categorie dei download: le categorie dei file scaricabili. Nel web service è il tipo UWPCATEGORIADOWNLOAD (valore 98 di DataType); gli oggetti sono della classe UWPCategoriaDownload e viaggiano nella lista ObjectListUWPCategoriaDownload della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIADOWNLOAD = 98
ClasseUWPCategoriaDownload
Lista nella richiesta e nella rispostaObjectListUWPCategoriaDownload
Tabella letta da QUERYUWPCategoriaDownload — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 98,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaDownload": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 98,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaDownload": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie degli eventi

Categorie degli eventi: le categorie degli eventi

Categorie degli eventi: le categorie degli eventi. Nel web service è il tipo UWPCATEGORIAEVENTI (valore 99 di DataType); gli oggetti sono della classe UWPCategoriaEventi e viaggiano nella lista ObjectListUWPCategoriaEventi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIAEVENTI = 99
ClasseUWPCategoriaEventi
Lista nella richiesta e nella rispostaObjectListUWPCategoriaEventi
Tabella letta da QUERYUWPCategoriaEventi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 99,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaEventi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 99,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaEventi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie dei contenuti multimediali

Categorie dei contenuti multimediali: le categorie di foto e video

Categorie dei contenuti multimediali: le categorie di foto e video. Nel web service è il tipo UWPCATEGORIAMEDIACONTENT (valore 100 di DataType); gli oggetti sono della classe UWPCategoriaMediaContent e viaggiano nella lista ObjectListUWPCategoriaMediaContent della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIAMEDIACONTENT = 100
ClasseUWPCategoriaMediaContent
Lista nella richiesta e nella rispostaObjectListUWPCategoriaMediaContent
Tabella letta da QUERYUWPCategoriaMediaContent — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 100,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaMediaContent": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 100,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaMediaContent": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie delle news

Categorie delle news: le categorie delle news

Categorie delle news: le categorie delle news. Nel web service è il tipo UWPCATEGORIANEWS (valore 101 di DataType); gli oggetti sono della classe UWPCategoriaNews e viaggiano nella lista ObjectListUWPCategoriaNews della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIANEWS = 101
ClasseUWPCategoriaNews
Lista nella richiesta e nella rispostaObjectListUWPCategoriaNews
Tabella letta da QUERYUWPCategoriaNews — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 101,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaNews": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 101,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaNews": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie dei premi

Categorie dei premi: le categorie dei premi e riconoscimenti

Categorie dei premi: le categorie dei premi e riconoscimenti. Nel web service è il tipo UWPCATEGORIAPREMI (valore 102 di DataType); gli oggetti sono della classe UWPCategoriaPremi e viaggiano nella lista ObjectListUWPCategoriaPremi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIAPREMI = 102
ClasseUWPCategoriaPremi
Lista nella richiesta e nella rispostaObjectListUWPCategoriaPremi
Tabella letta da QUERYUWPCategoriaPremi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 102,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaPremi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 102,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaPremi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie della rassegna stampa

Categorie della rassegna stampa: le categorie della rassegna stampa

Categorie della rassegna stampa: le categorie della rassegna stampa. Nel web service è il tipo UWPCATEGORIAPRESS (valore 103 di DataType); gli oggetti sono della classe UWPCategoriaPress e viaggiano nella lista ObjectListUWPCategoriaPress della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIAPRESS = 103
ClasseUWPCategoriaPress
Lista nella richiesta e nella rispostaObjectListUWPCategoriaPress
Tabella letta da QUERYUWPCategoriaPress — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 103,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaPress": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 103,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaPress": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Categorie dei servizi

Categorie dei servizi: le categorie dei servizi offerti

Categorie dei servizi: le categorie dei servizi offerti. Nel web service è il tipo UWPCATEGORIASERVIZI (valore 104 di DataType); gli oggetti sono della classe UWPCategoriaServizi e viaggiano nella lista ObjectListUWPCategoriaServizi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCATEGORIASERVIZI = 104
ClasseUWPCategoriaServizi
Lista nella richiesta e nella rispostaObjectListUWPCategoriaServizi
Tabella letta da QUERYUWPCategoriaServizi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».

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": 104,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPCategoriaServizi": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 104,
  "GuidPC": "gestionale-01",
  "ObjectListUWPCategoriaServizi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Articoli del blog

Articoli del blog: gli articoli del blog con testo, immagini e categoria

Articoli del blog: gli articoli del blog con testo, immagini e categoria. Nel web service è il tipo UWPBLOG (valore 105 di DataType); gli oggetti sono della classe UWPBlog e viaggiano nella lista ObjectListUWPBlog della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPBLOG = 105
ClasseUWPBlog
Lista nella richiesta e nella rispostaObjectListUWPBlog
Tabella letta da QUERYUWPBlog — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
DataData e ora—nessuna datadataData.
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
UserPubblicazioneTesto—vuotouserpubblicazioneUser pubblicazione.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 105,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPBlog": [
    {
      "Codice": "COD001",
      "Titolo": "Esempio",
      "Data": "2026-03-15T00:00:00",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 105,
  "GuidPC": "gestionale-01",
  "ObjectListUWPBlog": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Contenuti

Contenuti: le pagine di contenuto del sito

Contenuti: le pagine di contenuto del sito. Nel web service è il tipo UWPCONTENUTO (valore 106 di DataType); gli oggetti sono della classe UWPContenuto e viaggiano nella lista ObjectListUWPContenuto della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPCONTENUTO = 106
ClasseUWPContenuto
Lista nella richiesta e nella rispostaObjectListUWPContenuto
Tabella letta da QUERYUWPContenuti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 106,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPContenuto": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 106,
  "GuidPC": "gestionale-01",
  "ObjectListUWPContenuto": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Download

Download: i file messi a disposizione dei visitatori

Download: i file messi a disposizione dei visitatori. Nel web service è il tipo UWPDOWNLOAD (valore 107 di DataType); gli oggetti sono della classe UWPDownload e viaggiano nella lista ObjectListUWPDownload della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPDOWNLOAD = 107
ClasseUWPDownload
Lista nella richiesta e nella rispostaObjectListUWPDownload
Tabella letta da QUERYUWPDownload — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 107,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPDownload": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 107,
  "GuidPC": "gestionale-01",
  "ObjectListUWPDownload": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Eventi

Eventi: gli eventi con date, luogo e immagini

Eventi: gli eventi con date, luogo e immagini. Nel web service è il tipo UWPEVENTI (valore 108 di DataType); gli oggetti sono della classe UWPEventi e viaggiano nella lista ObjectListUWPEventi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPEVENTI = 108
ClasseUWPEventi
Lista nella richiesta e nella rispostaObjectListUWPEventi
Tabella letta da QUERYUWPEventi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
LuogoIndirizzoTesto—vuotoluogoindirizzoLuogo indirizzo.
LuogoCapTesto—vuotoluogocapLuogo CAP.
LuogoCittaTesto—vuotoluogocittaLuogo città.
LuogoProvinciaTesto—vuotoluogoprovinciaLuogo provincia.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 108,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPEventi": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 108,
  "GuidPC": "gestionale-01",
  "ObjectListUWPEventi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Contenuti multimediali

Contenuti multimediali: le gallerie di foto e video

Contenuti multimediali: le gallerie di foto e video. Nel web service è il tipo UWPMEDIACONTENT (valore 109 di DataType); gli oggetti sono della classe UWPMediaContent e viaggiano nella lista ObjectListUWPMediaContent della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPMEDIACONTENT = 109
ClasseUWPMediaContent
Lista nella richiesta e nella rispostaObjectListUWPMediaContent
Tabella letta da QUERYUWPMediaContent — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
TitoloTesto—vuototitoloTitolo.
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
TypeMediaDefinition.MediaEntryType—Image—Tipo media.
ImageImageTrasmission—oggetto vuoto—Immagine, come file in Base64.
CodiceVideoTesto—vuotocodvideoCodice video.

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": 109,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPMediaContent": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "Visibile": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 109,
  "GuidPC": "gestionale-01",
  "ObjectListUWPMediaContent": [
    {
      "Codice": "COD001"
    }
  ]
}

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

News

News: le notizie pubblicate sul sito

News: le notizie pubblicate sul sito. Nel web service è il tipo UWPNEWS (valore 110 di DataType); gli oggetti sono della classe UWPNews e viaggiano nella lista ObjectListUWPNews della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPNEWS = 110
ClasseUWPNews
Lista nella richiesta e nella rispostaObjectListUWPNews
Tabella letta da QUERYUWPNews — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 110,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPNews": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 110,
  "GuidPC": "gestionale-01",
  "ObjectListUWPNews": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Premi e riconoscimenti

Premi e riconoscimenti: i premi e i riconoscimenti dell'azienda

Premi e riconoscimenti: i premi e i riconoscimenti dell'azienda. Nel web service è il tipo UWPPREMI (valore 111 di DataType); gli oggetti sono della classe UWPPremi e viaggiano nella lista ObjectListUWPPremi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPPREMI = 111
ClasseUWPPremi
Lista nella richiesta e nella rispostaObjectListUWPPremi
Tabella letta da QUERYUWPPremi — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
ValidoDalData e ora—nessuna datavalidodalInizio del periodo di validità.
ValidoAlData e ora—nessuna datavalidoalFine del periodo di validità.
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.
ListAttachedFileElenco di AttachedFile—elenco vuoto—Attached file: elenco di oggetti AttachedFile.

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": 111,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPPremi": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "ValidoDal": "2026-03-15T00:00:00",
      "ValidoAl": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 111,
  "GuidPC": "gestionale-01",
  "ObjectListUWPPremi": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Rassegna stampa

Rassegna stampa: gli articoli della rassegna stampa

Rassegna stampa: gli articoli della rassegna stampa. Nel web service è il tipo UWPPRESS (valore 112 di DataType); gli oggetti sono della classe UWPPress e viaggiano nella lista ObjectListUWPPress della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPPRESS = 112
ClasseUWPPress
Lista nella richiesta e nella rispostaObjectListUWPPress
Tabella letta da QUERYUWPPress — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DataData e ora—nessuna datadataData.
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 112,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPPress": [
    {
      "Codice": "COD001",
      "Data": "2026-03-15T00:00:00",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio"
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 112,
  "GuidPC": "gestionale-01",
  "ObjectListUWPPress": [
    {
      "Codice": "COD001"
    }
  ]
}

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

Servizi offerti

Servizi offerti: i servizi presentati sul sito

Servizi offerti: i servizi presentati sul sito. Nel web service è il tipo UWPSERVIZI (valore 113 di DataType); gli oggetti sono della classe UWPServizi e viaggiano nella lista ObjectListUWPServizi della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoUWPSERVIZI = 113
ClasseUWPServizi
Lista nella richiesta e nella rispostaObjectListUWPServizi
Tabella letta da QUERYUWPServiziOfferti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Titolo: «Titolo non specificato»

I campi

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
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
TitoloTestoSìvuototitoloTitolo. Se manca il server risponde «Titolo non specificato».
CategoriaTesto—vuotocategoriaCodice della categoria a cui appartiene il record.
DescrizioneBreveTesto—vuotodescrizionebreveDescrizione breve, per elenchi e anteprime.
DescrizioneLungaTesto—vuotodescrizionelungaTesto completo, anche in HTML.
VisibileVero/falso—falsevisibileVero se il contenuto è visibile sul sito.
PosizioneIntero—0posizionePosizione nell'ordinamento: i valori più bassi vengono prima.
LinkSostitutivoTesto—vuotolinksostitutivoIndirizzo a cui portare il visitatore al posto della pagina del contenuto.
ListMediaElenco di MediaEntry—elenco vuoto—Immagini e video del contenuto.

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": 113,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListUWPServizi": [
    {
      "Codice": "COD001",
      "Titolo": "Esempio",
      "Categoria": "ESEMPIO",
      "DescrizioneBreve": "Descrizione di esempio",
      "DescrizioneLunga": "Descrizione di esempio",
      "Visibile": false
    }
  ]
}

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

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

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 113,
  "GuidPC": "gestionale-01",
  "ObjectListUWPServizi": [
    {
      "Codice": "COD001"
    }
  ]
}

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