Fattura elettronica in JavaScript
Questo tutorial crea tre semplici applicazioni Node.js da zero:
- Receive: si connette e autentica con Invoicetronic API e scarica eventuali nuove fatture in arrivo.
- Send: si connette e autentica con Invoicetronic API e invia una fattura allo SDI.
- Update: si connette e autentica con Invoicetronic API e consulta la cronologia delle notifiche restituite dallo SDI.
Prima di continuare, assicurati che tutti i prerequisiti sotto siano soddisfatti.
Prerequisiti
Presupponiamo che questi prerequisiti siano soddisfatti:
- Node.js è stato scaricato e installato
- Hai ottenuto una Chiave API attiva
- Ti sei registrato presso l'Agenzia delle Entrate (necessario per l'ambiente di produzione)
Utilizziamo Node.js e npm in quanto sono lo standard de facto per JavaScript server-side, ma gli esempi funzionano anche con altri runtime compatibili.
Tip
Per un'esperienza JavaScript ottimale, considera l'uso di VS Code che offre eccellente supporto per Node.js. Assicurati che l'estensione JavaScript/Node.js sia attiva.
Lo sapevi?
L'SDK JavaScript supporta sia async/await moderno che Promise tradizionali, dandoti flessibilità nello stile di programmazione.
Receive
Crea l'app
Il primo passo è creare la directory dell'applicazione e inizializzare il progetto Node.js:
Inizializza il progetto con npm:
Il comando ha creato un nuovo progetto Node.js con un file package.json nella directory corrente.
Installa l'SDK
Installa l'SDK JavaScript di Invoicetronic:
Una volta completato, apri VS Code nella directory corrente:
Configura l'SDK
Crea un nuovo file chiamato index.js e aggiungi il seguente codice:
const invoicetronicSdk = require('@invoicetronic/js-sdk');
// Configura l'SDK
const apiClient = invoicetronicSdk.ApiClient.instance;
const basicAuth = apiClient.authentications['Basic'];
basicAuth.username = 'LA TUA CHIAVE API DI TEST (inizia con ik_test_)';
apiClient.basePath = 'https://api.invoicetronic.com/v1';
Come puoi vedere, configuriamo l'SDK impostando il percorso base dell'API e la tua chiave API di test (non quella live). Nota come utilizziamo la proprietà username per impostare la chiave API.
Le chiavi API vengono fornite in coppia
Quando crei il tuo account, ottieni una coppia di chiavi API. Una è la chiave di test per la Sandbox API, e l'altra è quella live dell'API. Puoi distinguerle perché la prima inizia con ik_test_, mentre la seconda inizia con ik_live_. In questo tutorial, usa sempre la chiave di test.
Scarica le fatture
Siamo pronti per effettuare una richiesta. Vogliamo scaricare nuove fatture dei fornitori che potrebbero essere disponibili dallo SDI. Aggiungi queste righe:
const fs = require('fs');
// Scarica le fatture non lette
const receiveApi = new invoicetronicSdk.ReceiveApi();
async function downloadInvoices() {
try {
const opts = {
'unread': true,
'includePayload': true
};
const inboundInvoices = await receiveApi.receiveGet(opts);
console.log(`Ricevute ${inboundInvoices.length} fatture`);
for (const invoice of inboundInvoices) {
if (invoice.encoding === 'xml') {
fs.writeFileSync(invoice.fileName, invoice.payload, 'utf8');
} else if (invoice.encoding === 'base64') {
const buffer = Buffer.from(invoice.payload, 'base64');
fs.writeFileSync(invoice.fileName, buffer);
}
console.log(`Scaricato ${invoice.fileName} da un fornitore con Partita IVA ${invoice.prestatore}`);
}
} catch (error) {
console.error('Errore:', error.message);
}
}
downloadInvoices();
Inclusione del Payload
Impostiamo includePayload: true per recuperare il contenuto effettivo della fattura nella proprietà payload. Senza questo parametro, il campo payload sarebbe null per impostazione predefinita, il che aumenta le prestazioni e riduce le dimensioni della risposta quando hai bisogno solo dei metadati.
Nel terminale, esegui l'applicazione:
Dovresti ottenere un output simile a questo:
Ricevute 3 fatture
Scaricato file1.xml da un fornitore con Partita IVA IT06157670966
Scaricato file2.xml.p7m da un fornitore con Partita IVA IT01280270057
Scaricato file3.xml.p7m da un fornitore con Partita IVA IT01280270057
I file sono nella directory corrente, pronti per essere ispezionati.
Non ricevi fatture nell'ambiente di produzione?
Assicurati di esserti registrato presso l'Agenzia delle Entrate, che è un requisito per l'ambiente di produzione.
Cosa abbiamo imparato
In questo esempio, abbiamo imparato diverse cose.
-
Dobbiamo configurare l'SDK impostando sia il
basePathche l'autenticazionebasicAuth.username, quest'ultima inizializzata con la chiave API. -
Dobbiamo istanziare una classe che rappresenta l'endpoint con cui vogliamo lavorare. In questo caso, sfruttiamo
ReceiveApiper scaricare le fatture in arrivo. -
Le classi endpoint come
ReceiveApioffrono metodi per interagire con la loro entità target. ChiamiamoreceiveGetper recuperare le fatture. Poiché vogliamo solo fatture nuove e non lette, passiamounread: true. Passiamo ancheincludePayload: trueper recuperare il contenuto effettivo della fattura. -
Gli oggetti fattura espongono proprietà preziose come
encoding,fileNameepayload. Quest'ultima contiene il contenuto della fattura, come testo normale o codificato in Base64, come descritto daencoding.
Codice sorgente su GitHub
Il codice sorgente per questo Quickstart è disponibile anche su GitHub.
Send
Crea l'app
Il primo passo è creare la directory dell'applicazione e inizializzare il progetto Node.js:
Inizializza il progetto con npm:
Installa l'SDK
Installa l'SDK JavaScript di Invoicetronic:
Una volta completato, apri VS Code nella directory corrente:
Configura l'SDK
Crea un nuovo file chiamato index.js e aggiungi il seguente codice:
const invoicetronicSdk = require('@invoicetronic/js-sdk');
// Configura l'SDK
const apiClient = invoicetronicSdk.ApiClient.instance;
const basicAuth = apiClient.authentications['Basic'];
basicAuth.username = 'LA TUA CHIAVE API DI TEST (inizia con ik_test_)';
apiClient.basePath = 'https://api.invoicetronic.com/v1';
Come puoi vedere, configuriamo l'SDK impostando il percorso base dell'API e la tua chiave API di test (non quella live). Nota come utilizziamo la proprietà username per impostare la chiave API.
Le chiavi API vengono fornite in coppia
Quando crei il tuo account, ottieni una coppia di chiavi API. Una è la chiave di test per la Sandbox API, e l'altra è quella live dell'API. Puoi distinguerle perché la prima inizia con ik_test_, mentre la seconda inizia con ik_live_. In questo tutorial, usa sempre la chiave di test.
Invia una fattura
Siamo pronti per effettuare una richiesta. Vogliamo inviare una fattura allo SDI. Aggiungi il seguente codice:
const fs = require('fs');
const path = require('path');
// Invia una fattura
const filePath = '/qualche/percorso/file/nomefile.xml';
const metaData = {
'internal_id': '123',
'created_with': 'myapp',
'some_other_custom_data': 'value'
};
const sendApi = new invoicetronicSdk.SendApi();
async function sendInvoice() {
try {
const sendData = new invoicetronicSdk.Send(fs.readFileSync(filePath, 'utf8'));
sendData.fileName = path.basename(filePath);
sendData.metaData = metaData;
const sentInvoice = await sendApi.sendPost(sendData);
console.log(`La fattura è stata inviata con successo, ora ha l'Id univoco ${sentInvoice.id}.`);
} catch (error) {
console.error('Errore:', error.message);
}
}
sendInvoice();
Nel terminale, esegui l'applicazione:
Dovresti ottenere un output simile a questo:
Verificare lo stato della fattura
Quando inoltri una fattura allo SDI, la consegna non è istantanea: lo SDI esegue dei controlli e restituisce una sequenza di notifiche che descrivono lo stato del processo (Inviato, Consegnato, Scartato, ecc.). Il modello Send espone la proprietà latest_state con lo stato corrente, evitando una chiamata separata a /update quando ti serve sapere solo come è andata.
// Recupera lo stato più recente di una fattura già inviata
const fresh = await sendApi.sendIdGet(sentInvoice.id);
console.log(`Stato corrente: ${fresh['latest_state'] || 'In elaborazione'}`);
Subito dopo l'invio, latest_state può essere undefined: lo SDI non ha ancora processato il documento. Ricontrolla dopo qualche secondo o, meglio, configura un webhook per ricevere una notifica push ad ogni cambio di stato.
Risparmia richieste API
Usa latest_state su Send ogni volta che ti serve solo lo stato corrente: una sola chiamata invece di una a /send più una a /update. Ricorri a UpdateApi solo quando ti serve la cronologia completa delle transizioni.
Cosa abbiamo imparato
In questo esempio, abbiamo imparato diverse cose.
-
Dobbiamo configurare l'SDK impostando sia il
basePathche l'autenticazionebasicAuth.username, quest'ultima inizializzata con la chiave API. -
Dobbiamo istanziare una classe che rappresenta l'endpoint con cui vogliamo lavorare. In questo caso, sfruttiamo
SendApiper inviare fatture. Le classi endpoint comeSendApioffrono metodi per interagire con la loro entità target. ChiamiamosendPostper inviare una fattura. -
La classe
Sendespone proprietà preziose comefileName,metaDataepayload. Quest'ultima contiene il contenuto della fattura, mentremetaDataè opzionale e associa dati personalizzati al documento. -
La classe
Sendespone anchelatest_statecon lo stato SDI corrente, leggibile viasendIdGet(id). Evita una chiamata a/updatequando serve solo conoscere lo stato.
Codice sorgente su GitHub
Il codice sorgente per questo Quickstart è disponibile anche su GitHub.
Update
Per lo stato corrente di una fattura inviata, è sufficiente leggere latest_state dal modello Send (vedi Verificare lo stato della fattura). Se invece vuoi la cronologia completa delle transizioni — per esempio per capire perché una fattura è stata scartata, mostrare in UI tutti i passaggi di stato con timestamp, o tracciare le notifiche restituite da un ente della Pubblica Amministrazione — usa UpdateApi.
Le query su /update sono gratuite
Le richieste a /update non vengono conteggiate sul tuo piano: puoi consultare la cronologia delle notifiche con la frequenza che preferisci.
Crea l'app
Installa l'SDK
Recuperare la cronologia delle notifiche
Crea un file index.js con il seguente codice:
const invoicetronicSdk = require('@invoicetronic/js-sdk');
// Configura l'SDK
const apiClient = invoicetronicSdk.ApiClient.instance;
const basicAuth = apiClient.authentications['Basic'];
basicAuth.username = 'LA TUA CHIAVE API DI TEST (inizia con ik_test_)';
apiClient.basePath = 'https://api.invoicetronic.com/v1';
// Id della fattura inviata di cui vogliamo ricostruire la cronologia
const sendId = 225;
const updateApi = new invoicetronicSdk.UpdateApi();
async function fetchUpdates() {
try {
const updates = await updateApi.updateGet({
sendId: sendId,
sort: 'last_update'
});
console.log(`Trovate ${updates.length} notifiche per la fattura ${sendId}`);
for (const update of updates) {
console.log(` [${update.lastUpdate}] state=${update.state} - ${update.description || 'OK'}`);
}
} catch (error) {
console.error('Errore:', error.message);
}
}
fetchUpdates();
Esegui l'applicazione:
Dovresti ottenere un output simile a questo:
Trovate 2 notifiche per la fattura 225
[2025-01-23T16:56:14.111Z] state=Inviato - OK
[2025-01-23T17:12:03.842Z] state=Consegnato - OK
Il campo state è la proprietà più importante. I valori più comuni sono:
| Valore | Nome | Descrizione |
|---|---|---|
| 2 | Inviato |
Inviata allo SDI. |
| 5 | Consegnato |
Consegnata al destinatario. |
| 7 | Scartato |
Rifiutata dallo SDI. In description trovi il motivo. |
L'elenco completo dei valori è disponibile nella API Reference. Puoi anche filtrare per stato, per esempio per ottenere solo le fatture scartate:
Monitora sempre lo stato delle fatture inviate
Lo stato Inviato significa solo che il documento è stato preso in carico dallo SDI, non che sia stato consegnato. Uno stato Scartato indica che la fattura non è stata accettata e potrebbe richiedere una correzione e un nuovo invio.
Cosa abbiamo imparato
-
Per consultare la cronologia delle notifiche utilizziamo la classe
UpdateApiinvece diSendApioReceiveApi. -
Il metodo
updateGet()accetta filtri comesendId(per le notifiche di una specifica fattura inviata),state(per filtrare per stato),lastUpdateFrom/lastUpdateTo(intervallo temporale) e altri. -
Le query su
/updatesono gratuite e non vengono conteggiate sul tuo piano, quindi puoi richiamarle con la frequenza che ti serve.
Codice sorgente su GitHub
Il codice sorgente per questo Quickstart è disponibile anche su GitHub.