# GetTax

> API B2B de classificação fiscal da POS Controle para a reforma tributária do consumo (IBS e CBS). A software house envia GTIN e CFOP (e, opcionalmente, o setor do cliente final) e recebe as alternativas de enquadramento: CST, cClassTrib, condições, fundamento legal e alíquotas de CBS, IBS-UF e IBS-município, com as versões usadas na decisão.

- Base URL (homologação): `https://app-web-hmg-01-api-gettax-hmg-dvawffg9g9cpcef3.brazilsouth-01.azurewebsites.net`. Toda rota sob `/v1/` exige `Authorization: Bearer <chave de API>`.
- Corpo e respostas em JSON UTF-8. Erros têm o formato `{"error": "CODIGO"}`, sem detalhe do campo.
- Valores fiscais são strings de fração decimal com 6 casas: `"0.009000"` = 0,9%; redução `"0.600000"` = 60%.
- Toda página desta documentação tem versão markdown: troque a barra final da URL por `.md`.

## Começando

- [Início rápido](https://kind-coast-062131010.2.azurestaticapps.net/guias/inicio-rapido.md): Valide a sua chave e faça a primeira consulta de classificação fiscal.
- [Autenticação](https://kind-coast-062131010.2.azurestaticapps.net/guias/autenticacao.md): Envie a chave de API no cabeçalho Authorization, no esquema Bearer, a partir do seu backend.

## Conceitos

- [Dados da consulta](https://kind-coast-062131010.2.azurestaticapps.net/guias/dados-da-consulta.md): GTIN, CFOP, setor e data de referência, e como cada um muda o resultado.
- [Status e alternativas](https://kind-coast-062131010.2.azurestaticapps.net/guias/status-e-alternativas.md): Como 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íquotas](https://kind-coast-062131010.2.azurestaticapps.net/guias/componentes-e-aliquotas.md): CBS, IBS_UF e IBS_MUN, valores decimais em string e os três estados de cálculo de uma alternativa.
- [Franquia e consumo](https://kind-coast-062131010.2.azurestaticapps.net/guias/franquia.md): O que consome a franquia mensal de consultas, o que não consome e o que acontece quando ela acaba.
- [Erros e novas tentativas](https://kind-coast-062131010.2.azurestaticapps.net/guias/erros.md): Códigos de erro, status HTTP, o que fazer em cada caso e quando repetir uma requisição.
- [Boas práticas](https://kind-coast-062131010.2.azurestaticapps.net/guias/boas-praticas.md): O que guardar, como tratar valores fiscais e como integrar o GetTax a um emissor de documentos fiscais.

## Referência da API

- [Consultar classificação](https://kind-coast-062131010.2.azurestaticapps.net/referencia/resolve-classification.md): Classifica um produto (GTIN) para uma operação (CFOP) e devolve as alternativas de enquadramento de CBS e IBS. (`POST /v1/classifications/resolve`)
- [Consultar em lote](https://kind-coast-062131010.2.azurestaticapps.net/referencia/resolve-classification-batch.md): Classifica até 100 itens numa requisição, com admissão e resultado item a item. (`POST /v1/classifications/batch`)
- [Listar setores](https://kind-coast-062131010.2.azurestaticapps.net/referencia/list-sectors.md): Lista os códigos aceitos no campo sector; exige chave e não consome franquia. (`GET /v1/enums/sectors`)

## Optional

- [Documentação completa](https://kind-coast-062131010.2.azurestaticapps.net/llms-full.txt): todas as páginas acima em um único arquivo markdown.
- [Contrato OpenAPI 3.0](https://kind-coast-062131010.2.azurestaticapps.net/openapi.json): especificação da API pública, importável no Postman, Insomnia e geradores de cliente.
- [Site do GetTax](https://gentle-cliff-043aa3510.6.azurestaticapps.net): página comercial, planos e cadastro.