> ## 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 密钥。请注意，每个用户为每个 Cleariflow API 拥有独立的 API 密钥，因此您的 VAT 验证 API 密钥无法用于 IP 地理定位 API，例如。
</ParamField>

<ParamField query="amount" type="String" required>
  您要获取 VAT 金额或从中计算 VAT 的金额。
</ParamField>

<ParamField query="country_code" type="String" required>
  交易发生所在国家的两字母 ISO 3166-1 alpha-2 代码。
</ParamField>

<ParamField query="category" type="String" required>
  用于计算的 VAT 类别。标准 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>