Documentação da API GetTax

Como funciona

1. 1 · Você enviaProduto e operaçãogtin e cfop, obrigatórios. sector do cliente final e referenceDate, opcionais.
2. 2 · O GetTax resolveRegras vigentes na dataEncontra o produto no catálogo, aplica as regras fiscais curadas para aquela operação e calcula cada componente com as tabelas oficiais.
3. 3 · Você recebeAlternativas de enquadramentoUm status e as alternativas: CST, cClassTrib, alíquota de CBS, IBS-UF e IBS-município, fundamento legal e versões.

1curl -sS -X POST "$GETTAX_URL/v1/classifications/resolve" \
2  -H "Authorization: Bearer $GETTAX_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{"gtin": "7891000315507", "cfop": "5102"}'

1{
2  "decisionVersion": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
3  "status": "CLASSIFIED",
4  "classifications": [
5    {
6      "cst": "200",
7      "cClassTrib": "200034",
8      "legalBasis": "LC 214/2025, Art. 135",
9      "components": [
10        { "component": "CBS", "effectiveRate": "0.003600" },
11        { "component": "IBS_UF", "effectiveRate": "0.000400" },
12        { "component": "IBS_MUN", "effectiveRate": "0.000000" }
13      ]
14    }
15  ]
16}

• Todo resultado de negócio chega com HTTP 200. status diz se a classificação está concluída, pendente, em revisão ou se o GTIN não existe.
• Pode vir mais de uma alternativa. A ordem não é recomendação: o emissor escolhe pela condição de cada uma.
• Alíquotas são strings de fração decimal: "0.003600" é 0,36%. Use tipo decimal, nunca ponto flutuante.

A API está em homologação: regras, tabela de cClassTrib e alíquotas ainda estão em validação e podem incluir dados de demonstração. Os valores fiscais dos exemplos são ilustrativos.

Comece por aqui

• Início rápidoValide a sua chave e faça a primeira consulta de classificação fiscal.
• AutenticaçãoEnvie a chave de API no cabeçalho Authorization, no esquema Bearer, a partir do seu backend.

Conceitos

• Dados da consultaGTIN, CFOP, setor e data de referência, e como cada um muda o resultado.
• Status e alternativasComo ler o resultado de uma consulta, o que fazer em cada status e por que nunca escolher uma alternativa pela posição.
• Componentes e alíquotasCBS, IBS_UF e IBS_MUN, valores decimais em string e os três estados de cálculo de uma alternativa.
• Franquia e consumoO que consome a franquia mensal de consultas, o que não consome e o que acontece quando ela acaba.
• Erros e novas tentativasCódigos de erro, status HTTP, o que fazer em cada caso e quando repetir uma requisição.
• Boas práticasO que guardar, como tratar valores fiscais e como integrar o GetTax a um emissor de documentos fiscais.

Referência da API

• post/v1/classifications/resolveConsultar classificaçãoClassifica um produto (GTIN) para uma operação (CFOP) e devolve as alternativas de enquadramento de CBS e IBS.
• post/v1/classifications/batchConsultar em loteClassifica até 100 itens numa requisição, com admissão e resultado item a item.
• get/v1/enums/sectorsListar setoresLista os códigos aceitos no campo sector; exige chave e não consome franquia.

Toda rota em /v1/ exige a chave no cabeçalho Authorization: Bearer. Ver Autenticação.