Tutte le informazioni di cui hai bisogno
Qui trovi qualche consiglio da prendere in considerazione per approcciare a questa API. Se preferisci forniamo esempi di codice, documentazione in OAS3, la possibilità di provare l'API dal vivo con la Swagger UI oppure importare l'intera collezione in Postman. Offriamo inoltre un ambiente di Sandbox dove puoi sperimentare tutte le API gratuitamente.
Utili consigli per iniziare con
Invoice
Prendi il token nell'apposita sezione prima di cominciare.
Usa lo strumento online o generalo via API. Imposta una data di scadenza e aggiungi una serie di Scopes per limitare le possibli azioni permesse al token.
Configura l'azienda
Creazione di una nuova configurazione
POST /IT-configurations
Questo endpoint permette di creare una nuova configurazione per l'azienda. È possibile anche specificare le credenziali e gli URL di callback per ricevere notifiche sugli scontrini.
Visualizzazione delle configurazioni
GET /IT-configurations
Questo endpoint consente di ottenere l'elenco delle configurazioni registrate per l'azienda, comprese le credenziali e le callback impostate.
Aggiornamento di una configurazione esistente
PATCH /IT-configurations/{fiscal_id}
Questo endpoint consente di aggiornare le credenziali, aggiungere opzioni e modificare gli URL di callback associati a una configurazione esistente.
Eliminazione di una configurazione
DELETE /IT-configurations/{fiscal_id}
Questo endpoint permette di eliminare una configurazione. Nota: se sono già stati inviati scontrini con questa configurazione, non sarà più possibile eliminarla.
POST /IT-configurations
Questo endpoint permette di creare una nuova configurazione per l'azienda. È possibile anche specificare le credenziali e gli URL di callback per ricevere notifiche sugli scontrini.
Visualizzazione delle configurazioni
GET /IT-configurations
Questo endpoint consente di ottenere l'elenco delle configurazioni registrate per l'azienda, comprese le credenziali e le callback impostate.
Aggiornamento di una configurazione esistente
PATCH /IT-configurations/{fiscal_id}
Questo endpoint consente di aggiornare le credenziali, aggiungere opzioni e modificare gli URL di callback associati a una configurazione esistente.
Eliminazione di una configurazione
DELETE /IT-configurations/{fiscal_id}
Questo endpoint permette di eliminare una configurazione. Nota: se sono già stati inviati scontrini con questa configurazione, non sarà più possibile eliminarla.
Gestione degli scontrini
Utilizza i seguenti endpoint per gestire gli scontrini elettronici:
Creazione di un nuovo scontrino
POST /IT-receipts
Questo endpoint permette di inviare un nuovo scontrino elettronico. Il sistema genererà un id per identificare univocamente lo scontrino e invierà una notifica all'URL configurato.
Registrazione di un reso
PATCH /IT-receipts/{id}
Se un cliente restituisce un prodotto, questo endpoint consente di aggiornare lo scontrino esistente e generarne uno per registrare il reso.
Annullamento di uno scontrino
DELETE /IT-receipts/{id}
Questo endpoint consente di annullare uno scontrino precedentemente inviato, generando uno scontrino di annullamento. Il sistema invierà una notifica di annullamento all'URL configurato.
Visualizzazione degli scontrini
GET /IT-receipts
Questo endpoint restituisce l'elenco degli scontrini registrati, con la possibilità di filtrare per data, importo o altri parametri.
Creazione di un nuovo scontrino
POST /IT-receipts
Questo endpoint permette di inviare un nuovo scontrino elettronico. Il sistema genererà un id per identificare univocamente lo scontrino e invierà una notifica all'URL configurato.
Registrazione di un reso
PATCH /IT-receipts/{id}
Se un cliente restituisce un prodotto, questo endpoint consente di aggiornare lo scontrino esistente e generarne uno per registrare il reso.
Annullamento di uno scontrino
DELETE /IT-receipts/{id}
Questo endpoint consente di annullare uno scontrino precedentemente inviato, generando uno scontrino di annullamento. Il sistema invierà una notifica di annullamento all'URL configurato.
Visualizzazione degli scontrini
GET /IT-receipts
Questo endpoint restituisce l'elenco degli scontrini registrati, con la possibilità di filtrare per data, importo o altri parametri.
- Oas file url https://alpha.console.openapi.com/oas/it/invoice.openapi.json
- Fork or import with Postman
- Production domain alpha.invoice.openapi.com
- Sandbox domain alpha.invoice.openapi.com
-
Production Scopes 10
- POST alpha.invoice.openapi.com/IT-configurations
- DELETE alpha.invoice.openapi.com/IT-configurations
- GET alpha.invoice.openapi.com/IT-configurations
- PATCH alpha.invoice.openapi.com/IT-configurations
- POST alpha.invoice.openapi.com/IT-receipts
- GET alpha.invoice.openapi.com/IT-receipts
- DELETE alpha.invoice.openapi.com/IT-receipts
- PATCH alpha.invoice.openapi.com/IT-receipts
- POST alpha.invoice.openapi.com/IT-invoices
- GET alpha.invoice.openapi.com/IT-invoices
-
Sandbox Scopes 10
- POST alpha.invoice.openapi.com/IT-configurations
- DELETE alpha.invoice.openapi.com/IT-configurations
- GET alpha.invoice.openapi.com/IT-configurations
- PATCH alpha.invoice.openapi.com/IT-configurations
- POST alpha.invoice.openapi.com/IT-receipts
- GET alpha.invoice.openapi.com/IT-receipts
- DELETE alpha.invoice.openapi.com/IT-receipts
- PATCH alpha.invoice.openapi.com/IT-receipts
- POST alpha.invoice.openapi.com/IT-invoices
- GET alpha.invoice.openapi.com/IT-invoices
Redoc missing.