> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Эндпоинт расчёта VAT

> Эндпоинт `calculate` обеспечивает точный расчёт VAT для соответствующего ценообразования с учётом правил конкретной страны, суммы транзакции и опциональных категорий товаров.

## Начало работы

### Базовый 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: ставки, суммы и информацию о стране:

<ResponseExample>
  ```json theme={"system"}
  {
      "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"
  }
  ```
</ResponseExample>

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

<ParamField query="api_key" type="String" required>
  Ваш уникальный API-ключ. У каждого пользователя уникальные ключи для каждого API Cleariflow, поэтому ключ API проверки VAT не будет работать, например, с API геолокации IP.
</ParamField>

<ParamField query="amount" type="String" required>
  Сумма, для которой нужно получить или рассчитать VAT.
</ParamField>

<ParamField query="country_code" type="String" required>
  Двухбуквенный ISO 3166-1 alpha-2 код страны, в которой совершается транзакция.
</ParamField>

<ParamField query="category" type="String" required>
  Категория VAT для расчёта. Используйте «standard» для стандартной ставки или конкретные категории вроде «e-books», «audiobooks» и т.д. для пониженных ставок.
</ParamField>

<ParamField query="is_vat_incl" type="Boolean">
  Если сумма уже включает VAT и нужен обратный расчёт с разделением суммы и VAT, установите true. Если параметр не указан явно, по умолчанию false.
</ParamField>

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

Ответ API возвращается в универсальном лёгком формате [JSON](https://www.json.org/json-en.html).

<ResponseField name="amount_excluding_vat" type="String">
  Сумма без VAT.
</ResponseField>

<ResponseField name="amount_including_vat" type="String">
  Сумма базовой суммы и VAT, т.е. `amount_excluding_vat` + `vat_amount`.
</ResponseField>

<ResponseField name="vat_amount" type="String">
  Рассчитанная сумма VAT.
</ResponseField>

<ResponseField name="vat_category" type="String">
  Категория покупки, определяющая право на пониженную ставку. См. список поддерживаемых категорий ниже.
</ResponseField>

<ResponseField name="vat_rate" type="String">
  Ставка VAT в виде десятичной строки (например, «0.190» для 19%).
</ResponseField>

<ResponseField name="country" type="Object">
  Объект с информацией о стране.
</ResponseField>

<ResponseField name="country.code" type="String">
  Двухбуквенный ISO 3166-1 alpha-2 код страны, в которой совершается транзакция.
</ResponseField>

<ResponseField name="country.name" type="String">
  Название страны, для которой рассчитывается VAT.
</ResponseField>