CFOPs - Listar.

Fornece uma listagem completa dos Códigos Fiscais de Operações e Prestações (CFOP). Este recurso é fundamental para determinar a natureza da circulação de mercadorias ou a prestação de serviços.

⚠️ ATENÇÃO: A escolha incorreta do CFOP pode impactar diretamente na apuração de impostos e na validação da nota fiscal pela SEFAZ. Utilize os filtros para restringir a busca ao cenário de negócio desejado.

🔍 DICA DE INTEGRAÇÃO: Recomenda-se o cache dessas informações no sistema local, realizando consultas periódicas para capturar novos códigos ou alterações em indicadores de faturamento e devolução.

get

Query Parameters

codigoCfopstring

Filtrar pelo código numérico do CFOP.

buscastring

Filtrar por campo de busca genérico.

tipoOperacaostring

Tipo de operação do CFOP.

Allowed values:EntradaSaida

tipoDestinostring

Tipo de destino do CFOP.

Allowed values:EstadualInterestadualExterior

tipoIcmsstring

Tipo de ICMS do CFOP.

Allowed values:IcmsTributadoIcmsRetidoAmbos

tipoDestinatariostring

Tipo de destinatário do CFOP.

Allowed values:NaoContribuinteAmbos

permiteNfeboolean

Filtrar se permite emissão de NFe.

indicaComunicacaoboolean

Filtrar se indica serviços de comunicação.

indicaTransporteboolean

Filtrar se indica serviços de transporte.

indicaDevolucaoboolean

Filtrar se caracteriza devolução.

indicaCombustivelboolean

Filtrar se envolve combustíveis.

compoeFaturamentoboolean

Filtrar se compõe faturamento.

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

OK

ListarCfopsViewModelListPaginationResponse

* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]

Dados para listagem de CFOPs (Código Fiscal de Operações e de Prestações).

* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Cfop/Listar
 

NCMs - Listar.

Consulta a tabela de Nomenclatura Comum do Mercosul (NCM), utilizada para a classificação fiscal de mercadorias no comércio internacional e doméstico.

⚠️ VIGÊNCIA: Atente-se aos campos de data de vigência. Consultar NCMs expiradas pode ocasionar rejeições no momento da emissão do documento fiscal eletrônico.

🧪 TESTE: Em ambiente de sandbox, a tabela reflete a estrutura oficial, permitindo validar se a lógica de busca por descrição ou código atende aos requisitos do PDV ou ERP.

🔍 BUSCA SEMÂNTICA: O parâmetro ‘busca’ realiza uma varredura tanto na descrição do item quanto no segmento relacionado, facilitando a identificação correta da mercadoria.

get

Query Parameters

codigoNcmstring

Filtrar pelo código NCM exato.

extensaoTipiinteger(int32)

Filtrar pela extensão TIPI (EX).

buscastring

Filtrar por campo de busca genérico.

dataInicioVigenciaInicialstring(date)

Data de início de vigência “a partir de”.

dataInicioVigenciaFinalstring(date)

Data de início de vigência “até”.

dataFimVigenciaInicialstring(date)

Data de fim de vigência “a partir de”.

dataFimVigenciaFinalstring(date)

Data de fim de vigência “até”.

offsetinteger(int32)

Quantidade de registros a serem pulados (deslocamento).

Default:1

limitinteger(int32)

Limite máximo de registros por página.

Default:10

Headers

DocumentoEmissorstring

Documento do emissor.

Response

OK

ListarNcmsViewModelListPaginationResponse

* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]

Dados para a listagem de NCMs.

* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Ncm/Listar
 

NCM - Obter detalhe.

Realiza uma consulta detalhada à tabela de Nomenclatura Comum do Mercosul (NCM), fornecendo informações sobre a classificação fiscal e tributos aproximados por UF.

🔍 CLASSIFICAÇÃO: O código NCM deve ser informado com 8 dígitos numéricos. O tributo aproximado deve ser informado em operações de vendas a consumidor final.

ℹ️ EXTENSÃO TIPI: Caso o produto possua uma exceção tarifária específica, utilize o parâmetro Extensão TIPI (Ex) para obter o detalhamento diferenciado aplicável ao código.

⚠️ ATENÇÃO: A utilização de NCMs inválidos ou extintos pode ocasionar a rejeição de documentos fiscais eletrônicos (NF-e/NFC-e) pelas Secretarias da Fazenda.

get

Query Parameters

extensaoTipiinteger(int32)

Extensão TIPI do NCM. (Opcional)

Path Parameters

codigoNcmstringrequired

Código do NCM.

Headers

DocumentoEmissorstring

Documento do emissor.

Response

OK

NcmViewModel

Dados detalhados do NCM.

* Additional properties are NOT allowed.
codigoNcmstring | null

Código da Nomenclatura Comum do Mercosul.

extensaoTipiinteger(int32)

Código de extensão da TIPI (Tabela de Incidência do IPI).

descricaostring | null

Descrição completa da mercadoria ou serviço vinculada ao NCM.

inicioVigenciastring(date)

Data de início da vigência do código NCM.

Example:2025-03-31

fimVigenciastring | null(date)

Data de término da vigência (opcional).

tributosAproximadosarray | null[object]

Dados dos tributos aproximados vinculados a um NCM (Lei da Transparência).

* Additional properties are NOT allowed.
Show Child Parameters
cestsarray | null[object]

Dados do CEST do NCM.

* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Ncm/{codigoNcm}/ObterDetalhe
 

CEST - Listar

Fornece uma listagem completa e atualizada dos códigos CEST, utilizados para identificar mercadorias e bens passíveis de Substituição Tributária (ST) e antecipação de ICMS.

O recurso permite a consulta técnica para auxiliar na correta classificação fiscal de produtos, garantindo que o vínculo entre o NCM e o CEST esteja em conformidade com o Convênio ICMS vigente.

🔍 DICA DE BUSCA: Utilize o filtro por busca para encontrar códigos baseados no agrupamento de mercadorias ou o filtro por código para validações diretas de conformidade.

get

Query Parameters

codigoCeststring

Filtrar pelo código CEST.

buscastring

Filtrar por campo de busca genérico.

offsetinteger(int32)

Paginação da listagem - offset.

Default:1

limitinteger(int32)

Paginação da listagem - limit.

Default:10

Headers

DocumentoEmissorstring

Documento do emissor.

Response

OK

ListarCestsViewModelListPaginationResponse

* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]

Dados para listagem de Cests.

* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Cest/Listar
 

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

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