API Key di Fattura24

Le API di Fattura24 sono un’interfaccia software che ti permetterà di creare le tue fatture tramite semplici chiamate HTTPS.

Gli sviluppatori che utilizzano le nostre API potranno integrare facilmente il loro CRM o il loro e-commerce per automatizzare al 100% la creazione dei loro documenti.

Di solito le API dei servizi di fatturazioni sono molto complesse e ricche di opzioni, in Fattura24 abbiamo deciso di concentrarci sull’essenziale per permettere a tutti di integrarsi velocemente e senza impazzire.

Ecco cosa puoi fare con la nuova versione v.3.3 delle nostre API:

• verificare la validità della tua API KEY;
• creare un contatto cliente in rubrica;
• creare ordini cliente, ricevute e fatture;
• aggiornare in automatico i dati del tuo cliente in rubrica;
• creare uno o più crediti da fatturare in un secondo momento;
• scaricare il PDF del documento creato.

URL di accesso all’API e sicurezza

Le API di Fattura24 hanno un unico punto di accesso: https://www.app.fattura24.com/api/v0.3.

Tutte le chiamate dovranno essere cifrate tramite HTTPS ed eventuali chiamate non sicure potranno essere ignorate. A fronte di questo consigliamo di stabilire una connessione di prova con il nostro end point prima di inviare dati sensibili.

Per l’accesso alle funzionalità è necessario disporre di un’API KEY che potrà essere copiata accedendo dal proprio account al menu Configurazione > App e servizi esterni > API (nel sotto gruppo e-commerce e API).

LIMITI

• è possibile effettuare non più di 30 chiamate al minuto e non più di 200 chiamate l’ora e comunque non più di 500 chiamate nelle ultime 24 ore;
• le nostre API non gestiscono chiamate concorrenti, creare 1 o più documenti in parallelo potrebbe causare problemi sulle generazione del corretto numero progressivo dei documenti;
• tramite le API è possibile creare i documenti ma non modificarli, in caso fosse necessario apportare delle modifiche le stesse dovranno essere effettuate usando l’interfaccia grafica di Fattura24;
• con l’attuale versione non è possibile creare fatture con casse e ritenute previdenziali.

FORMATI UTILIZZATI

Tutte le richieste sono caratterizzate da chiamate a servizi web con uno o più parametri passati in POST:

• tutti i dati inviati a Fattura24 dovranno nel formato UTF-8;
• tutte le date dovranno rispettare il formato AAAA-MM-GG;
• i campi booleani dovranno essere valorizzati con true o false;
• tutti i campi numerici dovranno essere espressi nel formato decimale #.00;

Verificare l’API KEY tramite API

Questa è la chiamata che devi fare se vuoi verificare la validità dell’API KEY.

Come risultato l'API restituirà un XML simile a questo:
<root>
    <returnCode>1</returnCode>
    <description>Complimenti, la tua API KEY è corretta.</description>
</root>

Nota: In caso di errore, il campo returnCode conterrà -1 e la causa dell’errore sarà riportata nel campo description.

Creare un contatto cliente in rubrica

La chiamata che dovrai fare per creare un contatto cliente nella rubrica di Fattura24 avrà le seguenti caratteristiche.

<?xml version="1.0" encoding="UTF-8"?>
<Fattura24>
    <Document>
        <CustomerName>MARIO ROSSI</CustomerName>
        <CustomerAddress>Via Alberti 8</CustomerAddress>
        <CustomerPostcode>06122</CustomerPostcode>
        <CustomerCity>Perugia</CustomerCity>
        <CustomerProvince>PG</CustomerProvince>
        <CustomerCountry></CustomerCountry>
        <CustomerFiscalCode>MARROS66C44G217W</CustomerFiscalCode>
        <CustomerVatCode>03912377542</CustomerVatCode>
        <CustomerCellPhone>335123456789</CustomerCellPhone>
        <CustomerEmail>info@rossi.i</CustomerEmail>
        <FeCustomerPec>test@pec.it</FeCustomerPec>
        <FeDestinationCode>0000000</FeDestinationCode>
    </Document>
</Fattura24>

Le chiavi che permettono a Fattura24 di sapere se quel contatto è già presente in rubrica sono: P.IVA, codice fiscale e ragione sociale.

