OrderResponse
Successful response with one Order
Always 0 in a successful response
0Always null in a successful response
data objectrequired
Resource returned by the operation
Type of the order: P (purchase), R (renewal) or U (update)
status objectrequired
Processing status of an order
One of NEW, TO_MANAGE (to be processed), EMITTED (completed), CANCELED or CLOSED
Name of the status shown to the customer, in Italian
payment_status objectrequired
Payment status of an order
One of NOT_PAYED, PARTIALLY_PAYED or PAYED
Name of the status, in Italian
invoice_status objectrequired
Invoicing status of an order
One of UNKNOWN, EVALUATION, NO_INVOICE (not to be invoiced), READY, PROCESSING, TO_INVOICE, INVOICING or INVOICED
Name of the status, in Italian
invoice objectrequired
Invoice of the order; null while the order is not invoiced
- Invoice
- null
billing objectrequired
Billing profile: the holder the documents are made out to, with its tax and electronic invoicing data
legal_entity objectrequired
Legal form of the holder of a billing profile, with its group
legal_entity_group objectrequired
Group of legal forms, such as private individuals or Italian companies
Code of the group, currently PRIVATE, ITALIAN_INDIVIDUAL_COMPANY, ITALIAN_LIMITED_COMPANY, ITALIAN_COOPERATIVE_COMPANY, ITALIAN_PUBLIC_ADMINISTRATION, FOREIGN_COMPANY or OTHER
Name of the group, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Code of the legal form: ITA_PVT, NOITA_PVT, ITA_INDIVIDUALE, ITA_CAPITALI, ITA_PERSONE, ITA_ASSNOCOMM, ITA_ASSCOMM, ITA_ALTRO, ITA_PA, EU_ALTRO, NOEU_ALTRO, VATICAN_NOPVT, SANMARINO_NOPVT or FORBIDDEN_NOITA_NOPVT
Name of the legal form, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Province: the acronym of the Italian province, for example VI, or EE outside Italy
country objectrequired
ie. IT
ie. ITA
Name of the country in Italian; the local name when there is no translation
Name of the country in its own language, for example Deutschland
International calling code, without +, for example 39
Continent, in English, for example Europe or North America
Area of the country: EU (European Union) or EXTRAEU
Gender of the holder: M or F; null when not given
Date of birth of the holder; null when not given
Place of birth of the holder; null when not given
Phone, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number; null when not given
VAT number of the holder (partita IVA in Italy); null when it has none
Whether the holder belongs to an Italian VAT group (Gruppo IVA), whose members share the VAT number and have each their own tax code
Tax code of the holder (codice fiscale in Italy)
PEC address (certified email, Posta Elettronica Certificata) to which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices when there is no recipient code; null when not given
Recipient code (Codice Destinatario) with which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices: 7 characters, 6 for the public administration; null when not given
Expiry date of the declaration of intent (dichiarazione d'intento) of a habitual exporter, whose invoices are without VAT; null when not given
Protocol number of the declaration of intent of a habitual exporter, written on the electronic invoices; null when not given
Date of the electronic receipt of the declaration of intent, issued by the Italian Revenue Agency (Agenzia delle Entrate); null when not given
Whether split payment (scissione dei pagamenti) applies: the tax regime is SPLIT_PAYMENT, and the customer pays the VAT of the invoices directly to the Italian State
Type of the invoice: NORMAL, DEPOSIT (top-up of the prepaid credit) or BALANCE (paid with the prepaid credit: some rows deduct the deposit invoices)
sdi_document_status objectrequired
Status of the invoice on SDI, the Italian e-invoicing exchange system; null for the invoices not sent through SDI, issued before electronic invoicing
- SdiDocumentStatus
- null
One of TO_SIGN, TO_SEND, SENT, DELIVERED, NOT_DELIVERED or DISCARDED (rejected by SDI)
Name of the status, in Italian
sdi_document_type objectrequired
Type of the electronic document on SDI; TD01 (invoice) when the invoice has none
- SdiDocumentType
- null
Code of the type, for example TD01 (invoice), TD02 (deposit invoice) or TD04 (credit note)
Description of the type, in Italian
Date of issue of the invoice
Year of the numbering of the invoice
Complete number of the invoice: the year followed by the number on 6 digits, for example 2025000123
Legal note of the tax regime printed on the invoice, in Italian, such as the law under which VAT is not applied; null when the regime has none
Additional reason (Causale) of the electronic invoice; null when there is none
Whether the invoice is paid
Identifier assigned by SDI to the invoice; null when it has not been sent to SDI
Name of the file sent to SDI; null when not sent, and for most invoices issued before November 2024
total_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
amount_no_balance objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
payment_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Ids of the orders of the invoice (GET /api/v3/orders/{order_id})
Number of rows of the invoice (GET /api/v3/invoices/{invoice_id}/rows)
billing objectrequired
Billing profile: the holder the documents are made out to, with its tax and electronic invoicing data
legal_entity objectrequired
Legal form of the holder of a billing profile, with its group
legal_entity_group objectrequired
Group of legal forms, such as private individuals or Italian companies
Code of the group, currently PRIVATE, ITALIAN_INDIVIDUAL_COMPANY, ITALIAN_LIMITED_COMPANY, ITALIAN_COOPERATIVE_COMPANY, ITALIAN_PUBLIC_ADMINISTRATION, FOREIGN_COMPANY or OTHER
Name of the group, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Code of the legal form: ITA_PVT, NOITA_PVT, ITA_INDIVIDUALE, ITA_CAPITALI, ITA_PERSONE, ITA_ASSNOCOMM, ITA_ASSCOMM, ITA_ALTRO, ITA_PA, EU_ALTRO, NOEU_ALTRO, VATICAN_NOPVT, SANMARINO_NOPVT or FORBIDDEN_NOITA_NOPVT
Name of the legal form, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Province: the acronym of the Italian province, for example VI, or EE outside Italy
country objectrequired
ie. IT
ie. ITA
Name of the country in Italian; the local name when there is no translation
Name of the country in its own language, for example Deutschland
International calling code, without +, for example 39
Continent, in English, for example Europe or North America
Area of the country: EU (European Union) or EXTRAEU
Gender of the holder: M or F; null when not given
Date of birth of the holder; null when not given
Place of birth of the holder; null when not given
Phone, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number; null when not given
VAT number of the holder (partita IVA in Italy); null when it has none
Whether the holder belongs to an Italian VAT group (Gruppo IVA), whose members share the VAT number and have each their own tax code
Tax code of the holder (codice fiscale in Italy)
PEC address (certified email, Posta Elettronica Certificata) to which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices when there is no recipient code; null when not given
Recipient code (Codice Destinatario) with which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices: 7 characters, 6 for the public administration; null when not given
Expiry date of the declaration of intent (dichiarazione d'intento) of a habitual exporter, whose invoices are without VAT; null when not given
Protocol number of the declaration of intent of a habitual exporter, written on the electronic invoices; null when not given
Date of the electronic receipt of the declaration of intent, issued by the Italian Revenue Agency (Agenzia delle Entrate); null when not given
Whether split payment (scissione dei pagamenti) applies: the tax regime is SPLIT_PAYMENT, and the customer pays the VAT of the invoices directly to the Italian State
Intent of the order: DEFAULT, DEPOSIT (top-up of the prepaid credit) or BALANCE (paid with the prepaid credit)
Date on which the order was fully paid; null while it is not
When the order was confirmed with deferred payment, to be paid later; null otherwise
Whether the order is fully paid
total_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
payment_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Where the order was created: web (control panel or cart), api (this API), api2 (API v2) or cli (automatic procedures, such as the renewals)
promotions object[]required
Promotions applied to the rows of the order; those that increase the price are shown only to administrators
Promotional code used; null when the promotion applies without a code
Promotion description; null when the promotion has none
Price increase, in percent; null for the other types
Discount, in percent; null for the other types
amount_increase objectrequired
Price increase, as an amount before VAT; null for the other types
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
amount_decrease objectrequired
Discount, as an amount before VAT; null for the other types
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
amount_fixed objectrequired
Fixed price set by the promotion, before VAT; null for the other types
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
applied_amount objectrequired
Difference between the base price and the price of the order row (base_price and price of OrderRow): negative when the promotion increases the price
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
When the promotion was applied to the order
Number of rows of the order (GET /api/v3/orders/{order_id}/rows)
Always null: only the paginated lists have a meta
null{
"error": 0,
"message": "string",
"data": {
"order_id": 0,
"type": "string",
"status": {
"status_code": "string",
"status_name": "string"
},
"payment_status": {
"status_code": "string",
"status_name": "string"
},
"invoice_status": {
"status_code": "string",
"status_name": "string"
},
"invoice": {
"invoice_id": 0,
"billing": {
"account_billing_id": 0,
"legal_entity": {
"legal_entity_group": {
"group_code": "string",
"group_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"entity_code": "string",
"entity_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"organization": "string",
"name": "string",
"surname": "string",
"address": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": {
"iso_code_2": "string",
"iso_code_3": "string",
"country_name": "string",
"local_name": "string",
"phone_code": "string",
"continent": "string",
"region": "string"
},
"gender": "string",
"birth_date": "2024-07-29",
"birth_place": "string",
"phone": "string",
"vat_number": "string",
"is_vat_group": true,
"fiscal_code": "string",
"edocument_pec": "string",
"edocument_code": "string",
"exporter_expiry": "2024-07-29",
"exporter_number": "string",
"exporter_date": "2024-07-29",
"is_split_payment": true
},
"type": "string",
"sdi_document_status": {
"status_code": "string",
"status_name": "string"
},
"sdi_document_type": {
"type_code": "string",
"type_description": "string"
},
"date_emitted": "2024-07-29",
"invoice_year": 0,
"invoice_number": "string",
"invoice_caption": "string",
"invoice_caption_additional": "string",
"payed": true,
"sdi_identifier": "string",
"sdi_filename": "string",
"total_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"amount_no_balance": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"payment_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"orders": [
0
],
"rows_count": 0,
"date_created": "2024-07-29T15:51:28.071Z"
},
"billing": {
"account_billing_id": 0,
"legal_entity": {
"legal_entity_group": {
"group_code": "string",
"group_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"entity_code": "string",
"entity_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"organization": "string",
"name": "string",
"surname": "string",
"address": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": {
"iso_code_2": "string",
"iso_code_3": "string",
"country_name": "string",
"local_name": "string",
"phone_code": "string",
"continent": "string",
"region": "string"
},
"gender": "string",
"birth_date": "2024-07-29",
"birth_place": "string",
"phone": "string",
"vat_number": "string",
"is_vat_group": true,
"fiscal_code": "string",
"edocument_pec": "string",
"edocument_code": "string",
"exporter_expiry": "2024-07-29",
"exporter_number": "string",
"exporter_date": "2024-07-29",
"is_split_payment": true
},
"intent_type": "string",
"date_payed": "2024-07-29",
"date_confirmed": "2024-07-29T15:51:28.071Z",
"payed": true,
"total_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"payment_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"origin": "string",
"promotions": [
{
"promocode": "string",
"description": "string",
"percentage_increase": 0,
"percentage_decrease": 0,
"amount_increase": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"amount_decrease": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"amount_fixed": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"applied_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"date_applied": "2024-07-29T15:51:28.071Z"
}
],
"rows_count": 0,
"date_created": "2024-07-29T15:51:28.071Z"
}
}