Passer au contenu principal
GET
/
v1
/
calculate
Endpoint de calcul TVA
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"
}

​
Premiers pas

​
URL de base

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

​
Endpoint de calcul

L’endpoint calculate requiert votre clé API unique, le pays et le prix que vous souhaitez vérifier : 
https://vat.cleariflow.com/v1/calculate/
? api_key = YOUR_UNIQUE_API_KEY
& amount = 175  
& country_code = DE
& category = standard
Cette requête réussie renvoie des résultats complets de calcul de TVA, incluant les taux, les montants et les informations sur le pays : 
{
    "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"
}

​
Paramètres de requête

​
api_key
String
requis
Votre clé API unique. Notez que chaque utilisateur possède des clés API uniques pour chaque API Cleariflow ; votre clé de l’API de validation TVA ne fonctionnera pas pour votre API de géolocalisation IP, par exemple.
​
amount
String
requis
Le montant pour lequel vous souhaitez obtenir le montant de TVA ou à partir duquel le calculer.
​
country_code
String
requis
Le code ISO 3166-1 alpha-2 à deux lettres du pays dans lequel la transaction a lieu.
​
category
String
requis
La catégorie de TVA à utiliser pour le calcul. Utilisez « standard » pour le taux de TVA standard, ou des catégories spécifiques comme « e-books », « audiobooks », etc. pour les taux réduits.
​
is_vat_incl
Boolean
Si le montant inclut déjà la TVA et que vous souhaitez effectuer le calcul inverse pour séparer le montant et la TVA, définissez ce paramètre sur true. S’il n’est pas explicitement inclus, il sera false par défaut.

​
Paramètres de réponse

La réponse de l’API est renvoyée dans un format JSON universel et léger.
​
amount_excluding_vat
String
Le montant hors TVA.
​
amount_including_vat
String
La somme du montant de base et de la TVA, c’est-à-dire amount_excluding_vat + vat_amount.
​
vat_amount
String
Le montant de TVA calculé.
​
vat_category
String
La catégorie de l’achat, utilisée pour déterminer si elle bénéficie d’un taux réduit. Voir ci-dessous pour la liste des catégories prises en charge.
​
vat_rate
String
Le taux de TVA sous forme de chaîne décimale (par ex., « 0.190 » pour 19 %).
​
country
Object
Objet contenant les informations sur le pays.
​
country.code
String
Le code ISO 3166-1 alpha-2 à deux lettres du pays dans lequel la transaction a lieu.
​
country.name
String
Le nom du pays à partir duquel la TVA est calculée.