メインコンテンツへスキップ
GET
/
v1
/
categories
VATカテゴリエンドポイント
curl --request GET \
  --url https://vat.cleariflow.com/v1/categories/
[
    {
        "category": "some agricultural inputs",
        "country_code": "DE",
        "description": "Reduced VAT rate (some agricultural inputs)",
        "rate": "0.070"
    },
    {
        "category": "taxation of some gold coins and jewellery",
        "country_code": "DE",
        "description": "Reduced VAT rate (taxation of some gold coins and jewellery)",
        "rate": "0.070"
    },
    {
        "category": "cut flowers and plants for decorative use and food production",
        "country_code": "DE",
        "description": "Reduced VAT rate (cut flowers and plants for decorative use and food production)",
        "rate": "0.070"
    },
    {
        "category": "e-books",
        "country_code": "DE",
        "description": "Reduced VAT rate (e-books)",
        "rate": "0.070"
    },

    ..................

    {
        "category": "standard",
        "country_code": "DE",
        "description": "Standard VAT rate",
        "rate": "0.190"
    },
    {
        "category": "newspapers and periodicals (except those containing content harmful to minors and/or more than 50% advertising)",
        "country_code": "DE",
        "description": "Reduced VAT rate (newspapers and periodicals (except those containing content harmful to minors and/or more than 50% advertising))",
        "rate": "0.070"
    },
    {
        "category": "some timber for industrial use",
        "country_code": "DE",
        "description": "Reduced VAT rate (some timber for industrial use)",
        "rate": "0.070"
    }
]

はじめに

ベースURL

https://vat.cleariflow.com/v1/categories/

カテゴリエンドポイント

categoriesエンドポイントには、固有のAPIキーと確認したい国が必要です。
https://vat.cleariflow.com/v1/categories/
? api_key = YOUR_UNIQUE_API_KEY
& country_code = DE
この成功したリクエストは、標準税率と関連カテゴリを伴う軽減税率を含む、包括的なVAT税率情報を返します。
[
    {
        "category": "some agricultural inputs",
        "country_code": "DE",
        "description": "Reduced VAT rate (some agricultural inputs)",
        "rate": "0.070"
    },
    {
        "category": "taxation of some gold coins and jewellery",
        "country_code": "DE",
        "description": "Reduced VAT rate (taxation of some gold coins and jewellery)",
        "rate": "0.070"
    },
    {
        "category": "cut flowers and plants for decorative use and food production",
        "country_code": "DE",
        "description": "Reduced VAT rate (cut flowers and plants for decorative use and food production)",
        "rate": "0.070"
    },
    {
        "category": "e-books",
        "country_code": "DE",
        "description": "Reduced VAT rate (e-books)",
        "rate": "0.070"
    },

    ..................

    {
        "category": "standard",
        "country_code": "DE",
        "description": "Standard VAT rate",
        "rate": "0.190"
    },
    {
        "category": "newspapers and periodicals (except those containing content harmful to minors and/or more than 50% advertising)",
        "country_code": "DE",
        "description": "Reduced VAT rate (newspapers and periodicals (except those containing content harmful to minors and/or more than 50% advertising))",
        "rate": "0.070"
    },
    {
        "category": "some timber for industrial use",
        "country_code": "DE",
        "description": "Reduced VAT rate (some timber for industrial use)",
        "rate": "0.070"
    }
]

リクエストパラメータ

api_key
String
必須
固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、VAT検証APIのキーはIPジオロケーションAPIなどでは動作しません。
country_code
String
必須
VATカテゴリを取得したい国の2文字ISO 3166-1 alpha-2コードです。

レスポンスパラメータ

APIレスポンスは、汎用的で軽量な JSON形式 で返されます。 レスポンスはカテゴリオブジェクトの配列で、各オブジェクトには次が含まれます。
country_code
String
カテゴリが返される国の2文字ISO 3166-1 alpha-2コードです。
rate
String
この特定カテゴリのVAT税率を小数文字列で表したものです(例:19%の場合は「0.190」)。
category
String
カテゴリの名前です(例:「standard」「e-books」「audiobooks」)。
description
String
カテゴリとその適用範囲に関する説明です。