Di seguito le specifiche per impostare l'esportazione delle fatture verso l'esterno. Vedi maggiori dettagli.
NewCart: Specifiche del webservice per l'esportazione delle fatture
Panoramica.
Le fatture generate nell'E-shop NewCart possono essere esportate successivamente grazie ad appositi webservices. Questo documento definisce il formato dei dati che verranno esportati nonchè il set di parametri di input supportati dal webservice.
Note generali
L'output del webservice produce un documento XML formattato secondo gli standards XML, di seguito una lista di parametri necessari per il suo utilizzo.
Parametro di input |
Tipo dato |
Obbligatorio |
Descrizione |
login |
string |
SI |
Login Amministratore |
password |
string |
SI |
Password Amministratore |
from_date |
integer |
NO |
Data minima (nel formato YYYY-MM-DD) per le fatture che si vorranno includere nell'esportazione |
to_date |
integer |
NO |
Data massima (nel formato YYYY-MM-DD) per le fatture che si vorranno includere nell'esportazione |
from_number |
integer |
NO |
Numero di fattura minimo da includere nell'esportazione. (usato in combinazione con year) |
to_number |
integer |
NO |
Numero di fattura massimo da includere nell'esportazione. (usato in combinazione con year) |
sequence |
string |
NO |
Suffisso delle fatture da includere nell'esportazione. |
year |
integer |
NO |
Annulla i parametri from_date e to_date. Include nell'esportazione tutte le fatture dell'anno impostato e può essere usato in combinazione con from_number e to_number. |
locale |
string |
NO |
Codice ISO della lingua (due lettere) |
client_country |
string |
NO |
Codice ISO (due lettere) del paese del cessionario (cliente) della fattura |
Tutti i parametri sopra elencati sono CASE SENSITIVE e possono essere inviati allo script usando sia la modalità POST sia la modalità GET.
I valori che esprimono una data devono essere rappresentati nella forma che segue: (2011-05-24)
Esempio di output
In questo esempio vediamo il dettaglio di una fattura con tutti i valori esportati e le linee che ne compongono il dettaglio:
<invoices> <Invoice_id_821> <number>1</number> <sequence>A</sequence> <date>20160102</date> <totalnet>124.1400000000</totalnet> <grandtotal>151.45</grandtotal> <customer> <customer_id>12345</customer_id> <customer_name>Mario Rossi</customer_name> <first_name>Mario</first_name> <last_name>Rossi</last_name> <address>via Roma 61/bis</address> <city>Ponte San Pietro</city> <state>Bergamo</state> <country_ISO>IT</country_ISO> <postal_code>24036</postal_code> <email>mariobianchi@lamiaemail.com</email> <phone>123456789</phone> <fax/> <personal_id>AAAAAA99A99A999A</personal_id> <vat_number/> </customer> <vat> <VAT_22>124.14</VAT_22> </vat> <LINE_0> <vatperc>22.0000000000</vatperc> <quantity>1</quantity> <code>IEC0018</code> <description>NC-P303</description> <unit_price>56.5573770492</unit_price> <discount>0</discount> <price>56.5573770492</price> </LINE_0> <LINE_1> <vatperc>22.0000000000</vatperc> <quantity>1</quantity> <code>SCH0018</code> <description>NC-P312</description> <unit_price>56.5573770492</unit_price> <discount>0</discount> <price>56.5573770492</price> </LINE_1> <LINE_2> <vatperc/> <quantity>1</quantity> <code/> <description>sovrapprezzo paypal</description> <unit_price>4.5245901639</unit_price> <discount/> <price>4.5245901639</price> </LINE_2> <LINE_3> <vatperc>22.0000000000</vatperc> <quantity>1</quantity> <code/> <description>Costi spedizione</description> <unit_price>6.5000000000</unit_price> <discount/> <price>6.5000000000</price> </LINE_3> <LINE_4> <vatperc>22.0000000000</vatperc> <quantity>1</quantity> <code/> <description>Contributo di gestione ordine</description> <unit_price>0.0000000000</unit_price> <discount/> <price>0.0000000000</price> </LINE_4> </Invoice_id_821> </invoices> |
Lista di possibili codici di errore:
Codice |
Script |
Descrizione |
1390 |
invoices_export.php |
E' necessario il login per accedere alla pagina |
1391 |
invoices_export.php |
Il linguaggio richiesto non è supportato |
1392 |
invoices_export.php |
The sequence you selected does not exist |
Esempi:
Esempio di richiesta delle fatture dell'anno corrente con messaggi in inglese:
http://www.mydomain.com/ws/invoices_export.php?login=xxxx&password=xxx&locale=EN
Esempio di richiesta delle fatture emesse con suffisso "B" in uno specifico range di date:
http://www.mydomain.com/ws/invoices_export.php?login=xxxx&password=xxx&from_date=2016-02-01&to_date=2016-02-20&sequence=B
Esempio di richiesta di un range di fatture definito per numeri fattura e relativo ad un anno specifico:
http://www.mydomain.com/ws/invoices_export.php?login=xxxx&password=xxx&from_number=2&to_number=25&year=2015
Esempio di richiesta di una lista di fatture a partire da un numero specifico e relativa ad un anno specifico:
http://www.mydomain.com/ws/invoices_export.php?login=xxxx&password=xxx&from_number=20&year=2015
Esempio di richiesta di una lista di fatture relativa ad un anno specifico fino ad un numero di fattura specifico:
http://www.mydomain.com/ws/invoices_export.php?login=xxxx&password=xxx&to_number=200&year=2015