Alla prima chiave trovata, il sistema ignorerà le successive. In altre parole se viene trovato un contatto con la stessa P.IVA ricevuta in input, Fattura24 non verificherà le successive chiavi: codice fiscale e ragione sociale.

Creare un documento con le API

La chiamata che dovrai fare per creare un documento avrà le seguenti caratteristiche.

<Fattura24>
    <Document>
        <DocumentType>I</DocumentType>
        <CustomerName>Mario Rossi</CustomerName>
        <CustomerAddress>Via Alberti 8</CustomerAddress>
        <CustomerPostcode>06122</CustomerPostcode>
        <CustomerCity>Perugia</CustomerCity>
        <CustomerProvince>PG</CustomerProvince>
        <CustomerCountry></CustomerCountry>
        <CustomerFiscalCode>MARROS66C44G217W</CustomerFiscalCode>
        <CustomerVatCode>03912377542</CustomerVatCode>
        <CustomerCellPhone>335123456789</CustomerCellPhone>
        <CustomerEmail>info@rossi.it</CustomerEmail>
        <DeliveryName>Mario Rossi</DeliveryName>
        <DeliveryAddress>Via Alberti 8</DeliveryAddress>
        <DeliveryPostcode>06122</DeliveryPostcode>
        <DeliveryCity>Perugia</DeliveryCity>
        <DeliveryProvince>PG</DeliveryProvince>
        <DeliveryCountry></DeliveryCountry>
        <Object>Oggetto del documento</Object>
        <TotalWithoutTax>900.00</TotalWithoutTax>
        <PaymentMethodName>Banca Popolare di.....</PaymentMethodName>
        <PaymentMethodDescription>IT02L1234512345123456789012</PaymentMethodDescription>
        <VatAmount>198.00</VatAmount>
        <Total>1098.00</Total>
        <FootNotes>Vi ringraziamo per la preferenza accordataci</FootNotes>
        <SendEmail>true</SendEmail>
        <F24OrderId>12345</F24OrderId>
        <IdTemplate>123</IdTemplate>
        <Payments>
            <Payment>
                <Date>2016-02-23</Date>
                <Amount>2135</Amount>
                <Paid>true</Paid>
            </Payment>
        </Payments>    
        <Rows>
            <Row>
                <Code>0001</Code>
                <Description>PULIZIA NUM. DUE FINESTRE</Description>
                <Qty>2</Qty>
                <Um></Um>
                <Price>200.00</Price>
                <Discounts>0</Discounts>
                <VatCode>22</VatCode>
                <VatDescription>22%</VatDescription>
            </Row>
            <Row>
                <Code>0002</Code>
                <Description>PULIZIA  NUM. DUE FINESTRONI</Description>
                <Qty>2</Qty>
                <Um></Um>
                <Price>250.00</Price>
                <Discounts>0</Discounts>
                <VatCode>22</VatCode>
                <VatDescription>22%</VatDescription>
            </Row>
        </Rows>
    </Document>
</Fattura24>

NOTE:

• L’attributo DocumentType andrà valorizzato con:
  • I per creare una Fattura;
  • R per creare una Ricevuta;
  • C per creare un Ordine Cliente;
  • N per creare una Nota di credito;
• Se vuoi indicare il numero del documento dovrai aggiungere il tag <Number>XXXXX</Number>;
• Se vuoi indicare la data del documento dovrai aggiungere il tag <Date>YYYY-MM-DD</Date>;
• In assenza della partita IVA sul cliente, il sistema creerà una ricevuta anziché una fattura. Per forzare la creazione di una fattura sarà necessario valorizzare l’attributo DocumentType con I-force;
• Gli attributi Price e Total di Row andranno valorizzati con gli importi al netto dell’IVA;
• Se vuoi che il documento creato venga automaticamente inviato via email al cliente, dovrai valorizzare a true il campo SendEmail, altrimenti a false (Attenzione: per evitare di inviare al proprio cliente un documento di cortesia relativo ad una fattura elettronica non ancora accettata dall’Agenzia delle Entrate e che potrebbe essere da quest’ultima scartata, l’invio tramite email per questo genere di documenti è disabilitato);
• Se il parametro Paid presente in Payment viene valorizzato a true, il pagamento verrà automaticamente reso disponibile anche nella Prima Nota di Fattura24;
• Per annullare la movimentazione causata da un ordine, valorizza il campo F24OrderId con l’Id dell’ordine.

