Skip to main content
GET
Calculate VAT

Getting started

Base URL

Calculation endpoint

The calculate endpoint requires your unique API key, the country and the price you’d like to check:
This successful request returns comprehensive VAT calculation results including rates, amounts, and country information:

Request parameters

String
required
Your unique API key. Note that each user has unique API keys for each of Cleariflow APIs, so your VAT Validation API key will not work for as your IP Geolocation API, for example.
String
required
The amount that you would like to get the VAT amount for or from.
String
required
The two letter ISO 3166-1 alpha-2 code of the country in which the transaction takes place.
String
required
The VAT category to use for calculation. Use “standard” for standard VAT rate, or specific categories like “e-books”, “audiobooks”, etc. for reduced rates.
Boolean
If the amount already has VAT added and you’d like to do the reverse calculation and split out the amount and VAT, set this parameter to true. If this parameter is not explicitly included it will default to false.

Response parameters

The API response is returned in a universal and lightweight JSON format.
String
The amount excluding the VAT.
String
The sum of the base amount and the VAT, i.e., amount_excluding_vat + vat_amount.
String
The calculated amount of VAT.
String
The category of the purchase, used to determine whether it qualifies for a reduced rate. See below for a list of supported categories.
String
The VAT rate as a decimal string (e.g., “0.190” for 19%).
Object
Object containing country information.
String
The two letter ISO 3166-1 alpha-2 code of the country in which the transaction takes place.
String
The name of the country the VAT is being calculated from.

Query Parameters

api_key
string
required

Your unique API key

country_code
string
required

Two-letter ISO 3166-1 alpha-2 country code

Required string length: 2
amount
string
required

The amount to calculate VAT for

Pattern: ^\d+(\.\d{1,2})?$
category
string
required

VAT category (e.g., standard, books, foodstuffs)

is_vat_incl
boolean
default:false

Whether the amount already includes VAT

Response

Successful calculation

amount_excluding_vat
string

Amount excluding VAT

amount_including_vat
string

Amount including VAT

vat_amount
string

VAT amount

vat_category
string

VAT category used

vat_rate
string

VAT rate as decimal string

country
object