The quote object combines the best of the rate object and validation object and takes them a step further. It uses your existing business information to perform the entire VAT-compliant business logic for you. All VAT rules have been centralized so that every response is directly actionable.
Our core resources for rates and validations are “cold” fetches because they are provided as is and you still have to research tax regulations that specifically apply to each sale. We consider responses from the quotes endpoints as “warm” fetches because they are dynamically adapted to the circumstances between your business and your customer.
For example, if your business is situated in Italy and your customer is also in Italy, the quoted price will always include a VAT because VAT is always charged when transactions occur within the same EU member state (even for business customers). The reverse-charge mechanism does not apply here. This is a tax rule that you would have had to implement yourself, but is now taken care of.
The ideal way to use the quote object is to generate a new one whenever your visitor loads the checkout window in your frontend application. When your visitor does check out, you can pass the object’s unique identifier to your backend application for retrieval. You should therefore cache the object’s ID in your frontend application.
This interchanging of data allows you to charge the exact same amount that your visitor has been presented with earlier. You don’t have to replicate the same business logic in the frontend and the backend anymore.
If you generate quote objects from your frontend application, you should perform logical tests of the object’s content before you proceed with the actual charge to prevent abuse. For example, compare the object’s amount with your product’s price. If a visitor gets hold of your API access key, she can create new quote objects herself.
Key | | Description |
| | Unique identifier for the object. |
| | Abbreviation of |
| | Amount in cents, as given in your request. |
| | Total amount to be charged in consideration of the |
| | Category of the digital product. Defaults to |
| | 2-letter ISO country code. Note that while Greek VAT IDs contain the |
| | Corresponding English name of |
| | ISO date at which the object was created. |
| | The same IP address coming from the |
| | Localized name of the VAT. |
| | Boolean indicating whether the country is an EU member state. |
|
| VAT amount in cents. |
|
| Specifies if the given |
|
| VAT rate applied for the calculation. If |
|
| Automatically determined type of VAT rate based on inputs. Can be |
| | ISO date at which the object was updated. |
| | Populated validation object if an ID is attached. You can attach a validation object either with the |
false
.valid
value can affect vat.amount
, vat.rate
and amount_total
when zero-rating.country_code
is provided, it will be automatically determined from the request.ip_address
parameter will be ignored.audiobook
,ebook
and periodical
.{"id": "5dc490ea73c1ce2f69628900","abbreviation": "ALV nro","amount": 10000,"amount_total": 10000,"category": null,"country_code": "IE","country_name": "Ireland","ip_address": "92.251.255.11","local_name": "Arvonlisäveronumero","member_state": true,"validation": {"id": "5dc490ea73c1ce2f69628901","company_address": "3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4","company_name": "GOOGLE IRELAND LIMITED","consultation_number": "WAPIAAAAW5H1hUQb","country_code": "IE","query": "IE6388047V","type": "eu_vat","valid": true,"valid_format": true,"vat_number": "6388047V","requested": "2019-11-07T00:00:00.000Z","created": "2019-11-07T21:47:22.952Z","updated": "2019-11-07T21:47:22.952Z"},"vat": {"amount": 0,"inclusive": false,"rate": 0,"rate_type": "reverse_charge"},"created": "2019-11-07T21:47:22.955Z","updated": "2019-11-07T21:47:22.955Z"}
{"has_more": true,"quotes_count": 23,"quotes": [{"id": "5dc490ea73c1ce2f69628900","abbreviation": "ALV nro","amount": 10000,"amount_total": 10000,"category": null,"country_code": "IE","country_name": "Ireland","ip_address": "92.251.255.11","local_name": "Arvonlisäveronumero","member_state": true,"validation": {"id": "5dc490ea73c1ce2f69628901","company_address": "3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4","company_name": "GOOGLE IRELAND LIMITED","consultation_number": "WAPIAAAAW5H1hUQb","country_code": "IE","query": "IE6388047V","type": "eu_vat","valid": true,"valid_format": true,"vat_number": "6388047V","requested": "2019-11-07T00:00:00.000Z","created": "2019-11-07T21:47:22.952Z","updated": "2019-11-07T21:47:22.952Z"},"vat": {"amount": 0,"inclusive": false,"rate": 0,"rate_type": "reverse_charge"},"created": "2019-11-07T21:47:22.955Z","updated": "2019-11-07T21:47:22.955Z"},...]}
{"id": "5dc490ea73c1ce2f69628900","abbreviation": "ALV nro","amount": 10000,"amount_total": 10000,"category": null,"country_code": "IE","country_name": "Ireland","ip_address": "92.251.255.11","local_name": "Arvonlisäveronumero","member_state": true,"validation": {"id": "5dc490ea73c1ce2f69628901","company_address": "3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4","company_name": "GOOGLE IRELAND LIMITED","consultation_number": "WAPIAAAAW5H1hUQb","country_code": "IE","query": "IE6388047V","type": "eu_vat","valid": true,"valid_format": true,"vat_number": "6388047V","requested": "2019-11-07T00:00:00.000Z","created": "2019-11-07T21:47:22.952Z","updated": "2019-11-07T21:47:22.952Z"},"vat": {"amount": 0,"inclusive": false,"rate": 0,"rate_type": "reverse_charge"},"created": "2019-11-07T21:47:22.955Z","updated": "2019-11-07T21:47:22.955Z"}