Calculate VAT endpoint

GET

calculate

curl --request GET \
  --url https://vat.cleariflow.com/v1/calculate/

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vat.cleariflow.com/v1/calculate/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://vat.cleariflow.com/v1/calculate/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://vat.cleariflow.com/v1/calculate/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
    "amount_excluding_vat": "175.00",
    "amount_including_vat": "208.25",
    "country": {
        "code": "DE",
        "name": "Germany"
    },
    "vat_amount": "33.25",
    "vat_category": "standard",
    "vat_rate": "0.190"
}

Getting started

Base URL

https://vat.cleariflow.com/v1/calculate/

Calculation endpoint

The calculate endpoint requires your unique API key, the country and the price you’d like to check:

https://vat.cleariflow.com/v1/calculate/
? api_key = YOUR_UNIQUE_API_KEY
& amount = 175  
& country_code = DE
& category = standard

This successful request returns comprehensive VAT calculation results including rates, amounts, and country information:

{
    "amount_excluding_vat": "175.00",
    "amount_including_vat": "208.25",
    "country": {
        "code": "DE",
        "name": "Germany"
    },
    "vat_amount": "33.25",
    "vat_category": "standard",
    "vat_rate": "0.190"
}

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.

Calculate VAT endpoint

curl --request GET \
  --url https://vat.cleariflow.com/v1/calculate/

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vat.cleariflow.com/v1/calculate/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://vat.cleariflow.com/v1/calculate/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://vat.cleariflow.com/v1/calculate/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
    "amount_excluding_vat": "175.00",
    "amount_including_vat": "208.25",
    "country": {
        "code": "DE",
        "name": "Germany"
    },
    "vat_amount": "33.25",
    "vat_category": "standard",
    "vat_rate": "0.190"
}

Verify

Lookup

Create

Getting started

Base URL

Calculation endpoint

Request parameters

Response parameters

​Getting started

​Base URL

​Calculation endpoint

​Request parameters

​Response parameters

Getting started

Base URL

Calculation endpoint

Request parameters

Response parameters