Creditnote
Credit note of the account, with its total and electronic invoicing data
Id of the invoice the credit note refers to (GET /api/v3/invoices/{invoice_id}); null when it refers to none
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
sdi_document_status objectrequired
Status of the credit note on SDI, the Italian e-invoicing exchange system; null for the credit notes 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 an electronic document on SDI, the Italian e-invoicing exchange system (TipoDocumento)
Code of the type, for example TD01 (invoice), TD02 (deposit invoice) or TD04 (credit note)
Description of the type, in Italian
tax_regime objectrequired
Tax regime set on the credit note; null when it uses the one of the billing profile (billing.tax_regime)
- TaxRegime
- null
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%
Date of issue of the credit note
Year of the numbering of the credit note
Complete number of the credit note: the year followed by the number on 6 digits, for example 2025000123
Legal note of the tax regime printed on the credit note, in Italian, such as the law under which VAT is not applied; null when the regime has none
Identifier assigned by SDI to the credit note; null when it has not been sent to SDI
Name of the file sent to SDI; null when not sent, and for the credit notes 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
Number of rows of the credit note (GET /api/v3/credit-notes/{credit_note_id}/rows)
{
"creditnote_id": 0,
"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
},
"sdi_document_status": {
"status_code": "string",
"status_name": "string"
},
"sdi_document_type": {
"type_code": "string",
"type_description": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"date_emitted": "2024-07-29",
"creditnote_year": 0,
"creditnote_number": "string",
"creditnote_caption": "string",
"sdi_identifier": "string",
"sdi_filename": "string",
"total_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"rows_count": 0,
"date_created": "2024-07-29T15:51:28.071Z"
}