Endpoint de cálculo de IVA

GET

calculate

curl --request GET \
  --url https://vat.cleariflow.com/v1/calculate/

import requests

url = "https://vat.cleariflow.com/v1/calculate/"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://vat.cleariflow.com/v1/calculate/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vat.cleariflow.com/v1/calculate/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://vat.cleariflow.com/v1/calculate/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://vat.cleariflow.com/v1/calculate/")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vat.cleariflow.com/v1/calculate/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
    "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.

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.

Endpoint de categorias de IVAO endpoint `categories` fornece acesso abrangente às taxas de IVA atuais e categorias fiscais para países específicos, incluindo taxas reduzidas para bens e serviços elegíveis.

Endpoint de cálculo de IVA

curl --request GET \
  --url https://vat.cleariflow.com/v1/calculate/

import requests

url = "https://vat.cleariflow.com/v1/calculate/"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://vat.cleariflow.com/v1/calculate/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vat.cleariflow.com/v1/calculate/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://vat.cleariflow.com/v1/calculate/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://vat.cleariflow.com/v1/calculate/")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vat.cleariflow.com/v1/calculate/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
    "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"
}

Validação

Consulta

Criação

Endpoint de cálculo de IVA

Primeiros passos

URL base

Endpoint de cálculo

Parâmetros de pedido

Parâmetros de resposta

​Primeiros passos

​URL base

​Endpoint de cálculo

​Parâmetros de pedido

​Parâmetros de resposta

Primeiros passos

URL base

Endpoint de cálculo

Parâmetros de pedido

Parâmetros de resposta