Calculadora da Reforma Tributária
Use a calculadora da reforma tributária via API para calcular IBS e CBS, consultar CST/cClassTrib e verificar a compatibilidade de NCM/NBS. Também é possível gerar e validar grupos XML e usar o assistente de NFS-e com sua chave de API. Os resultados incluem a identificação do motor oficial e das tabelas tributárias utilizados.
Consultas ilimitadas para clientes pagos: use a API sem franquia mensal e sem cobrança por consulta enquanto tiver um plano pago ativo e vigente, inclusive com saldo zero, ou pós-pago habilitado. O uso respeita o limite de frequência do plano. Free Tier e bônus gratuito não concedem acesso. Não há desconto de créditos nem inclusão dessas consultas na fatura pós-paga. Após uma mudança no plano, aguarde até 60 segundos para que as condições de acesso sejam atualizadas.
Autenticação e limite
Envie x-api-key: SUA_API_KEY. O limite de frequência segue o plano, com padrão de 120 requisições por minuto. Havendo vários planos vigentes, aplica-se o de maior frequência, preservando sua janela de tempo.
O limite é compartilhado entre todas as chaves da mesma conta e independente do limite das consultas cobradas. Cada requisição autorizada conta uma vez, inclusive pesquisas, referências, geração de XML e entradas inválidas. O limite é aplicado em janela móvel. Em 429, aguarde os segundos informados em Retry-After antes de tentar novamente.
Rotas
Base da API:
https://api.sintegrapi.com.br/consultas/v1/reforma-tributaria
Escolha um endpoint para ver seus parâmetros, exemplos de requisição e formato de resposta:
- Calcular IBS e CBSPOST
/consultas/v1/reforma-tributaria/calcular-ibs-cbsCalcule IBS e CBS via API para operações com até 100 itens. Consulte bases, tributos, totais e memória de cálculo da reforma tributária.
- Consultar capacidadesGET
/consultas/v1/reforma-tributaria/capacidadesConsulte os recursos da API da reforma tributária, as versões do motor e das tabelas, os documentos XML suportados e as ações de NFS-e.
- Consultar referênciasGET
/consultas/v1/reforma-tributaria/referencias/{tipo}Consulte referências oficiais da reforma tributária via API: UFs, municípios, documentos, CST, cClassTrib e fundamentação por vigência.
- Pesquisar classificaçõesGET
/consultas/v1/reforma-tributaria/classificacoesPesquise classificações tributárias de IBS e CBS via API por código ou descrição, com filtros de CST, documento e vigência e resultados paginados.
- Detalhar classificaçãoGET
/consultas/v1/reforma-tributaria/classificacoes/{codigo}Consulte os detalhes de um código cClassTrib e sua fundamentação legal via API, considerando a data da operação na reforma tributária.
- Verificar NCM e NBSPOST
/consultas/v1/reforma-tributaria/verificar-ncm-nbsVerifique via API a compatibilidade de NCM ou NBS com uma classificação tributária de IBS e CBS. Entenda os estados e as respostas da consulta.
- Gerar XML tributárioPOST
/consultas/v1/reforma-tributaria/xml/gerar/{documento}Gere grupos tributários XML via API a partir de uma operação de IBS e CBS. Consulte documentos suportados, parâmetros e versões nos headers.
- Validar XML tributárioPOST
/consultas/v1/reforma-tributaria/xml/validar/{documento}Valide grupos tributários ou notas em XML via API da reforma tributária. Veja documentos suportados, escopos de validação e como interpretar o retorno.
- Assistente NFS-ePOST
/consultas/v1/reforma-tributaria/nfse/{acao}Use o assistente NFS-e via API para consultar classificações e indicadores, validar combinações, localizar a operação e calcular a base tributária.
Baixar a especificação OpenAPI v1.
Envie JSON com Content-Type: application/json, até 256 KiB. Para validar XML, envie application/xml, até 1 MiB. Os limites valem também sem Content-Length. Considere um prazo máximo de 60 segundos por requisição. As respostas usam Cache-Control: no-store.
Versão do motor e das tabelas
Todas as respostas JSON do módulo contêm metadata, inclusive erros. Os dados confirmados também são enviados em headers, acessíveis por CORS:
| JSON | Header |
|---|---|
metadata.engine_version | X-Tax-Engine-Version |
metadata.tax_tables_version | X-Tax-Tables-Version |
metadata.tax_tables_updated_at | X-Tax-Tables-Updated-At |
A data usa YYYY-MM-DD e corresponde à atualização das tabelas informada pela fonte oficial. Na geração XML, esses dados ficam apenas nos headers, preservando o corpo XML.
Quando as versões não estiverem disponíveis, como em uma resposta de erro, os três campos serão null e os headers correspondentes serão omitidos. A data também será null quando não for informada pela fonte oficial.
O campo versao identifica o formato da operação (ROC), atualmente 0.0.1. Consulte metadata.engine_version para a versão do motor e metadata.tax_tables_version para a versão das tabelas.
Referências e classificações
Consulte referências oficiais, pesquise classificações ou veja os detalhes e a fundamentação de um cClassTrib.
Cálculo de IBS e CBS
Veja os campos da operação, o exemplo com múltiplos itens e o retorno em Calcular IBS e CBS.
Compatibilidade de NCM e NBS
Consulte os parâmetros e os estados de compatibilidade em Verificar NCM e NBS.
XML
Cada ação possui sua própria documentação: Gerar XML tributário e Validar XML tributário. Confira as listas distintas de documentos em Consultar capacidades.
Assistente NFS-e
Veja as ações disponíveis, os campos de cada ação e os recursos beta em Assistente NFS-e.
Erros e correção
| HTTP | Situação |
|---|---|
| 400 | JSON, XML, código, data ou parâmetro inválido |
| 401 | Chave ausente ou inválida |
| 403 | Conta sem plano pago vigente ou pós-pago habilitado |
| 413 | Limite do corpo excedido |
| 415 | Content-Type ou codificação não suportados |
| 429 | Limite do plano atingido; respeite Retry-After |
| 500 | Falha inesperada; use o request_id no suporte |
| 501 | Recurso não suportado; consulte /capacidades |
| 503 | Serviço temporariamente indisponível ou prazo de resposta excedido |
error_message contém code, message e, quando identificados, fields. Os caminhos correspondem aos campos enviados, por exemplo itens[1].cClassTrib para o segundo item. Corrija os campos indicados antes de repetir a requisição.
{
"request_id": "e9e935e3-6a67-4a55-8533-2f98fe22e01a",
"success": false,
"error": true,
"error_message": {
"code": "PLANO_PAGO_NECESSARIO",
"message": "Estas consultas gratuitas estão disponíveis para clientes com plano pago vigente ou pós-pago habilitado."
},
"data": null,
"metadata": { "engine_version": null, "tax_tables_version": null, "tax_tables_updated_at": null }
}
Em caso de 503, tente novamente mais tarde. Se a falha persistir, informe request_id ou X-Request-Id ao suporte para identificar a requisição.
