Passa al contenuto principale

Creare un documento

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

Chiamata

Endpoint:

https://www.app.fattura24.com/api/v0.3/SaveDocument

Parametri da passare in Post:

apiKey: API KEY associata al proprio account;
xml: una stringa simile alla seguente, contenente i dati del documento da creare.

Esempio XML

<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>
NOTA
  • 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.

IMPORTANTE

Prima di lanciare la chiamata alle nostre API effettua un URL Encoding dell'XML, altrimenti la chiamata andrà in errore.

Durante la creazione del documento, il sistema utilizzerà la partita IVA e/o il C.F. (codice fiscale) 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.

Risposta
<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.