Saltar al contenido 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"
}

​
Primeros pasos

​
URL base

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

​
Endpoint de cálculo

El endpoint calculate requiere su clave API única, el país y el precio que desea verificar: 
https://vat.cleariflow.com/v1/calculate/
? api_key = YOUR_UNIQUE_API_KEY
& amount = 175  
& country_code = DE
& category = standard
Esta solicitud exitosa devuelve resultados completos del cálculo de IVA, incluidas tasas, importes e información del 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 solicitud

​
api_key
String
requerido
Su clave API única. Tenga en cuenta que cada usuario tiene claves API únicas para cada una de las APIs de Cleariflow, por lo que su clave de la API de validación de IVA no funcionará para su API de geolocalización IP, por ejemplo.
​
amount
String
requerido
El importe para el que desea obtener el monto de IVA o calcularlo a partir de él.
​
country_code
String
requerido
El código ISO 3166-1 alpha-2 de dos letras del país en el que tiene lugar la transacción.
​
category
String
requerido
La categoría de IVA a utilizar para el cálculo. Use “standard” para la tasa estándar de IVA, o categorías específicas como “e-books”, “audiobooks”, etc. para tasas reducidas.
​
is_vat_incl
Boolean
Si el importe ya incluye IVA y desea realizar el cálculo inverso para separar el importe y el IVA, establezca este parámetro en true. Si este parámetro no se incluye explícitamente, su valor predeterminado será false.

​
Parámetros de respuesta

La respuesta de la API se devuelve en un formato JSON universal y ligero.
​
amount_excluding_vat
String
El importe sin IVA.
​
amount_including_vat
String
La suma del importe base y el IVA, es decir, amount_excluding_vat + vat_amount.
​
vat_amount
String
El importe de IVA calculado.
​
vat_category
String
La categoría de la compra, utilizada para determinar si califica para una tasa reducida. Consulte a continuación una lista de categorías admitidas.
​
vat_rate
String
La tasa de IVA como cadena decimal (p. ej., “0.190” para el 19 %).
​
country
Object
Objeto que contiene información del país.
​
country.code
String
El código ISO 3166-1 alpha-2 de dos letras del país en el que tiene lugar la transacción.
​
country.name
String
El nombre del país desde el que se calcula el IVA.