Saltar para o conteúdo principal
GET
/
v1
/
calculate
Endpoint de cálculo de IVA
curl --request GET \
  --url https://vat.cleariflow.com/v1/calculate/
{
    "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"
}

​
Primeiros passos

​
URL base

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

​
Endpoint de cálculo

O endpoint calculate requer a sua chave API única, o país e o preço que pretende verificar: 
https://vat.cleariflow.com/v1/calculate/
? api_key = YOUR_UNIQUE_API_KEY
& amount = 175  
& country_code = DE
& category = standard
Este pedido bem-sucedido devolve resultados abrangentes de cálculo de IVA, incluindo taxas, montantes e informações do país: 
{
    "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"
}

​
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.
​
amount
String
obrigatório
O montante para o qual pretende obter o valor de IVA ou a partir do qual pretende calculá-lo.
​
country_code
String
obrigatório
O código ISO 3166-1 alpha-2 de duas letras do país onde a transação ocorre.
​
category
String
obrigatório
A categoria de IVA a utilizar no cálculo. Utilize “standard” para a taxa padrão de IVA, ou categorias específicas como “e-books”, “audiobooks”, etc. para taxas reduzidas.
​
is_vat_incl
Boolean
Se o montante já inclui IVA e pretende fazer o cálculo inverso para separar o montante e o IVA, defina este parâmetro como true. Se este parâmetro não for explicitamente incluído, o valor predefinido é false.

​
Parâmetros de resposta

A resposta da API é devolvida num formato JSON universal e leve.
​
amount_excluding_vat
String
O montante sem IVA.
​
amount_including_vat
String
A soma do montante base e do IVA, ou seja, amount_excluding_vat + vat_amount.
​
vat_amount
String
O montante de IVA calculado.
​
vat_category
String
A categoria da compra, utilizada para determinar se se qualifica para uma taxa reduzida. Consulte abaixo a lista de categorias suportadas.
​
vat_rate
String
A taxa de IVA como string decimal (por exemplo, “0.190” para 19%).
​
country
Object
Objeto que contém informações do país.
​
country.code
String
O código ISO 3166-1 alpha-2 de duas letras do país onde a transação ocorre.
​
country.name
String
O nome do país a partir do qual o IVA está a ser calculado.