![\"Amazon](\"https://vatapi.com/assets/images/docs-aws-api-gateway-icon.png\"){kind=icon}
VAT API is proxied and protected by the Amazon API Gateway service.Welcome to the VAT API docs. These docs are hosted by the Postman service, you can select various languages to see the example requests and reponses in your preferred programming language. Where multiple responses can be generated by a particular resource you can select on the right hand side to see the different type of responses a resource might produce.
\nNote:- These docs are for the current Version 2 of the VAT API service, if you require the Version 1 docs they can viewed here
\nIf you are new to VAT API grab an API Key by creating a 30 day free trial account at vatapi.com
\n VAT API is proxied and protected by the Amazon API Gateway service.
We run the following endpoints:-
\nEnterprise Customers
\nFor Enterprise accounts with their own endpoint, please contact support for more information.
\nAuthenticate each api request by passing a valid x-api-key header value.
Your API Key can be found in the account dashboard:- https://vatapi.com/login make sure to store your API Key somewhere secure and never share publicly.
\nIf you're an existing Postman user you can quickly test VAT API functionality by clicking the 'Run in Postman' button in the top right corner of this page, this will prompt you to import VAT API as a Postman Collection...
\nThe VAT API collection expects two Postman variables to be set:
\nInformation on setting up and using Postman variables can be found here
\nIf you haven't used Postman before we highly recommend you install the software as it will save you time testing API functionality before embarking on writing any integration code.
\nTo prevent VAT API from being overwhelmed requests are rate limited. Sending to many requests may trigger responses with the HTTP status code 429. The limits are dynamic and we reserve the right to adjust them at any time to accomodate customer demand.
\n400 Bad Request
\n{\n \"code\": 400,\n \"message\": \"Please send a valid JSON payload in the body of the request.\"\n}\n(String | Required) TBE or GOODS.
Retrieve an EU member states current VAT rate by setting the country_code query parameter to an EU member states 2 digit ISO country code, or allow VAT API to geolocate the country from an ip_address value. IPV6 ip addresses are supported.
When geolocating by an ip address you will notice there is a geolocation_score value returned in the response. This is a measure of the accuracy of the geolocation process. An integer value from 0-100 represents a confidence value that the country is correct.
Setting the filter parameter to 'ebooks' or 'enewspapers' will return the specific VAT rate for the member state, or if those product types do not have a specific VAT rate the standard rates object will be returned. In addition the filter_match value in the response will be Boolean true or false to indicate if a match was found.
(String | Required) TBE or GOODS.
(String) 2 digit ISO member state country code.
\n","type":"text/plain"},"key":"country_code","value":"{{country_code}}"},{"description":{"content":"(String) IP address to geolocate.
\n","type":"text/plain"},"key":"ip_address","value":"{{ip_address}}"},{"description":{"content":"(String) Specify a filter value ebooks or enewspapers.
Validate UK & EU member state VAT numbers, this resource queries HMRC for UK VAT numbers and the VIES database ran by the European Commission for EU member state VAT numbers.
\nFor audit trail purposes you can optionally specify your own organisations VAT Number as a requester_vatid query parameter, this will return consultation_number and consultation_authority values. If you want to be able to prove to a Tax Administration of a Member State that you have checked a given VAT number at a given time, and obtained a given validation reply, please keep this consultation number in your archives.
Note:- Since the UK left the EU it is important to understand that UK VAT registered companies can only request a consultation number when validating other UK VAT numbers, conversely EU companies can only request consultation numbers for other EU VAT numbers. If you pass a requester_vatid value where not applicable you will receive an error status and the fault_string will read 'Invalid Requester Country - Only EU VAT-registered businesses can request a consultation number from VIES' or 'Invalid Requester Country - Only UK VAT-registered businesses can request a consultation number from HMRC'.
The validation response object
\"validation\": {\n \"status\": \"ok\",\n \"fault_string\": null,\n \"valid\": true,\n \"request_date\": \"2019-02-13+01:00\",\n \"consultation_number\": null,\n \"consultation_authority\": null,\n \"company_name\": \"AMAZON EUROPE CORE S.A R.L.\",\n \"company_address\": \"38, AVENUE JOHN F. KENNEDY\\nL-1855 LUXEMBOURG\"\n}\n(String | Required) Max 16 alpha numeric characters. Avoid spaces and other special characters. If you need to check if the VIES service is available without sending a VAT number set this value to 'GB100', this will return a validation > status value of 'ok' if the service is online.
(String) Max 16 alpha numeric characters. Avoid spaces and other special characters.
\n","type":"text/plain"},"key":"requester_vatid","value":"{{requester_vatid}}"}],"variable":[]}},"response":[{"id":"2addc318-77ec-4ced-9b78-46c8ee354f81","name":"VAT Number Validation - With Requester VAT Number","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://{{region}}.vatapi.com/v2/vat-number-check?vatid=LU26375245&requester_vatid=GB289111588","protocol":"https","host":["{{region}}","vatapi","com"],"path":["v2","vat-number-check"],"query":[{"key":"vatid","value":"LU26375245"},{"key":"requester_vatid","value":"GB289111588"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Feb 2019 21:20:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"287"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"3b5bc49d-2fd5-11e9-8362-3377e7df10e8"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"x-amz-apigw-id","value":"VDqHhHkErPEFkvQ="},{"key":"x-amzn-Remapped-Server","value":"London"},{"key":"X-Powered-By","value":"VAT API Version 2"},{"key":"x-amzn-Remapped-Date","value":"Wed, 13 Feb 2019 21:20:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"success\",\n \"country_code\": \"LU\",\n \"vat_number\": 26375245,\n \"requester_country_code\": \"GB\",\n \"requester_vat_number\": 289111588,\n \"validation\": {\n \"status\": \"ok\",\n \"fault_string\": null,\n \"valid\": true,\n \"request_date\": \"2019-02-13+01:00\",\n \"consultation_number\": \"WAPIAAAAWjou8x4M\",\n \"consultation_authority\": \"VIES\",\n \"company_name\": \"AMAZON EUROPE CORE S.A R.L.\",\n \"company_address\": \"38, AVENUE JOHN F. KENNEDY\\nL-1855 LUXEMBOURG\"\n }\n}"},{"id":"63e60372-f05e-46f8-9c5e-19becb8e8055","name":"VAT Number Validation","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://{{region}}.vatapi.com/v2/vat-number-check?vatid=LU26375245","protocol":"https","host":["{{region}}","vatapi","com"],"path":["v2","vat-number-check"],"query":[{"key":"vatid","value":"LU26375245"},{"key":"requester_vatid","value":"GB289111588","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Feb 2019 21:19:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"267"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1cd4fb0c-2fd5-11e9-bc02-97ad888aa20a"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"x-amz-apigw-id","value":"VDp_hHTLLPEFW9g="},{"key":"x-amzn-Remapped-Server","value":"London"},{"key":"X-Powered-By","value":"VAT API Version 2"},{"key":"x-amzn-Remapped-Date","value":"Wed, 13 Feb 2019 21:19:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"success\",\n \"country_code\": \"LU\",\n \"vat_number\": 26375245,\n \"requester_country_code\": null,\n \"requester_vat_number\": null,\n \"validation\": {\n \"status\": \"ok\",\n \"fault_string\": null,\n \"valid\": true,\n \"request_date\": \"2019-02-13+01:00\",\n \"consultation_number\": null,\n \"consultation_authority\": \"VIES\",\n \"company_name\": \"AMAZON EUROPE CORE S.A R.L.\",\n \"company_address\": \"38, AVENUE JOHN F. KENNEDY\\nL-1855 LUXEMBOURG\"\n }\n}"}],"_postman_id":"8c4e380c-6271-4e4c-bc3e-3059f6eb3ea1"},{"name":"VAT Price","id":"22d8ea61-5f41-4e22-91c5-c6dcb377e575","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"{{x-api-key}}"}],"url":"https://{{region}}.vatapi.com/v2/vat-price?country_code={{country_code}}&price={{price}}&rate_type={{rate_type}}&rate_category={{rate_category}}&rate_level={{rate_level}}&vat_charging_method={{vat_charging_method}}","description":"The VAT Price resource is a great time saver for shopping cart applications, simply pass in the country code of the customer, the price of the product/service they are purchasing, and the VAT Price resource will calculate the relevant VAT totals.
\n","urlObject":{"protocol":"https","path":["v2","vat-price"],"host":["{{region}}","vatapi","com"],"query":[{"description":{"content":"(String | Required) 2 digit ISO member state country code.
\n","type":"text/plain"},"key":"country_code","value":"{{country_code}}"},{"description":{"content":"(Float | Required) The price of the product or service.
\n","type":"text/plain"},"key":"price","value":"{{price}}"},{"description":{"content":"(String | Required) TBE or GOODS.
(String) Only applicable to TBE rates, specify the category for example; telecoms, broadcasting or electronic.
(String) Specify a rate level for example; standard, reduced_1, reduced_2, super_reduced or parking, defaults to standard.
(String) Is the 'price' value exclusive or inclusive of VAT? defaults to exclusive.
VAT Rate Data
\nIf your organisation is selling Telecommunications, Broadcasting or Electronic Services (TBE) specifying a rate_type query parameter of 'TBE' will return the current VAT rates in effect for that product type.
If your organisation is shipping physical goods specifying a rate_type query parameter of 'GOODS' will return the current VAT rates in effect for that product type.
Before creating a new invoice you must first create a new invoice setting. An identifier value is returned upon successful creation which you must then pass in with each invoice request.
Specify an identifier value in the URI to retreive an invoice setting.
Specify an identifier value in the URI to update an invoice setting.
Also refer to the attributes section in the Create Invoice Setting to update an attribute simply pass in any value you wish to update, for example if you only wanted to change the sin Sequential Invoice Number you'd pass just that name/value pair in.
Specify an identifier value in the URI to delete an invoice setting.
Invoice settings hold the core data related to the invoices issuing organisation.
\nThis useful feature allows a company to create invoices for multiple trading names they may operate.
\n","event":[{"listen":"prerequest","script":{"id":"1c5defab-2d1b-4809-8e85-7689064f1b11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7be7482f-d768-49a4-8902-37261daebe1e","type":"text/javascript","exec":[""]}}],"_postman_id":"276cea60-1942-4f8e-9bcf-79115c02922e"},{"name":"Line Items","item":[{"name":"Create Line Items","id":"75a4585c-f5f0-433c-a806-018b66fe95d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"line_items\": [\n\t\t{\n\t\t\t\"sku\": \"PROD3\",\n\t\t\t\"description\": \"Product 3\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"price_each\": 10.00,\n\t\t\t\"vat_rate\": 20\n\t\t},\n\t\t{\n\t\t\t\"sku\": \"PROD4\",\n\t\t\t\"description\": \"Product 4\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"price_each\": 20.00,\n\t\t\t\"vat_rate\": 20\n\t\t}\n\t]\n}"},"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}/line-items","description":"Add new line items to an existing invoice. Pass the invoice_id in the URI to add new items to that invoice.
Note:- An invoice cannot contain more than 100 line items. This is a soft limit, contact support if you need this limit upping.
\nline_items Array
An array of line items being invoiced for.
\n","urlObject":{"protocol":"https","path":["v2","invoice","{{invoice_id}}","line-items"],"host":["{{region}}","vatapi","com"],"query":[],"variable":[]}},"response":[{"id":"f41dee1f-69cd-4f3c-a80e-574b0c4938c9","name":"Create Line Items","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"line_items\": [\n\t\t{\n\t\t\t\"sku\": \"PROD3\",\n\t\t\t\"description\": \"Product 3\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"price_each\": 10.00,\n\t\t\t\"vat_rate\": 20\n\t\t},\n\t\t{\n\t\t\t\"sku\": \"PROD4\",\n\t\t\t\"description\": \"Product 4\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"price_each\": 20.00,\n\t\t\t\"vat_rate\": 20\n\t\t}\n\t]\n}"},"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}/line-items"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Feb 2019 18:41:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"284"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"197f40a7-2bd1-11e9-92c5-73a80bdf4bb7"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"x-amz-apigw-id","value":"Uy0CvGs7LPEFlag="},{"key":"x-amzn-Remapped-Server","value":"London"},{"key":"X-Powered-By","value":"VAT API Version 2"},{"key":"x-amzn-Remapped-Date","value":"Fri, 08 Feb 2019 18:41:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 201,\n \"message\": \"success\",\n \"line_items\": [\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD1\",\n \"description\": \"Product 1\",\n \"quantity\": 1,\n \"price_each\": 10,\n \"discount_rate\": 10,\n \"vat_rate\": 20,\n \"line_total\": 9\n },\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD2\",\n \"description\": \"Product 2\",\n \"quantity\": 2,\n \"price_each\": 20,\n \"discount_rate\": 10,\n \"vat_rate\": 20,\n \"line_total\": 36\n },\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD3\",\n \"description\": \"Product 3\",\n \"quantity\": 1,\n \"price_each\": 10,\n \"discount_rate\": null,\n \"vat_rate\": 20,\n \"line_total\": 10\n },\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD4\",\n \"description\": \"Product 4\",\n \"quantity\": 1,\n \"price_each\": 20,\n \"discount_rate\": null,\n \"vat_rate\": 20,\n \"line_total\": 20\n }\n ]\n}"}],"_postman_id":"75a4585c-f5f0-433c-a806-018b66fe95d5"},{"name":"Update Line Item","id":"9cffe5a3-8124-4cc6-84d7-90a33f1c70e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"quantity\": 2\n}"},"url":"https://{{region}}.vatapi.com/v2/invoice/c4ca4238a0/line-items/c74d97b01e","description":"Pass the invoice_id and line item id in the URI to update line item data.
Pass the invoice_id and line item id in the URI to delete line item data.
Note:- you cannot delete the only line item of an invoice.
\n","urlObject":{"protocol":"https","path":["v2","invoice","{{invoice_id}}","line-items","{{id}}"],"host":["{{region}}","vatapi","com"],"query":[],"variable":[]}},"response":[{"id":"c5aeb2f4-f053-40f0-90c5-7d01bc20b3e0","name":"Delete Line Item","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"{{x-api-key}}"}],"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}/line-items/{{id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"code\": 200,\n\t\"message\" \"success\"\n}"}],"_postman_id":"c69cf7fa-1114-4831-b6c6-703ad7b0bbb3"}],"id":"21a494a2-e6af-464e-96ef-6df027818ce8","description":"Line item resources only apply if you have already created an invoice and have an invoice_id you wish to modify.
To create a new invoice post your invoice data as json in the body of the request, VAT API will work out the totals based on the line items you provide. Use the response data to render your own VAT compliant invoices or simply reference the vanity invoice_url value we provide in the response.
local_currency Object
This applies to UK companies doing international trade but may also apply to other EU countries. For example, if the supply takes place in the UK and the sale is made in a foreign currency it is a requirement to show the Sterling total VAT payable on the VAT invoice.
\nReference link:- https://www.gov.uk/vat-record-keeping/vat-invoices refer to the section 'International trade' toward the bottom of the page.
\ncustomer Object
In this object you can specify the details of your customer.
\nline_items Array
An array of line items being invoiced for.
\nNote:- An invoice can contain a max of 100 line items.
\n","urlObject":{"protocol":"https","path":["v2","invoice"],"host":["{{region}}","vatapi","com"],"query":[],"variable":[]}},"response":[{"id":"d0b79397-6441-465f-bd60-c61f1cb31416","name":"Create an Invoice","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"settings_identifier\": \"{{identifier}}\",\n \"invoice_number_prefix\": \"VA-\",\n \"issue_date\": \"2019-01-17 11:00:00\",\n \"tax_point\": \"2019-01-17 11:00:00\",\n \"type\": \"sale\",\n \"currency\": \"EUR\",\n \"local_currency\": {\n\t\"to\": \"GBP\",\n\t\"rate\":\t0.88\n },\n \"order_discount_method\": \"percentage\",\n \"order_discount_amount\": 10.00,\n \"vat_charging_method\": \"inclusive\",\n \"zero_rated\": true,\n \"customer\": {\n\t\"name\": \"Amazon Europe Core SARL\",\n\t\"address\": \"Société à responsabilité limitée, 38 avenue John F. Kennedy, L-1855 Luxembourg\",\n\t\"vat_number\": \"LU26375245\"\n },\n \"line_items\": [\n {\n \"sku\": \"PROD1\",\n \"description\": \"Product 1\",\n \"quantity\": 1,\n \"price_each\": 10.00,\n \"discount\": 10.00,\n \"vat_rate\": 20\n },\n {\n \"sku\": \"PROD2\",\n \"description\": \"Product 2\",\n \"quantity\": 2,\n \"price_each\": 20.00,\n \"discount\": 10.00,\n \"vat_rate\": 20\n }\n ],\n \"notes\": null\n}"},"url":"https://{{region}}.vatapi.com/v2/invoice"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Jan 2019 11:33:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"633"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a8808e9e-23b9-11e9-8369-6b548fc9f544"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"x-amz-apigw-id","value":"UQ3-qHYzrPEFfZA="},{"key":"x-amzn-Remapped-Server","value":"London"},{"key":"Location","value":"https://vatinvoice.app/c9f0f895fb"},{"key":"X-Powered-By","value":"VAT API Version 2"},{"key":"x-amzn-Remapped-Date","value":"Tue, 29 Jan 2019 11:33:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"message\": \"success\",\n \"invoice_id\": \"{{invoice_id}}\",\n \"invoice_number\": \"VA-81\",\n \"invoice_url\": \"https://vatinvoice.co.uk/c9f0f895fb\",\n \"created\": \"2019-01-29 11:33:11\",\n \"updated\": \"2019-01-29 11:33:11\",\n \"issue_date\": \"2019-01-17 11:00:00\",\n \"tax_point\": \"2019-01-17 11:00:00\",\n \"type\": \"sale\",\n \"currency\": \"EUR\",\n \"local_currency\": {\n \"to\": \"GBP\",\n \"rate\": 0.88\n },\n \"order_discount_method\": \"percentage\",\n\t\"order_discount_amount\": 10.00,\n \"zero_rated\": true,\n \"business\": {\n \"trading_name\": \"VAT API\",\n \"trading_address\": \"International House, 24 Holborn Viaduct, City of London, EC1A 2BN\",\n \"vat_number\": \"GB289111588\",\n \"logo\": \"https://vatapi.com/images/logo-invoice.jpg\"\n },\n \"customer\": {\n \"name\": \"Amazon Europe Core SARL\",\n \"address\": \"Société à responsabilité limitée, 38 avenue John F. Kennedy, L-1855 Luxembourg\",\n \"vat_number\": \"LU26375245\"\n },\n \"line_items\": [\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD1\",\n \"description\": \"Product 1\",\n \"quantity\": 1,\n \"price_each\": 10,\n \"discount\": 10,\n \"vat_rate\": 20,\n \"line_total\": 9\n },\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD2\",\n \"description\": \"Product 2\",\n \"quantity\": 2,\n \"price_each\": 20,\n \"discount\": 10,\n \"vat_rate\": 20,\n \"line_total\": 36\n }\n ],\n \"totals\": {\n \"line_items_discount\": 5,\n \"subtotal\": 45,\n \"discount\": 4.5,\n \"vat\": 0,\n \"vat_local\": 0,\n \"total\": 40.5\n },\n \"notes\": null\n}"}],"_postman_id":"a9c20d22-0b01-4e10-80df-7a94dc56a84e"},{"name":"Retrieve Invoice","id":"142bb3ea-0824-43d2-876a-8690dae39df8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}","description":"Specify an invoice_id value in the URI to retreive an invoice.
This resource allows you to retrieve and filter all the invoices for a particular settings_identifier value allowing you to paginate results.
(String | Required)
\n","type":"text/plain"},"key":"settings_identifier","value":"{{settings_identifier}}"},{"description":{"content":"(Integer) Limit how many results to retrieve. Defaults to 10. Max 100.
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"(Integer) Set an offset value to allow pagination of results. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"},{"description":{"content":"(String) Specify an invoice type ie; 'sale' or 'refund'. Defaults to null.
\n","type":"text/plain"},"key":"type","value":"{{type}}"},{"description":{"content":"(String) Filter by a customer name. Defaults to null.
\n","type":"text/plain"},"key":"customer_name","value":"{{customer_name}}"},{"description":{"content":"(String) Order the results by the invoices 'created', 'updated', issue_date' or 'tax_point' dates. Defaults to null.
\n","type":"text/plain"},"key":"order_by","value":"{{order_by}}"},{"description":{"content":"(String) Sort the results by DESC or ASC. Defaults to null.
\n","type":"text/plain"},"key":"sort","value":"{{sort}}"}],"variable":[]}},"response":[{"id":"d07f843d-0e43-490a-9675-b33d7f840afb","name":"Paginate Invoices","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"{{x-api-key}}"}],"url":{"raw":"https://{{region}}.vatapi.com/v2/invoice/paginate?settings_identifier={{settings_identifier}}","protocol":"https","host":["{{region}}","vatapi","com"],"path":["v2","invoice","paginate"],"query":[{"key":"settings_identifier","value":"{{settings_identifier}}","description":"(String)"},{"key":"limit","value":"","description":"(Integer) Limit how many results to retrieve. Defaults to 10. Max 100.","disabled":true},{"key":"offset","value":"","description":"(Integer) Set an offset value to allow pagination of results. Defaults to 0.","disabled":true},{"key":"type","value":"","description":"(String) Specify an invoice type ie; 'sale' or 'refund'. Defaults to null.","disabled":true},{"description":"(String) Filter by a customer name. Defaults to null.","key":"customer_name","value":"","disabled":true},{"key":"order_by","value":"","description":"(String) Order the results by the invoices 'created', 'updated', issue_date' or 'tax_point' dates. Defaults to null.","disabled":true},{"key":"sort","value":"","description":"(String) Sort the results by DESC or ASC. Defaults to null.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Feb 2019 12:55:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1146"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ad225348-2f8e-11e9-b918-81a1238b761d"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"x-amz-apigw-id","value":"VCgIoG30LPEFWug="},{"key":"x-amzn-Remapped-Server","value":"London"},{"key":"X-Powered-By","value":"VAT API Version 2"},{"key":"x-amzn-Remapped-Date","value":"Wed, 13 Feb 2019 12:55:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"success\",\n \"results\": 3,\n \"invoices\": [\n {\n \"invoice_id\": \"{{invoice_id}}\",\n \"invoice_number\": \"VA-3\",\n \"invoice_url\": \"https://vatinvoice.co.uk/eccbc87e4b\",\n \"created\": \"2019-02-13 12:27:01\",\n \"updated\": \"2019-02-13 12:27:01\",\n \"issue_date\": \"2019-01-17 11:00:00\",\n \"tax_point\": \"2019-01-17 11:00:00\",\n \"type\": \"sale\",\n \"currency\": \"EUR\",\n \"local_currency\": {\n \"to\": \"GBP\",\n \"rate\": 0.88\n },\n \"zero_rated\": true,\n \"business\": {\n \"trading_name\": \"Demo Commerce\",\n \"trading_address\": \"Demo Street, London, WA1 7GT\",\n \"vat_number\": \"GB154636784\",\n \"logo\": \"https://democommerce.com/logo.png\"\n },\n \"customer\": {\n \"name\": \"Amazon Europe Core SARL\",\n \"address\": \"Société à responsabilité limitée, 38 avenue John F. Kennedy, L-1855 Luxembourg\",\n \"vat_number\": \"LU26375245\"\n },\n \"line_items\": [\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD1\",\n \"description\": \"Product 1\",\n \"quantity\": 1,\n \"price_each\": 8.55,\n \"discount_rate\": 10,\n \"vat_rate\": 0,\n \"line_total\": 7.7\n },\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD2\",\n \"description\": \"Product 2\",\n \"quantity\": 2,\n \"price_each\": 17.09,\n \"discount_rate\": 10,\n \"vat_rate\": 0,\n \"line_total\": 30.77\n }\n ],\n \"totals\": {\n \"discount\": 4.27,\n \"subtotal\": 38.47,\n \"vat\": 0,\n \"vat_local\": 0,\n \"total\": 38.47\n },\n \"notes\": null\n },\n {...\n ]\n}"}],"_postman_id":"073dbd82-a33e-463e-8068-75d724116831"},{"name":"Update Invoice","id":"7ed94125-2282-4bbe-b013-940c5cbd207a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"{{x-api-key}}"}],"body":{"mode":"raw","raw":"{\n\t\"line_items\": [\n\t\t{\n\t\t\t\"id\": \"{{1}}\",\n\t\t\t\"quantity\": 1\n\t\t}\t\n\t]\n}"},"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}","description":"Specify an invoice_id value in the URI to update an invoice.
You can update any of the attributes below.
\nlocal_currency Object
This applies to UK companies doing international trade but may also apply to other EU countries. For example, if the supply takes place in the UK and the sale is made in a foreign currency it is a requirement to show the Sterling total VAT payable on the VAT invoice.
\nReference link:- https://www.gov.uk/vat-record-keeping/vat-invoices refer to the section 'International trade' toward the bottom of the page.
\ncustomer Object
In this object you can specify the details of your customer.
\nline_items Array
An array of line items being invoiced for.
\nNote:- An invoice can contain a max of 100 line items. This is a soft limit, contact support if you need this limit upping.
\n","urlObject":{"protocol":"https","path":["v2","invoice","{{invoice_id}}"],"host":["{{region}}","vatapi","com"],"query":[],"variable":[]}},"response":[{"id":"f7a0672f-a3b3-4660-8806-227d278e4317","name":"Update Invoice","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"{{x-api-key}}"}],"body":{"mode":"raw","raw":"{\n\t\"line_items\": [\n\t\t{\n\t\t\t\"id\": \"{{1}}\",\n\t\t\t\"quantity\": 1\n\t\t}\t\n\t]\n}"},"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Feb 2019 15:38:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"779"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"620f25ea-2fa5-11e9-a0be-0f4726b7ea89"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amzn-Remapped-Connection","value":"Keep-Alive"},{"key":"x-amz-apigw-id","value":"VC38cENkrPEFeIQ="},{"key":"x-amzn-Remapped-Server","value":"London"},{"key":"X-Powered-By","value":"VAT API Version 2"},{"key":"x-amzn-Remapped-Date","value":"Wed, 13 Feb 2019 15:38:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"success\",\n \"invoice_id\": \"{{invoice_id}}\",\n \"invoice_number\": \"VA-3\",\n \"invoice_url\": \"https://vatinvoice.co.uk/eccbc87e4b\",\n \"created\": \"2019-02-13 12:27:01\",\n \"updated\": \"2019-02-13 15:38:17\",\n \"issue_date\": \"2019-01-17 11:00:00\",\n \"tax_point\": \"2019-01-17 11:00:00\",\n \"type\": \"sale\",\n \"currency\": \"EUR\",\n \"local_currency\": {\n \"to\": \"GBP\",\n \"rate\": 0.88\n },\n \"order_discount_method\": \"fixed\",\n \"order_discount_amount\": 2,\n \"vat_charging_method\": \"inclusive\",\n \"zero_rated\": true,\n \"business\": {\n \"trading_name\": \"Demo Commerce\",\n \"trading_address\": \"Demo Street, London, WA1 7GT\",\n \"vat_number\": \"GB154636784\",\n \"logo\": \"https://democommerce.com/logo.png\"\n },\n \"customer\": {\n \"name\": \"Test\",\n \"address\": \"Société à responsabilité limitée, 38 avenue John F. Kennedy, L-1855 Luxembourg\",\n \"vat_number\": \"LU26375245\"\n },\n \"line_items\": [\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD1\",\n \"description\": \"Product 1\",\n \"quantity\": 1,\n \"price_each\": 8.55,\n \"discount\": 10,\n \"vat_rate\": 0,\n \"line_total\": 7.69\n },\n {\n \"id\": \"{{id}}\",\n \"sku\": \"PROD2\",\n \"description\": \"Product 2\",\n \"quantity\": 1,\n \"price_each\": 17.09,\n \"discount\": 10,\n \"vat_rate\": 0,\n \"line_total\": 15.38\n }\n ],\n \"totals\": {\n \t\"line_items_discount\": 2.57,\n \"subtotal\": 23.07,\n \"discount\": 2,\n \"vat\": 0,\n \"vat_local\": 0,\n \"total\": 23.07\n },\n \"notes\": null\n}"}],"_postman_id":"7ed94125-2282-4bbe-b013-940c5cbd207a"},{"name":"Delete Invoice","id":"9d0b47fb-851a-446b-bba4-c351e86e4617","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"https://{{region}}.vatapi.com/v2/invoice/{{invoice_id}}","description":"Specify an invoice_id value in the URI to delete an invoice.
Specify the query parameter currency_code as GBP to retrieve the current exchange rates, updated monthly by the UK tax authority HMRC.
Specify the query parameter currency_code as EUR to retrieve the current exchange rates, updated daily by the European Central Bank.
(String| Required) GBP or EUR
This resource is useful if you invoice customers in a different currency to your own countries, for example in the UK when billing in an international currency the VAT amount must also be specified in GBP.
\n","urlObject":{"protocol":"https","path":["v2","currency-conversion"],"host":["{{region}}","vatapi","com"],"query":[{"description":{"content":"(String | Required) Any valid 3 character ISO 4217 currency code that is published in the relevant Conversion Rates reource above.
\n","type":"text/plain"},"key":"currency_from","value":"{{currency_from}}"},{"description":{"content":"(String| Required) GBP or EUR
(Integer | Required) The currency_from amount to convert.
Validate UK & EU member state EORI numbers, this resource queries HMRC for UK EORI numbers and the EORI database ran by the European Commission for EU member state EORI numbers.
\nThe validation response object
\"validation\": {\n \"authority\": \"European Commission\",\n \"status\": \"ok\",\n \"fault_string\": null,\n \"valid\": true,\n \"request_date\": \"22/04/2022\",\n \"name\": null,\n \"street\": null,\n \"postal_code\": null,\n \"city\": null,\n \"country\": null\n}\n