PrepaidCreditOperationResponse

Successful response with one PrepaidCreditOperation

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Operation on the prepaid credit, such as a top-up or a payment with the credit

operation_idintegerrequired

operation_id_relatedinteger | nullnullablerequired

Id of the payment with the credit (REDEMPTION) that the operation cancels, for REDEMPTION_CANCELLATION (GET /api/v3/prepaid-credit/operations/{operation_id}); null for the other types

prepaid_credit_topup objectrequired

Top-up whose credit the operation adds or uses

topup_idintegerrequired

invoice objectrequired

Deposit invoice of the top-up; null until it is issued

anyOf

• Invoice
• null

invoice_idintegerrequired

billing objectrequired

Billing profile: the holder the documents are made out to, with its tax and electronic invoicing data

account_billing_idintegerrequired

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

group_codestringrequired

Code of the group, currently PRIVATE, ITALIAN_INDIVIDUAL_COMPANY, ITALIAN_LIMITED_COMPANY, ITALIAN_COOPERATIVE_COMPANY, ITALIAN_PUBLIC_ADMINISTRATION, FOREIGN_COMPANY or OTHER

group_namestringrequired

Name of the group, in Italian

tax_regime objectrequired

Tax regime: how VAT applies to the documents

regime_codestringrequired

One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26

regime_namestringrequired

Name of the regime, in Italian, for example Ordinario

code_edocumentstring | nullnullablerequired

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

tax_ratefloatrequired

VAT rate as a fraction, for example 0.22 for 22%

entity_codestringrequired

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

entity_namestringrequired

Name of the legal form, in Italian

tax_regime objectrequired

Tax regime: how VAT applies to the documents

regime_codestringrequired

One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26

regime_namestringrequired

Name of the regime, in Italian, for example Ordinario

code_edocumentstring | nullnullablerequired

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

tax_ratefloatrequired

VAT rate as a fraction, for example 0.22 for 22%

organizationstring | nullnullablerequired

namestring | nullnullablerequired

surnamestring | nullnullablerequired

addressstringrequired

citystringrequired

statestringrequired

Province: the acronym of the Italian province, for example VI, or EE outside Italy

postal_codestringrequired

country objectrequired

iso_code_2stringrequired

ie. IT

iso_code_3stringrequired

ie. ITA

country_namestringrequired

Name of the country in Italian; the local name when there is no translation

local_namestringrequired

Name of the country in its own language, for example Deutschland

phone_codestringrequired

International calling code, without +, for example 39

continentstringrequired

Continent, in English, for example Europe or North America

regionstringrequired

Area of the country: EU (European Union) or EXTRAEU

genderstring | nullnullablerequired

Gender of the holder: M or F; null when not given

birth_datedatenullablerequired

Date of birth of the holder; null when not given

birth_placestring | nullnullablerequired

Place of birth of the holder; null when not given

phonestring | nullnullablerequired

Phone, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number; null when not given

vat_numberstring | nullnullablerequired

VAT number of the holder (partita IVA in Italy); null when it has none

is_vat_groupbooleanrequired

Whether the holder belongs to an Italian VAT group (Gruppo IVA), whose members share the VAT number and have each their own tax code

fiscal_codestringrequired

Tax code of the holder (codice fiscale in Italy)

edocument_pecstring | nullnullablerequired

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

edocument_codestring | nullnullablerequired

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

exporter_expirydatenullablerequired

