CEST - Obter detalhe.
Permite obter informações detalhadas sobre o CEST com base no seu código identificador.
O recurso é fundamental para a correta identificação de mercadorias sujeitas aos regimes de
substituição tributária e antecipação do ICMS.
🔍 VINCULAÇÃO: O detalhamento auxilia na correlação entre o CEST e o NCM (Nomenclatura Comum do Mercosul),
garantindo que a classificação fiscal do produto esteja em conformidade com as exigências do CONFAZ.
get
Path Parameters
codigoCeststringrequired
Código CEST.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ObterDetalheCestViewModel
Dados detalhados do CEST.
* Additional properties are NOT allowed.
codigoCeststring | null
CEST - Código especificador da substituição tributária.
descricaostring | null
Descrição do CEST.
ncmsarray | null[object]
Dados do NCM no detalhe do CEST.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Cest/{codigoCest}/ObterDetalhe
Authentication
Path Parameters
Headers
Códigos de benefício - Listar.
Permite a consulta e listagem dos códigos de benefício fiscal parametrizados na plataforma.
Este recurso é essencial para a correta identificação de incentivos fiscais vinculados a determinados produtos ou operações,
garantindo a conformidade na emissão de documentos fiscais eletrônicos.
🔍 FILTROS: A busca pode ser refinada combinando o código técnico do benefício, termos contidos em sua descrição
ou restringindo os resultados a uma Unidade Federativa (UF) específica.
📑 PAGINAÇÃO: O retorno é paginado, permitindo o controle de fluxo de dados através dos parâmetros de offset e limit.
get
Query Parameters
codigoBeneficiostring
Filtrar pelo código do benefício.
buscastring
Filtrar por campo de busca genérico.
ufstring
Unidade Federativa.
Allowed values:ROACAMRRPAAPTOMAPICERNPBPEALSEBAMGESRJSPPRSCRSMSMTGODF
offsetinteger(int32)
Paginação da listagem - offset.
Default:1
limitinteger(int32)
Paginação da listagem - limit.
Default:10
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ListarCodigosBeneficioViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados de listagem do código de benefício fiscal.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/CodigoBeneficio/Listar
Authentication
Query Parameters
Headers
Enquadramento Legal do IPI - Listar.
Fornece a listagem dos códigos de enquadramento legal do IPI utilizados na emissão de documentos fiscais eletrônicos.
O enquadramento legal do IPI é obrigatório para determinadas situações tributárias e identifica a fundamentação legal
aplicável à operação, como imunidade, isenção, suspensão, redução ou outras hipóteses previstas na legislação.
🔍 FILTROS: A busca pode ser refinada por termos contidos no código ou na descrição do enquadramento,
ou restringindo os resultados a um grupo de CST específico.
📑 PAGINAÇÃO: O retorno é paginado, permitindo o controle de fluxo de dados através dos parâmetros de offset e limit.
get
Query Parameters
buscastring
Filtrar por campo de busca genérico (código ou descrição).
grupoCststring
Grupo de CST do IPI.
Allowed values:ImunidadeSuspensaoIsencaoReducaoOutros
offsetinteger(int32)
Paginação da listagem - offset.
Default:1
limitinteger(int32)
Paginação da listagem - limit.
Default:10
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ListarEnquadramentosLegalIpiViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados de listagem do código de enquadramento legal do IPI.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/EnquadramentoLegalIpi/Listar
Authentication
Query Parameters
Headers
NFS-e - Listar serviços.
Fornece uma listagem dos serviços da Lista de Serviços do CTN (Código Tributário Nacional),
com informações sobre o tipo de incidência do ISS para cada serviço.
🔍 FILTROS: A busca pode ser refinada por código ou descrição do serviço, e pelo tipo de incidência do ISS.
📑 PAGINAÇÃO: O retorno é paginado via parâmetros de offset e limit.
get
Query Parameters
buscastring
Filtrar por campo de busca genérico (código ou descrição).
incidenciaIssstring
Incidência do ISS conforme a Lista de Serviços do CTN.
Allowed values:LocalPrestadorLocalPrestacaoLocalTomador
offsetinteger(int32)
Quantidade de registros a serem pulados.
Default:1
limitinteger(int32)
Limite máximo de registros por página.
Default:10
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ListarServicoCtnViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados de listagem de um serviço da Lista de Serviços do CTN.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/ServicoCtn/Listar
Authentication
Query Parameters
Headers
NFS-e - Obter detalhe do serviço CTN.
Retorna os dados completos de um serviço da Lista de Serviços do CTN (Código Tributário Nacional),
incluindo os códigos NBS associados, os indicadores de operação de NFS-e e as classificações tributárias vinculadas.
get
Path Parameters
codigoCtnstringrequired
Código do serviço conforme a Lista de Serviços do CTN.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ObterDetalheServicoCtnViewModel
Dados detalhados de um serviço da Lista de Serviços do CTN.
* Additional properties are NOT allowed.
codigoCtnstring | null
Código do serviço conforme a Lista de Serviços do CTN.
descricaostring | null
Descrição do serviço.
incidenciaIssstring
Incidência do ISS conforme a Lista de Serviços do CTN.
Allowed values:LocalPrestadorLocalPrestacaoLocalTomador
nbsarray | null[object]
Dados do NBS no detalhe do Serviço CTN.
* Additional properties are NOT allowed.
Show Child Parameters
indicadoresOperacaoNfsearray | null[object]
Dados do indicador de operação de NFS-e no detalhe do Serviço CTN.
* Additional properties are NOT allowed.
Show Child Parameters
cClassTribsarray | null[object]
Dados da classificação tributária no detalhe do Serviço CTN.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/ServicoCtn/{codigoCtn}/ObterDetalhe