Durante la creazione del documento, il sistema utilizzerà la P.IVA e/o il C.F. del cliente presente nella rubrica (aggiornato con i dati che avrai inserito nell’XML), in caso negativo verrà creato un nuovo contatto.

A salvataggio ultimato il sistema restituirà un XML con l’ID del documento creato.

<root>
    <returnCode>0</returnCode>
    <description>Operazione completata con successo</description>
    <docId>953921</docId>
    <docNumber>01/YYYY<docNumber>
</root>

Il campo docID sarà utile oltre alla creazione del documento anche per scaricare il file PDF.

Il campo docNumber conterrà il numero del documento creato.

Scaricare il PDF di un documento

In qualsiasi momento potrai scaricare il PDF dei tuoi documenti utilizzando il docId che il sistema ti ha restituito in fase di creazione dei documenti.

Questa è la chiamata che dovrai fare:

Creare una fattura elettronica con le API

La chiamata che dovrai fare per creare una fattura elettronica avrà le seguenti caratteristiche.

<?xml version="1.0" encoding="UTF-8"?>
<Fattura24>
    <Document>
        <DocumentType>FE</DocumentType>
        <CustomerName><![CDATA[Ferramenta Tal Dei Tali Srl]]></CustomerName>
        <CustomerAddress><![CDATA[Via Roma n.49]]></CustomerAddress>
        <CustomerPostcode>00100</CustomerPostcode>
        <CustomerCity>Roma</CustomerCity>
        <CustomerProvince>RM</CustomerProvince>
        <CustomerCountry>IT</CustomerCountry>
        <CustomerFiscalCode/>
        <CustomerVatCode>01993350332</CustomerVatCode>
        <CustomerCellPhone>test@test.com</CustomerCellPhone>
        <CustomerEmail>test@test.it</CustomerEmail>
        <Object><![CDATA[Vendita alla cassa]]></Object>
        <FeCustomerPec>test@pec.it</FeCustomerPec>
        <FeDestinationCode>0000000</FeDestinationCode>
        <FePaymentCode>MP05</FePaymentCode>
        <PaymentMethodName>UBI Banca</PaymentMethodName>
        <PaymentMethodDescription>IT87A031110321</PaymentMethodDescription>
        <TotalWithoutTax>220.00</TotalWithoutTax>               
        <VatAmount>44.00</VatAmount>
        <Total>264.00</Total>
        <FootNotes/>
        <SendEmail>false</SendEmail>
        <Rows>
            <Row>
                <Description><![CDATA[Prodotto A]]></Description>
                <Qty>1</Qty>
                <Price>100.00</Price>
                <VatCode>22</VatCode>
                <VatDescription>22%</VatDescription>
            </Row>
            <Row>
                <Description><![CDATA[Prodotto B]]></Description>
                <Qty>1</Qty>
                <Um/>
                <Price>100.00</Price>
                <VatCode>22</VatCode>
                <VatDescription>22%</VatDescription>
            </Row>
            <Row>
                <Description><![CDATA[Spese di spedizione]]></Description>
                <Qty>1</Qty>
                <Price>20.00</Price>
                <VatCode>0</VatCode>
                <VatDescription>0%</VatDescription>
                <FeVatNature>N4</FeVatNature>
            </Row>
        </Rows>
    </Document>
</Fattura24>

PS: Le API di Fattura24 non permettono la creazione di nota di credito elettroniche.

In questo file potrai trovare un file xml di esempio per creare una semplice fattura elettronica: esempioFe.xml.

Come avrai notato l’XML è praticamente identico all’XML utilizzato per creare un documento generico o una fattura tradizionale in formato PDF.

Ci sono però 5 campi in più che devi tenere in considerazione perchè specifici per la fatturazione elettronica:

