Ендпоінт розрахунку VAT

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"
}

Початок роботи

Базовий URL

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

Ендпоінт розрахунку

Ендпоінт calculate потребує вашого унікального API-ключа, країни та ціни, яку потрібно перевірити:

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

Цей успішний запит повертає повні результати розрахунку VAT, включаючи ставки, суми та інформацію про країну:

{
    "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"
}

Параметри запиту

String

обов'язково

Ваш унікальний API-ключ. Зверніть увагу: у кожного користувача є унікальні API-ключі для кожного API Cleariflow, тому ключ API перевірки VAT не працюватиме для API геолокації IP, наприклад.

String

обов'язково

Сума, для якої потрібно розрахувати VAT або з якої його виділити.

String

обов'язково

Дволітерний ISO 3166-1 alpha-2 код країни, в якій відбувається транзакція.

String

обов'язково

Категорія VAT для розрахунку. Використовуйте «standard» для стандартної ставки VAT або конкретні категорії, як-от «e-books», «audiobooks» тощо, для знижених ставок.

Boolean

Якщо сума вже містить VAT і потрібно виконати зворотний розрахунок, розділивши суму та VAT, встановіть цей параметр у true. Якщо параметр явно не вказано, за замовчуванням буде false.

Параметри відповіді

Відповідь API повертається у універсальному та легкому форматі JSON.

String

Сума без VAT.

String

Сума базової величини та VAT, тобто amount_excluding_vat + vat_amount.

String

Розрахована сума VAT.

String

Категорія покупки, що використовується для визначення права на знижену ставку. Див. нижче список підтримуваних категорій.

String

Ставка VAT у вигляді десяткового рядка (наприклад, «0.190» для 19%).

Object

Об’єкт із інформацією про країну.

String

Дволітерний ISO 3166-1 alpha-2 код країни, в якій відбувається транзакція.

String

Назва країни, для якої розраховується VAT.

Ендпоінт розрахунку VAT

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"
}

Валідація

Пошук

Створення

Ендпоінт розрахунку VAT

Початок роботи

Базовий URL

Ендпоінт розрахунку

Параметри запиту

Параметри відповіді

​Початок роботи

​Базовий URL

​Ендпоінт розрахунку

​Параметри запиту

​Параметри відповіді

Початок роботи

Базовий URL

Ендпоінт розрахунку

Параметри запиту

Параметри відповіді