Consultar capacidades

Consulte os recursos disponíveis antes de montar a integração. Esta consulta informa quais referências, verificações, documentos XML e ações de NFS-e podem ser usados, além das versões do motor e das tabelas.

Calculadora da Reforma Tributária · Acesso e limites · Versões e headers · Erros e correção

Informações de entrada

Esta consulta não recebe corpo nem parâmetros. Envie sua chave no header x-api-key.

GET/consultas/v1/reforma-tributaria/capacidades

Requisição

Exemplo de requisição

curl 'https://api.sintegrapi.com.br/consultas/v1/reforma-tributaria/capacidades' \
  -H 'x-api-key: SUA_API_KEY'

Resposta

O objeto data descreve os recursos disponíveis. Os campos booleanos usam true para um recurso suportado e false para um recurso não suportado:

Name
calculation
Type
boolean
Description
Disponibilidade do cálculo de IBS e CBS.
Name
classifications / classification_details
Type
boolean
Description
Disponibilidade da pesquisa de classificações e de seus detalhes, respectivamente.
Name
references
Type
object
Description
Disponibilidade de cada tipo de referência oficial.
Name
compatibility
Type
object
Description
Os campos ncm e nbs indicam a disponibilidade de cada verificação.
Name
xml_generation / xml_validation
Type
boolean
Description
Disponibilidade da geração e da validação XML, respectivamente.
Name
generation_documents / validation_documents
Type
array
Description
Listas distintas de documentos para geração e validação. Use o mnemonico da lista correspondente no parâmetro documento da consulta XML.
Name
nfse
Type
object
Description
Disponibilidade de cada ação do assistente NFS-e. O campo stage identifica esses recursos como beta.

As versões ficam no envelope, em metadata.engine_version, metadata.tax_tables_version e metadata.tax_tables_updated_at, e nos headers correspondentes.

As listas de documentos XML não são intercambiáveis: NFS-e está disponível para validação, mas não para geração. Confira sempre a lista retornada para a ação desejada.