Histórico de consultas CNPJ - Resumo.
Fornece uma visão consolidada e totalizada do histórico de consultas de CNPJ realizadas pela aplicação.
Este recurso é estratégico para a gestão e bilhetagem do consumo, permitindo auditar o volume de requisições
processadas dentro de um período específico ou através de termos de busca.
📊 INDICADORES: O retorno contempla somatórios que auxiliam no controle operacional e financeiro do uso da API de consulta cadastral.
Query Parameters
Filtrar pelo filtro utilizado na consulta.
Filtrar pela data de consulta “a partir de”.
Filtrar pela data de consulta “até”.
Headers
Documento do emissor.
Response
Response
OK
ObterResumoConsultaCnpjAplicacaoViewModel
Dados do resumo do histórico de consultas de CNPJ.
Total de consultas realizadas pelo emissor.
Total de consultas concluídas com sucesso.
Total de consultas cujo CNPJ não foi encontrado.
Total de consultas que apresentaram falhas no processo.
Authentication
Query Parameters
Headers
Histórico de consultas CNPJ - Listar.
Permite listar consultas de CNPJ realizadas. O recurso retorna uma relação resumida das consultas, possibilitando a identificação de quais CNPJs foram consultados em um determinado período.
📋 PAGINAÇÃO: A listagem utiliza o padrão de offset e limit. É recomendável parametrizar o tamanho da página para otimizar o tempo de resposta e o tráfego de dados.
🔍 FILTROS: É possível refinar os resultados utilizando intervalos de datas ou filtro para localizar registros específicos no histórico.
Query Parameters
Filtrar pelo filtro utilizado na consulta.
Filtrar pela data de consulta “a partir de”.
Filtrar pela data de consulta “até”.
Quantidade de registros a serem pulados.
Default:1
Limite máximo de registros por página.
Default:10
Headers
Documento do emissor.
Response
Response
OK
ListarConsultasCnpjAplicacaoViewModelListPaginationResponse
Dados para listagem do histórico de consultas do CNPJ.
Show Child Parameters
Authentication
Query Parameters
Headers
Histórico de consultas CNPJ - Detalhe.
Permite obter o detalhamento completo de uma consulta de CNPJ realizada anteriormente.
O recurso recupera os dados cadastrais e fiscais da entidade consultada conforme registrado no momento da transação original,
utilizando o identificador único gerado pelo histórico.
🔍 RASTRO: Este endpoint é essencial para auditoria e recuperação de dados de consultas anteriores sem a necessidade de realizar um novo consumo tarifado, desde que o ID do histórico esteja disponível.
Path Parameters
Identificador do histórico de consulta do cnpj.
Headers
Documento do emissor.
Response
Response
OK
ObterDetalheConsultaCnpjAplicacaoViewModel
Dados detalhados do histórico de consulta de CNPJ.
Identificador único da consulta.
Filtro utilizado na consulta (CNPJ).
Status da consulta de CNPJ.
Allowed values:SucessoNaoEncontradoFalha
Data e hora em que a consulta foi registrada.
Mensagem detalhando o motivo de uma eventual falha.
JSON com o resultado final processado ou informado.
Authentication
Path Parameters
Headers
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.
Query Parameters
Filtrar pelo código numérico do CFOP.
Filtrar por campo de busca genérico.
Tipo de operação do CFOP.
Allowed values:EntradaSaida
Tipo de destino do CFOP.
Allowed values:EstadualInterestadualExterior
Tipo de ICMS do CFOP.
Allowed values:IcmsTributadoIcmsRetidoAmbos
Tipo de destinatário do CFOP.
Allowed values:NaoContribuinteAmbos
Filtrar se permite emissão de NFe.
Filtrar se indica serviços de comunicação.
Filtrar se indica serviços de transporte.
Filtrar se caracteriza devolução.
Filtrar se envolve combustíveis.
Filtrar se compõe faturamento.
Quantidade de registros a serem pulados.
Default:1
Limite máximo de registros por página.
Default:10
Headers
Documento do emissor.
Response
Response
OK
ListarCfopsViewModelListPaginationResponse
Dados para listagem de CFOPs (Código Fiscal de Operações e de Prestações).
Show Child Parameters
Authentication
Query Parameters
Headers
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.
Query Parameters
Filtrar pelo código NCM exato.
Filtrar pela extensão TIPI (EX).
Filtrar por campo de busca genérico.
Data de início de vigência “a partir de”.
Data de início de vigência “até”.
Data de fim de vigência “a partir de”.
Data de fim de vigência “até”.
Quantidade de registros a serem pulados (deslocamento).
Default:1
Limite máximo de registros por página.
Default:10
Headers
Documento do emissor.
Response
Response
OK
ListarNcmsViewModelListPaginationResponse
Dados para a listagem de NCMs.