Fattura elettronica in Python

Questo tutorial crea due semplici applicazioni Python da zero:

Receive: si connette e autentica con l'API Invoicetronic e scarica le nuove fatture passive in arrivo.
Send: si connette e autentica con l'API Invoicetronic e invia una fattura al SDI.

Prima di continuare, assicurati che tutti i prerequisiti siano soddisfatti.

Prerequisiti

Assumiamo che questi prerequisiti siano soddisfatti:

Python 3.9+ è stato scaricato e installato
pip è installato (viene fornito con Python)
Hai ottenuto una API Key attiva
Ti sei registrato con l'Agenzia delle Entrate (necessario per l'ambiente live)

Usiamo pip per la gestione delle dipendenze, che è lo standard de facto per Python moderno.

Tip

Per un'esperienza Python ottimale, considera l'uso di VS Code con l'estensione Python o PyCharm per un IDE completo.

Lo sapevi?

L'SDK Python supporta type hints e validazione Pydantic, fornendo controlli runtime e migliore autocomplete nell'IDE.

Receive

Creare l'applicazione

Il primo passo è creare la directory dell'applicazione:

mkdir receive && cd receive

Installare l'SDK

Installa l'SDK Python di Invoicetronic:

pip install invoicetronic-sdk

Una volta fatto, apri VS Code nella directory corrente:

code .

Configurare l'SDK

Crea un nuovo file chiamato index.py e aggiungi il seguente codice:

Configurare l'SDK

import invoicetronic_sdk
from invoicetronic_sdk.rest import ApiException

# Configura l'SDK
configuration = invoicetronic_sdk.Configuration(
    username='LA TUA CHIAVE API DI TEST (inizia con ik_test_)',
    host='https://api.invoicetronic.com/v1'
)

Come puoi vedere, configuriamo l'SDK passando la tua chiave API di test (non quella live) e l'host dell'API. Nota come usiamo il parametro 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 l'API Sandbox, e l'altra è quella live. 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.

Scaricare le fatture

Siamo pronti per effettuare una richiesta. Vogliamo scaricare le nuove fatture passive che potrebbero essere disponibili dall'SDI. Aggiungi queste righe:

Scaricare le fatture non lette

import base64

# Scarica le fatture non lette
with invoicetronic_sdk.ApiClient(configuration) as api_client:
    receive_api = invoicetronic_sdk.ReceiveApi(api_client)

    try:
        inbound_invoices = receive_api.receive_get(
            unread=True,
            include_payload=True
        )

        print(f"Ricevute {len(inbound_invoices)} fatture")

        for invoice in inbound_invoices:
            if invoice.encoding == 'Xml':
                with open(invoice.file_name, 'w', encoding='utf-8') as f:
                    f.write(invoice.payload)
            elif invoice.encoding == 'Base64':
                with open(invoice.file_name, 'wb') as f:
                    f.write(base64.b64decode(invoice.payload))

            print(f"Scaricato {invoice.file_name} da un fornitore con Partita IVA {invoice.prestatore}")

    except ApiException as e:
        print(f"Errore: {e}")

Inclusione del Payload

Impostiamo include_payload=True per recuperare il contenuto effettivo della fattura nella proprietà payload. Senza questo parametro, il campo payload sarebbe None di default, il che migliora le prestazioni e riduce la dimensione della risposta quando hai bisogno solo dei metadati.

Nel terminale, esegui l'applicazione:

python index.py

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 live?

Assicurati di esserti registrato con l'Agenzia delle Entrate, che è un requisito per l'ambiente live.

Cosa abbiamo imparato

In questo esempio, abbiamo imparato diverse cose.

Dobbiamo configurare l'SDK creando un'istanza di Configuration e passando username (chiave API) e host (URL dell'API).
Usiamo il context manager with per gestire automaticamente la chiusura del client API. Istanziamo ApiClient passando la configurazione.
Dobbiamo istanziare una classe che rappresenta l'endpoint con cui vogliamo lavorare. In questo caso, utilizziamo ReceiveApi per scaricare le fatture in arrivo, passando il client API.
Le classi endpoint come ReceiveApi offrono metodi per interagire con la loro entità target. Chiamiamo receive_get() per recuperare le fatture. Poiché vogliamo solo fatture nuove e non lette, passiamo unread=True. Passiamo anche include_payload=True per recuperare il contenuto effettivo della fattura.
Gli oggetti fattura espongono attributi come encoding, file_name e payload. L'ultimo contiene il contenuto della fattura, come testo semplice o codificato in Base64, come descritto da encoding.

Codice sorgente su GitHub

Il codice sorgente per questo Quickstart è disponibile anche su GitHub.

Send

Creare l'applicazione

Il primo passo è creare la directory dell'applicazione:

mkdir send && cd send

Installare l'SDK

Installa l'SDK Python di Invoicetronic:

pip install invoicetronic-sdk

Una volta fatto, apri VS Code nella directory corrente:

code .

Configurare l'SDK

Crea un nuovo file chiamato index.py e aggiungi il seguente codice:

Configurare l'SDK

import invoicetronic_sdk
from invoicetronic_sdk.rest import ApiException
from invoicetronic_sdk.models.send import Send

# Configura l'SDK
configuration = invoicetronic_sdk.Configuration(
    username='LA TUA CHIAVE API DI TEST (inizia con ik_test_)',
    host='https://api.invoicetronic.com/v1'
)

Come puoi vedere, configuriamo l'SDK passando la tua chiave API di test (non quella live) e l'host dell'API. Nota come usiamo il parametro 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 l'API Sandbox, e l'altra è quella live. 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.

Inviare una fattura

Siamo pronti per effettuare una richiesta. Vogliamo inviare una fattura all'SDI. Aggiungi il seguente codice:

Inviare una fattura

import os

# Invia una fattura
file_path = '/qualche/percorso/file/nomefile.xml'

meta_data = {
    'internal_id': '123',
    'created_with': 'myapp',
    'some_other_custom_data': 'value'
}

with invoicetronic_sdk.ApiClient(configuration) as api_client:
    send_api = invoicetronic_sdk.SendApi(api_client)

    try:
        with open(file_path, 'r', encoding='utf-8') as f:
            payload = f.read()

        send_data = Send(
            file_name=os.path.basename(file_path),
            payload=payload,
            meta_data=meta_data
        )

        sent_invoice = send_api.send_post(send_data)

        print(f"La fattura è stata inviata con successo, ora ha l'Id univoco {sent_invoice.id}.")

    except ApiException as e:
        print(f"Errore: {e}")

Nel terminale, esegui l'applicazione:

python index.py

Dovresti ottenere un output simile a questo:

La fattura è stata inviata con successo, ora ha l'Id univoco 123.

Cosa abbiamo imparato

In questo esempio, abbiamo imparato diverse cose.

Dobbiamo configurare l'SDK creando un'istanza di Configuration e passando username (chiave API) e host (URL dell'API).
Usiamo il context manager with per gestire automaticamente la chiusura del client API. Istanziamo ApiClient passando la configurazione.
Dobbiamo istanziare una classe che rappresenta l'endpoint con cui vogliamo lavorare. In questo caso, utilizziamo SendApi per inviare fatture. Le classi endpoint come SendApi offrono metodi per interagire con la loro entità target. Chiamiamo send_post() per inviare una fattura.
Il modello Send espone attributi come file_name, meta_data e payload. L'ultimo contiene il contenuto della fattura, mentre meta_data è opzionale e lega dati personalizzati al documento.

Codice sorgente su GitHub

Il codice sorgente per questo Quickstart è disponibile anche su GitHub.