メインコンテンツへスキップ
GET
VAT計算エンドポイント

はじめに

ベースURL

計算エンドポイント

calculateエンドポイントには、固有のAPIキー、国、確認したい価格が必要です。
この成功したリクエストは、税率、金額、国情報を含む包括的なVAT計算結果を返します。

リクエストパラメータ

api_key
String
必須
固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、VAT検証APIのキーはIPジオロケーションAPIなどでは動作しません。
amount
String
必須
VAT額を取得、またはVATを含む金額から逆算したい金額です。
country_code
String
必須
取引が行われる国の2文字ISO 3166-1 alpha-2コードです。
category
String
必須
計算に使用するVATカテゴリです。標準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税率です(例:19%の場合は「0.190」)。
country
Object
国情報を含むオブジェクトです。
country.code
String
取引が行われる国の2文字ISO 3166-1 alpha-2コードです。
country.name
String
VATが計算される国の名前です。