Перейти до основного вмісту
GET
Ендпоінт розрахунку VAT

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

Базовий URL

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

Ендпоінт calculate потребує вашого унікального API-ключа, країни та ціни, яку потрібно перевірити:
Цей успішний запит повертає повні результати розрахунку VAT, включаючи ставки, суми та інформацію про країну:

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

api_key
String
обов'язково
Ваш унікальний API-ключ. Зверніть увагу: у кожного користувача є унікальні API-ключі для кожного API Cleariflow, тому ключ API перевірки VAT не працюватиме для API геолокації IP, наприклад.
amount
String
обов'язково
Сума, для якої потрібно розрахувати VAT або з якої його виділити.
country_code
String
обов'язково
Дволітерний ISO 3166-1 alpha-2 код країни, в якій відбувається транзакція.
category
String
обов'язково
Категорія VAT для розрахунку. Використовуйте «standard» для стандартної ставки VAT або конкретні категорії, як-от «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.