API Documenti#
Descrizione#
L'API Documenti permette a un sistema esterno di inviare documenti ad Areagate e di consultare quelli gia' presenti.
E' utile quando un gestionale di terze parti deve trasmettere ad Areagate i propri documenti in modo automatico, senza doverli reinserire manualmente.
Operazioni disponibili#
| Operazione | Descrizione |
|---|---|
| Inserimento documenti | Invio di uno o piu' documenti in un'unica richiesta (max 200) |
| Lettura documenti | Consultazione dei documenti presenti, con filtri per cliente e paginazione |
| Lettura aggiornamenti | Consultazione dei documenti aggiornati a partire da un punto di sincronizzazione |
Tipi di documento supportati#
| Tipo | Descrizione | Anagrafica richiesta |
|---|---|---|
| BDPC | Buoni di prelievo cliente | Cliente (obbligatorio) |
| DMEF | Documenti di entrata da fornitore | Fornitore (obbligatorio, solo codice interno) |
| DMG | Documenti generici di magazzino | Nessuna |
| DMUF | Documenti di uscita a fornitore | Fornitore (obbligatorio, solo codice interno) |
Informazioni necessarie per l'invio#
Per inviare un documento, il sistema esterno deve fornire almeno:
- Classe del documento (es. buono prelievo, entrata fornitore)
- Codice anagrafica del cliente o fornitore coinvolto, se richiesto dal tipo di documento
- Righe del documento, ciascuna con codice merce, quantita' e segno di movimentazione (entrata o uscita)
- Codice magazzino del sistema di origine
- Chiave univoca del documento nel sistema di origine (usata per evitare inserimenti duplicati)
Opzionalmente e' possibile indicare anche:
- Data del documento (altrimenti viene usata la data odierna)
- Causale del documento (se non indicata, viene usata la causale di default prevista per il tipo di documento)
- Prezzo, sconti e importo per ogni riga
- Note sulla testata o sulle singole righe
- Collegamento con un documento "padre" (ad esempio: un buono di prelievo collegato all'ordine cliente da cui deriva)
Gestione dei duplicati#
Se un documento gia' inviato viene trasmesso nuovamente, Areagate lo riconosce automaticamente e non lo reinserisce. Questo garantisce che non si creino duplicati anche in caso di invii ripetuti.
Il sistema esterno identifica ciascun documento con un proprio codice univoco, che Areagate utilizza per il riconoscimento. I documenti scartati vengono elencati nella risposta.
Serial number movimentati#
Per le righe di buoni di prelievo cliente (BDPC) e' possibile elencare i serial number movimentati in uscita. La merce indicata deve gestire i serial number, altrimenti la richiesta viene rifiutata.
Quando si valorizzano i serial number, non e' possibile compilare anche le note di riga: le note vengono sostituite con l'elenco dei serial number separati da "; " (es. "SN001; SN002; SN003"). La lunghezza complessiva non puo' superare 2000 caratteri.
I serial number indicati non vengono verificati dall'API: la coerenza con le matricole esistenti e' verificata dal gestionale in fase di importazione.
Collegamento tra documenti#
E' possibile indicare che un documento deriva da un altro (ad esempio: un buono di prelievo che evade un ordine cliente). Questo collegamento viene mantenuto su Areagate e permette di risalire alla catena dei documenti collegati.
Il collegamento e' disponibile per i buoni di prelievo cliente (BDPC) e puo' essere fatto a livello di testata, indicando l'ordine cliente di riferimento.
Riconoscimento anagrafiche#
Il sistema esterno puo' identificare il cliente in due modi:
- Con il proprio codice anagrafica (codice del gestionale esterno) — disponibile solo per i clienti (BDPC)
- Con il codice Areagate (se gia' noto) — utilizzabile per tutte le classi documento
Per i fornitori (DMEF, DMUF) e' ammesso esclusivamente il codice interno Areagate.
Importazione nel gestionale#
Una volta inseriti su Areagate, i documenti vengono importati automaticamente nel gestionale tramite il processo di sincronizzazione, che li trasforma nei corrispondenti documenti di magazzino o buoni prelievo.