PurchasePaginatedListResponse
Successful response with a page of Purchase
Always 0 in a successful response
0Always null in a successful response
data object[]required
Items of the page: an empty list beyond the last page
ID of purchase
account objectrequired
Account information of the user owner of the purchase. NULL if the purchase is not billed to a Reseller.
- Account
- null
Username assigned to the account when it is created, used to log in
Alternative username chosen for the account, also valid to log in; null when not set
Display name of the account: first name and surname of the administrative contact, or its organization, or the username; empty when the account has no administrative contact
First name of the administrative contact
Surname of the administrative contact
Phone of the administrative contact, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number
Province of the administrative contact: 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
service objectrequired
Service of the price list, with its category, recurrences, prices and purchase options
service_category objectrequired
Code of the category, for example PEC or CLOUD_STORAGE
Name of the category, in Italian
Code of the area that groups the category, for example HOSTING, DOMAIN or LICENSE
Name of the area, in Italian
Name of the service, in Italian
recurrence objectrequired
Billing recurrence: its frequency and, in days, the timings of renewal, suspension and dismission
frequency objectrequired
Frequency of a recurrence: a number of years, months or weeks, or a one-off charge
Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)
Number of units of the frequency, for example 12 with M; null with U
Days before the expiry from which the purchase can be renewed and the renewal order is created
Days before the expiry when the automatic renewal is attempted
Days after the expiry when a purchase not renewed is suspended; null if it is not suspended
Days after the expiry from which the restore price is charged in addition to the renewal price
Days after the expiry when a purchase not renewed is dismissed
Days after the start of the activation when a purchase never activated is cancelled automatically
Days after the expiry when a purchase whose renewal was not completed is dismissed automatically
Days before the expiry from which additional services can no longer be bought for the purchase
Days before the expiry from which the service of the purchase can no longer be changed
recurrences_available object[]required
Recurrences that can be chosen when buying the service (recurrence_id)
frequency objectrequired
Frequency of a recurrence: a number of years, months or weeks, or a one-off charge
Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)
Number of units of the frequency, for example 12 with M; null with U
Days before the expiry from which the purchase can be renewed and the renewal order is created
Days before the expiry when the automatic renewal is attempted
Days after the expiry when a purchase not renewed is suspended; null if it is not suspended
Days after the expiry from which the restore price is charged in addition to the renewal price
Days after the expiry when a purchase not renewed is dismissed
Days after the start of the activation when a purchase never activated is cancelled automatically
Days after the expiry when a purchase whose renewal was not completed is dismissed automatically
Days before the expiry from which additional services can no longer be bought for the purchase
Days before the expiry from which the service of the purchase can no longer be changed
Id of the TLD of a domain service (GET /api/v3/tlds/{tld_id}); null for the other services
Code of the service, for example CLOUD_STORAGE_100 or BOX_PEC
URL of the cart page of the service
activation_price objectrequired
Activation price of the price list; null for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
renew_price objectrequired
Renew price of the price list; null when the service has none and for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
restore_price objectrequired
Restore price of the price list; null when the service has none and for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
transfer_price objectrequired
Transfer price of the price list; null when the service has none and for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Whether the service can be sold as a primary service
Whether the service is an additional service of a primary one
Whether the service can be bought as an additional service together with its primary service (presale)
Whether the service can be bought as an additional service after the activation of its primary service (aftersale)
Whether the service can be added to the cart more than once; the quantity of one purchase is set by quantity_min and quantity_max
Minimum quantity of the service in one purchase
Maximum quantity of the service in one purchase; null when the quantity cannot be chosen
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
recurrence objectrequired
Billing recurrence: its frequency and, in days, the timings of renewal, suspension and dismission
frequency objectrequired
Frequency of a recurrence: a number of years, months or weeks, or a one-off charge
Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)
Number of units of the frequency, for example 12 with M; null with U
Days before the expiry from which the purchase can be renewed and the renewal order is created
Days before the expiry when the automatic renewal is attempted
Days after the expiry when a purchase not renewed is suspended; null if it is not suspended
Days after the expiry from which the restore price is charged in addition to the renewal price
Days after the expiry when a purchase not renewed is dismissed
Days after the start of the activation when a purchase never activated is cancelled automatically
Days after the expiry when a purchase whose renewal was not completed is dismissed automatically
Days before the expiry from which additional services can no longer be bought for the purchase
Days before the expiry from which the service of the purchase can no longer be changed
recurrence_default objectrequired
Billing recurrence: its frequency and, in days, the timings of renewal, suspension and dismission
frequency objectrequired
Frequency of a recurrence: a number of years, months or weeks, or a one-off charge
Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)
Number of units of the frequency, for example 12 with M; null with U
Days before the expiry from which the purchase can be renewed and the renewal order is created
Days before the expiry when the automatic renewal is attempted
Days after the expiry when a purchase not renewed is suspended; null if it is not suspended
Days after the expiry from which the restore price is charged in addition to the renewal price
Days after the expiry when a purchase not renewed is dismissed
Days after the start of the activation when a purchase never activated is cancelled automatically
Days after the expiry when a purchase whose renewal was not completed is dismissed automatically
Days before the expiry from which additional services can no longer be bought for the purchase
Days before the expiry from which the service of the purchase can no longer be changed
ID of primary purchase if this is an additional purchase.
purchase_status objectrequired
Status of the purchase.
Status code: NEW_V2 (just created), ACTIVE_V2 (active), DELIVERED_V2 (active without renewals), DISMISSED_V2 (at the end of its life), CANCELED_V2 (cancelled before the activation) or DELETED_V2 (deleted one-off purchase)
Name of the status, in Italian
purchase_provisioning_status objectrequired
Current provisioning status of purchase (changes during activation, renews, etc.).
Code of the operation in progress: SLEEPY (none), TO_ACTIVATE, TO_RENEW, TO_SUSPEND, TO_RESUME (reactivation), TO_DISMISS or TO_CANCEL
Name of the operation in progress, in Italian
purchase_name objectrequired
Name of the purchase.
Service name
Complete name (Service and object name)
Name of the purchase object (ie. domain name, server hostname, etc.)
Quantity (instances) purchased.
Current purchase quantity (instances).
activation_price objectrequired
Purchase price; null for sub-accounts.
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
renew_price objectrequired
Renew price (applied on recurring purchases only); null for sub-accounts.
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
restore_price objectrequired
Restore/reactivation price (applied on domains only); null for sub-accounts.
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Purchase date.
Date when the activation started.
Purchase expiration date (applied on recurring purchases only).
Purchase dismission date.
Tells if purchase has to be renewed.
Tells if purchase is currently suspended.
User comment (will be included in invoice description).
billing_data objectrequired
Italian public administration codes of a document row: CIG, CUP and ODA
CIG (Codice Identificativo Gara), the Italian code of the public tender; null when not given
CUP (Codice Unico di Progetto), the Italian code of the public investment project; null when not given
ODA (Ordine di Acquisto), the code of the purchase order; null when not given
tasks object[]required
Tasks currently running on the purchase.
Id of the purchase the task works on (GET /api/v3/purchases/{purchase_id})
task_status objectrequired
Status code: TO_EXECUTE (queued), MACHINE (running), WAIT (paused), HUMAN_INTERVENTION (checked by an operator), ASK_USER (waiting for data, POST /api/v3/tasks/{task_id}/data), DONE (completed) or FAIL (failed)
Name of the status for the customers, in Italian, as in the control panel (for example In verifica for HUMAN_INTERVENTION)
Number of the step reached by the task, out of total_instructions: equal to it when the task is done or failed
Total number of steps of the task
Whether the execution of the task has started
Error found in the data provided for the task, null when there is none: the corrected data are sent with POST /api/v3/tasks/{task_id}/data
Date and time the task was created
Collection of IDs of active additional purchases for this purchase.
ID of the domain associated with this purchase.
ID of the server associated with this purchase.
ID of the SSL certificate associated with this purchase.
ID of the PEC associated with this purchase.
ID of the PEC domain associated with this purchase.
ID of the web hosting associated with this purchase.
ID of the monitoring service associated with this purchase.
ID of the license associated with this purchase.
ID of the Microsoft 365 subscription associated with this purchase.
ID of the cloud storage associated with this purchase.
ID of the object storage associated with this purchase.
ID of the Veeam Backup as a Service associated with this purchase.
Datetime when the purchase was first created.
meta objectrequired
Pagination of the list
Number of items in the whole list
Number of items in this page: 0 beyond the last page
Number of pages of the list
Number of this page, starting from 1
Maximum number of items in a page
{
"error": 0,
"message": "string",
"data": [
{
"purchase_id": 0,
"account": {
"account_id": 0,
"username": "string",
"username_alias": "string",
"account_name": "string",
"name": "string",
"surname": "string",
"email": "string",
"phone": "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"
},
"date_created": "2024-07-29T15:51:28.071Z"
},
"service": {
"service_id": 0,
"service_category": {
"category_code": "string",
"category_name": "string",
"area_code": "string",
"area_name": "string"
},
"service_name": "string",
"recurrence": {
"recurrence_id": 0,
"frequency": {
"family": "string",
"value": 0
},
"days_renew": 0,
"days_autorenew": 0,
"days_suspension": 0,
"days_restore": 0,
"days_dismission": 0,
"days_cancel": 0,
"days_renew_dismission": 0,
"days_no_secondary": 0,
"days_no_service_change": 0
},
"recurrences_available": [
{
"recurrence_id": 0,
"frequency": {
"family": "string",
"value": 0
},
"days_renew": 0,
"days_autorenew": 0,
"days_suspension": 0,
"days_restore": 0,
"days_dismission": 0,
"days_cancel": 0,
"days_renew_dismission": 0,
"days_no_secondary": 0,
"days_no_service_change": 0
}
],
"tld_id": 0,
"service_code": "string",
"service_url": "string",
"activation_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"renew_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"restore_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"transfer_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"is_primary": true,
"is_secondary": true,
"is_presale": true,
"is_aftersale": true,
"is_quantifiable": true,
"quantity_min": 0,
"quantity_max": 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
},
"recurrence": {
"recurrence_id": 0,
"frequency": {
"family": "string",
"value": 0
},
"days_renew": 0,
"days_autorenew": 0,
"days_suspension": 0,
"days_restore": 0,
"days_dismission": 0,
"days_cancel": 0,
"days_renew_dismission": 0,
"days_no_secondary": 0,
"days_no_service_change": 0
},
"recurrence_default": {
"recurrence_id": 0,
"frequency": {
"family": "string",
"value": 0
},
"days_renew": 0,
"days_autorenew": 0,
"days_suspension": 0,
"days_restore": 0,
"days_dismission": 0,
"days_cancel": 0,
"days_renew_dismission": 0,
"days_no_secondary": 0,
"days_no_service_change": 0
},
"purchase_id_primary": 0,
"purchase_status": {
"status_code": "string",
"status_name": "string"
},
"purchase_provisioning_status": {
"status_code": "string",
"status_name": "string"
},
"purchase_name": {
"name": "string",
"full_name": "string",
"object_name": "string"
},
"activation_quantity": 0,
"quantity": 0,
"activation_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"renew_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"restore_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"date_activation": "2024-07-29",
"date_activation_start": "2024-07-29",
"date_expiry": "2024-07-29",
"date_dismission": "2024-07-29",
"do_not_renew": true,
"suspended": true,
"comment": "string",
"billing_data": {
"cig_value": "string",
"cup_value": "string",
"oda_value": "string"
},
"tasks": [
{
"task_id": 0,
"purchase_id": 0,
"task_status": {
"status_code": "string",
"status_name": "string"
},
"executed_instructions": 0,
"total_instructions": 0,
"is_started": true,
"ask_user_error": "string",
"date_started": "2024-07-29T15:51:28.071Z"
}
],
"purchase_additionals": [
0
],
"domain_id": 0,
"server_id": 0,
"ssl_certificate_id": 0,
"pec_id": 0,
"pec_domain_id": 0,
"hosting_id": 0,
"monitoring_id": 0,
"license_id": 0,
"microsoft365_id": 0,
"cloud_storage_id": 0,
"object_storage_id": 0,
"veeam_baas_id": 0,
"date_created": "2024-07-29T15:51:28.071Z"
}
],
"meta": {
"total": 0,
"count": 0,
"pages": 0,
"page": 0,
"per_page": 0
}
}