Saltar para o conteúdo principal
GET
/
v1
/
categories
Endpoint de categorias de IVA
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"
    }
]

​
Primeiros passos

​
URL base

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

​
Endpoint de categorias

O endpoint categories requer a sua chave API única e o país que pretende consultar: 
https://vat.cleariflow.com/v1/categories/
? api_key = YOUR_UNIQUE_API_KEY
& country_code = DE
Este pedido bem-sucedido devolve informações abrangentes sobre taxas de IVA, incluindo taxas padrão e taxas reduzidas com as respetivas categorias: 
[
    {
        "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"
    }
]

​
Parâmetros de pedido

​
api_key
String
obrigatório
A sua chave API única. Note que cada utilizador tem chaves API únicas para cada API Cleariflow — a sua chave da API de validação de IVA não funcionará para a API de geolocalização IP, por exemplo.
​
country_code
String
obrigatório
O código ISO 3166-1 alpha-2 de duas letras do país para o qual pretende obter categorias de IVA.

​
Parâmetros de resposta

A resposta da API é devolvida num formato JSON universal e leve. A resposta é um array de objetos de categoria, onde cada objeto contém:
​
country_code
String
O código ISO 3166-1 alpha-2 de duas letras do país para o qual as categorias são devolvidas.
​
rate
String
A taxa de IVA para esta categoria específica como string decimal (por exemplo, “0.190” para 19%).
​
category
String
O nome da categoria (por exemplo, “standard”, “e-books”, “audiobooks”).
​
description
String
Uma descrição da categoria e da sua aplicabilidade.