Перейти к основному содержанию
GET
/
v1
/
calculate
Эндпоинт расчёта VAT
curl --request GET \
  --url https://vat.cleariflow.com/v1/calculate/
{
    "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"
}

​
Параметры запроса

​
api_key
String
обязательно
Ваш уникальный API-ключ. У каждого пользователя уникальные ключи для каждого API Cleariflow, поэтому ключ API проверки VAT не будет работать, например, с API геолокации IP.
​
amount
String
обязательно
Сумма, для которой нужно получить или рассчитать VAT.
​
country_code
String
обязательно
Двухбуквенный ISO 3166-1 alpha-2 код страны, в которой совершается транзакция.
​
category
String
обязательно
Категория VAT для расчёта. Используйте «standard» для стандартной ставки или конкретные категории вроде «e-books», «audiobooks» и т.д. для пониженных ставок.
​
is_vat_incl
Boolean
Если сумма уже включает VAT и нужен обратный расчёт с разделением суммы и VAT, установите true. Если параметр не указан явно, по умолчанию false.

​
Параметры ответа

Ответ API возвращается в универсальном лёгком формате JSON.
​
amount_excluding_vat
String
Сумма без VAT.
​
amount_including_vat
String
Сумма базовой суммы и VAT, т.е. amount_excluding_vat + vat_amount.
​
vat_amount
String
Рассчитанная сумма VAT.
​
vat_category
String
Категория покупки, определяющая право на пониженную ставку. См. список поддерживаемых категорий ниже.
​
vat_rate
String
Ставка VAT в виде десятичной строки (например, «0.190» для 19%).
​
country
Object
Объект с информацией о стране.
​
country.code
String
Двухбуквенный ISO 3166-1 alpha-2 код страны, в которой совершается транзакция.
​
country.name
String
Название страны, для которой рассчитывается VAT.