• VatType andrà aggiunto se è necessario indicare l’Esigibilità IVA (I: immediata, S: Split payment, D: Differita);
• FeVirtualStamp andrà aggiunto nel caso di applicazione del Bollo Virtuale in Fattura elettronica (V: attivo);
• FeCustomerPec andrà valorizzato con l’indirizzo PEC (se disponibile) del cliente al quale si sta emettendo fattura;
• FeDestinationCode andrà valorizzato con il codice destinatario del cliente (se disponibile);
  • MP01 per i pagamenti in contanti;
  • MP05 per i pagamenti tramite bonifico;
  • MP08 per i pagamenti tramite carta di credito;
  • MP12 per i pagamenti tramite Riba.FePaymentCode andrà valorizzato con uno di questi valori:

Se e solo se viene utilizzato MP05 dovrai valorizzare il tag PaymentMethodDescription con l’IBAN del venditore;

• FeVatNature andrà aggiunto nello ‘row’ di dettaglio dei prodotti/servici se e solo se l’aliquota di riferimento è allo 0%. Il campo serve per indicare all’Agenzia delle Entrate la tipologia di aliquota e andrà valorizzato con uno di questi valori:
  • N1‘ escluse ex art. 15;
  • N2.# non soggette;
  • N3.# non imponibili;
  • N4 esenti;
  • N5 regime del margine;
  • N6.# inversione contabile (reverse charge).

NOTA

Nel precedente elenco la voce # andrà sostituita con una delle sotto codifiche previste dall’Agenzia delle Entrate (ad esempio: N2.3).

IMPORTANTE

I campi FeCustomerPec e FeDestinationCode sono da considerarsi non obbligatori se il destinatario della fattura è un consumatore finale senza P.IVA, diversamente almeno uno dei due campi dovrà essere correttamente valorizzato.

Creare un Corrispettivo giornaliero con le API

La chiamata che dovrai fare per creare un corrispettivo avrà le seguenti caratteristiche:

<Fattura24>
    <Document>
       	<DocumentType>19</DocumentType>        	
	    <Date>2021-01-01</Date> 
	    <TotalWithoutTax>1000.00</TotalWithoutTax> 
	    <VatAmount>222.00</VatAmount> 
	    <Total>1222.00</Total> 
	    <FootNotes></FootNotes> 
	    <Rows> 
            <Row> 
                <Price>0.00</Price> 
                <VatCode>0</VatCode> 
                <VatDescription>0.0%</VatDescription> 
            </Row> 
            <Row> 
                <Price>1000.00</Price> 
                <VatCode>22</VatCode> 
                <VatDescription>22%</VatDescription> 
            </Row> 
        </Rows> 
        <Payments>
            <Payment>
                <Date>2021-01-01</Date>
                <Amount>1000.00</Amount>
                <BillAccount>Contante</BillAccount>
                <Paid>true</Paid>
            </Payment>
        </Payments>   
    </Document>
</Fattura24>

IMPORTANTE

• • quando un corrispettivo giornaliero viene creato con le API di Fattura24, eventuali altri Corrispettivi già presenti in Fattura24 con la medesima data verranno cancellati e sostituiti da quello che si sta andando a creare in quel momento;
  • allo stato attuale l’unico modo per inviare i dati di un corrispettivo giornaliero all’Agenzia delle Entrate è tramite un registratore di cassa telematico RT o utilizzando il portale Fattura e Corrispettivi della stessa Agenza delle Entrate. A fronte di questo, i corrispettivi giornalieri creati in Fattura24 non verranno inviati automaticamente all’Agenzia delle Entrate;
  • i campi Date di Document e Payment dovranno necessariamente contenere la stessa data;
  • il campo BillAccount dovrà contenere il come del conto sul quale registrare i pagamenti. Se il conto non è presente nel proprio account di Fattura24, verrà automaticamente aggiunto durante la creazione del primo corrispettivo.

Come ottenere la lista dei modelli dei documenti

Puoi ottenere la lista dei modelli personalizzati dei documenti, facendo la seguente chiamata:

Gestire il Piano dei Conti con le API

Puoi ottenere la lista dei conti, facendo la seguente chiamata:

Per associare un codice del piano dei conti al documento che si sta per creare è necessario aggiungere il tag IdPdc a ciascuna delle singole linee del documento.

In questo modo ad ogni voce nel documento sarà associato un codice del piano dei conti.