Expiry date of the declaration of intent (dichiarazione d'intento) of a habitual exporter, whose invoices are without VAT; null when not given

exporter_numberstring | nullnullablerequired

Protocol number of the declaration of intent of a habitual exporter, written on the electronic invoices; null when not given

exporter_datedatenullablerequired

Date of the electronic receipt of the declaration of intent, issued by the Italian Revenue Agency (Agenzia delle Entrate); null when not given

is_split_paymentbooleanrequired

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

typestring | nullnullablerequired

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

anyOf

• SdiDocumentStatus
• null

status_codestringrequired

One of TO_SIGN, TO_SEND, SENT, DELIVERED, NOT_DELIVERED or DISCARDED (rejected by SDI)

status_namestringrequired

Name of the status, in Italian

sdi_document_type objectrequired

Type of the electronic document on SDI; TD01 (invoice) when the invoice has none

anyOf

• SdiDocumentType
• null

type_codestringrequired

Code of the type, for example TD01 (invoice), TD02 (deposit invoice) or TD04 (credit note)

type_descriptionstringrequired

Description of the type, in Italian

date_emitteddaterequired

Date of issue of the invoice

invoice_yearinteger | nullnullablerequired

Year of the numbering of the invoice

invoice_numberstringrequired

Complete number of the invoice: the year followed by the number on 6 digits, for example 2025000123

invoice_captionstring | nullnullablerequired

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

invoice_caption_additionalstring | nullnullablerequired

Additional reason (Causale) of the electronic invoice; null when there is none

payedbooleanrequired

Whether the invoice is paid

sdi_identifierstring | nullnullablerequired

Identifier assigned by SDI to the invoice; null when it has not been sent to SDI

sdi_filenamestring | nullnullablerequired

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

amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

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

amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

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

amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

ordersinteger[]required

Ids of the orders of the invoice (GET /api/v3/orders/{order_id})

rows_countintegerrequired

Number of rows of the invoice (GET /api/v3/invoices/{invoice_id}/rows)

date_createddate-timerequired

initial_credit objectrequired

Amount in euros, without the VAT details of Amount

amountfloatrequired

Amount, in euros

currencystringrequired

Currency code: always EUR

current_credit objectrequired

Amount in euros, without the VAT details of Amount

amountfloatrequired

Amount, in euros

currencystringrequired

Currency code: always EUR

refund_expirydatenullablerequired

Last day on which the credit left can be refunded; null when there is no limit

credit_expirydatenullablerequired

Expiry date of the credit of the top-up; null when it does not expire

date_createddate-timerequired

operation_type objectrequired

Type of an operation on the prepaid credit

type_codestringrequired

One of TOP_UP, REDEMPTION (payment with the credit), REDEMPTION_CANCELLATION, PAYMENT_CANCELLATION, REFUND, CREDIT_CANCELLATION, RESET_CREDIT or RESELLER_SHOP_REFUND

type_descriptionstringrequired

Name of the type, in Italian

creditnote objectrequired

Credit note issued for the operation, for REFUND and CREDIT_CANCELLATION; null for the other types

anyOf

• Creditnote
• null

creditnote_idintegerrequired

invoice_idinteger | nullnullablerequired

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

account_billing_idintegerrequired

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

group_codestringrequired

Code of the group, currently PRIVATE, ITALIAN_INDIVIDUAL_COMPANY, ITALIAN_LIMITED_COMPANY, ITALIAN_COOPERATIVE_COMPANY, ITALIAN_PUBLIC_ADMINISTRATION, FOREIGN_COMPANY or OTHER

group_namestringrequired

Name of the group, in Italian

tax_regime objectrequired

Tax regime: how VAT applies to the documents

regime_codestringrequired

One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26

regime_namestringrequired

Name of the regime, in Italian, for example Ordinario

code_edocumentstring | nullnullablerequired

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

tax_ratefloatrequired

VAT rate as a fraction, for example 0.22 for 22%

entity_codestringrequired

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

entity_namestringrequired

Name of the legal form, in Italian

tax_regime objectrequired

Tax regime: how VAT applies to the documents

regime_codestringrequired

One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26

regime_namestringrequired

Name of the regime, in Italian, for example Ordinario

code_edocumentstring | nullnullablerequired

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

tax_ratefloatrequired

VAT rate as a fraction, for example 0.22 for 22%

organizationstring | nullnullablerequired

namestring | nullnullablerequired

surnamestring | nullnullablerequired

addressstringrequired

citystringrequired

statestringrequired

Province: the acronym of the Italian province, for example VI, or EE outside Italy

postal_codestringrequired

country objectrequired

iso_code_2stringrequired

ie. IT

iso_code_3stringrequired

ie. ITA

country_namestringrequired

Name of the country in Italian; the local name when there is no translation

local_namestringrequired

Name of the country in its own language, for example Deutschland

phone_codestringrequired

International calling code, without +, for example 39

continentstringrequired

Continent, in English, for example Europe or North America

regionstringrequired

Area of the country: EU (European Union) or EXTRAEU

genderstring | nullnullablerequired

Gender of the holder: M or F; null when not given

birth_datedatenullablerequired

Date of birth of the holder; null when not given

birth_placestring | nullnullablerequired

Place of birth of the holder; null when not given

phonestring | nullnullablerequired

Phone, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number; null when not given

vat_numberstring | nullnullablerequired

VAT number of the holder (partita IVA in Italy); null when it has none

is_vat_groupbooleanrequired

Whether the holder belongs to an Italian VAT group (Gruppo IVA), whose members share the VAT number and have each their own tax code

fiscal_codestringrequired

Tax code of the holder (codice fiscale in Italy)

edocument_pecstring | nullnullablerequired

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

edocument_codestring | nullnullablerequired

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

exporter_expirydatenullablerequired

Expiry date of the declaration of intent (dichiarazione d'intento) of a habitual exporter, whose invoices are without VAT; null when not given

exporter_numberstring | nullnullablerequired

Protocol number of the declaration of intent of a habitual exporter, written on the electronic invoices; null when not given

exporter_datedatenullablerequired

Date of the electronic receipt of the declaration of intent, issued by the Italian Revenue Agency (Agenzia delle Entrate); null when not given

is_split_paymentbooleanrequired

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

anyOf

• SdiDocumentStatus
• null

status_codestringrequired

One of TO_SIGN, TO_SEND, SENT, DELIVERED, NOT_DELIVERED or DISCARDED (rejected by SDI)

status_namestringrequired

Name of the status, in Italian

sdi_document_type objectrequired

Type of an electronic document on SDI, the Italian e-invoicing exchange system (TipoDocumento)

type_codestringrequired

Code of the type, for example TD01 (invoice), TD02 (deposit invoice) or TD04 (credit note)

type_descriptionstringrequired

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)

anyOf

• TaxRegime
• null

regime_codestringrequired

One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26

regime_namestringrequired

Name of the regime, in Italian, for example Ordinario

code_edocumentstring | nullnullablerequired

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

tax_ratefloatrequired

VAT rate as a fraction, for example 0.22 for 22%

date_emitteddaterequired

Date of issue of the credit note

creditnote_yearinteger | nullnullablerequired

Year of the numbering of the credit note

creditnote_numberstringrequired

Complete number of the credit note: the year followed by the number on 6 digits, for example 2025000123

creditnote_captionstring | nullnullablerequired

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

sdi_identifierstring | nullnullablerequired

Identifier assigned by SDI to the credit note; null when it has not been sent to SDI

sdi_filenamestring | nullnullablerequired

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

amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

rows_countintegerrequired

Number of rows of the credit note (GET /api/v3/credit-notes/{credit_note_id}/rows)

date_createddate-timerequired

amount objectrequired

Amount in euros, without the VAT details of Amount

amountfloatrequired

Amount, in euros

currencystringrequired

Currency code: always EUR

date_createddate-timerequired

metarequired

Always null: only the paginated lists have a meta

Constant value: null

PrepaidCreditOperationResponse

{
  "error": 0,
  "message": "string",
  "data": {
    "operation_id": 0,
    "operation_id_related": 0,
    "prepaid_credit_topup": {
      "topup_id": 0,
      "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"
      },
      "initial_credit": {
        "amount": 0,
        "currency": "string"
      },
      "current_credit": {
        "amount": 0,
        "currency": "string"
      },
      "refund_expiry": "2024-07-29",
      "credit_expiry": "2024-07-29",
      "date_created": "2024-07-29T15:51:28.071Z"
    },
    "operation_type": {
      "type_code": "string",
      "type_description": "string"
    },
    "creditnote": {
      "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"
    },
    "amount": {
      "amount": 0,
      "currency": "string"
    },
    "date_created": "2024-07-29T15:51:28.071Z"
  }
}