<Row>
    <Code>0001</Code>
    <Description>PULIZIA NUM. DUE FINESTRE A DUE ANTE</Description>
    <Qty>2</Qty>
    <Um></Um>
    <Price>200.00</Price>
    <Discounts>0</Discounts>
    <VatCode>22</VatCode>
    <VatDescription>22%</VatDescription>
    <IdPdc>XXXX</IdPdc>
</Row>

Ottenere la lista dei sezionali con le API

Puoi ottenere la lista dei sezionali, facendo la seguente chiamata.

Ottenere informazioni su una prestazione/prodotto

Puoi ottenere tutte le informazioni relative a un prodotto, facendo la seguente chiamata.

Creare un credito con le API

Con le API di Fattura24 puoi creare anche dei semplici crediti.

Un credito è una prestazione/prodotto che è stata già venduta/consegnata al cliente ma che vuoi fatturare manualmente in un secondo momento, ad esempio a fine mese.

La chiamata che dovrai fare per creare un credito avrà le seguenti caratteristiche.

<?xml version="1.0" encoding="UTF-8"?>
<Fattura24>
    <Document>
        <DocumentType>I</DocumentType>
        <CustomerName>MARIO ROSSI</CustomerName>
        <CustomerAddress>Via Alberti 8</CustomerAddress>
        <CustomerPostcode>06122</CustomerPostcode>
        <CustomerCity>Perugia</CustomerCity>
        <CustomerProvince>PG</CustomerProvince>
        <CustomerCountry></CustomerCountry>
        <CustomerFiscalCode>MARROS66C44G217W</CustomerFiscalCode>
        <CustomerVatCode>03912377542</CustomerVatCode>
        <CustomerCellPhone>335123456789</CustomerCellPhone>
        <CustomerEmail>info@rossi.it</CustomerEmail>  
        <Object>Oggetto del documento</Object> 
        <CustomField1></CustomField1>
        <CustomField2></CustomField2> 
        <Rows>
            <Row>
                <Code>0001</Code>
                <Description>PULIZIA NUM. DUE FINESTRE</Description>
                <Qty>2</Qty>
                <Um></Um>
                <Price>200.00</Price>
                <Discounts>0</Discounts>
                <VatCode>22</VatCode>
                <VatDescription>22%</VatDescription>
            </Row>
            <Row>
                <Code>0002</Code>
                <Description>PULIZIA  NUM. DUE FINESTRONI</Description>
                <Qty>2</Qty>
                <Um></Um>
                <Price>250.00</Price>
                <Discounts>0</Discounts>
                <VatCode>22</VatCode>
                <VatDescription>22%</VatDescription>
            </Row>
        </Rows>
    </Document>
</Fattura24>

Anche in questo caso, durante la creazione del credito il sistema utilizzerà la P.IVA e/o il C.F. del cliente per cercarlo nella tua rubrica. Se la ricerca termina positivamente verrà utilizzato il tuo contatto in rubrica (aggiornato con i dati che avrai inserito nell’XML), in caso negativo verrà creato un nuovo contatto.

Come vedi l’xml è praticamente identico a quello necessario a creare la fattura tranne che per le info specifiche di una fattura.

Postman: esempi per testare le API

Postman è un tool utilissimo che ti permetterà di familiarizzare velocemente le nostre API.

Per velocizzare al massimo i tuoi test abbiamo preparato un progetto Postman già pronto.

Per utilizzarlo ti basterà:

• importarlo in Postman;
• configurare i parametri con la tua API KEY e gli XML che vorrai testare;
• lanciare la chiamata alle nostre API.

Puoi scaricare l’ultima versione del nostro progetto qui: Fattura24_API.postman_collection.json.zip.

Se non hai Postman, puoi scaricarne la versione gratuita qui: https://www.postman.com/downloads/.

PHP e Visual Basic: esempio per integrare le API

Di seguito alcuni codici di esempio per integrare le API di Fattura24 utilizzando PHP e Visual Basic.

https://github.com/flaracca/fattura24-VB.NET;
https://github.com/flaracca/fattura24-PHP;

Fine, non c’è altro.

Come hai visto utilizzare le API di Fattura24 è veramente semplice e se volessi assistenza o supporto per un collaudo integrato consideraci a disposizione.