Histórico de eventos - Resumo.
Fornece uma visão consolidada e simplificada dos eventos vinculados ao processamento de Notas Fiscais.
Permite o monitoramento operacional através de filtros por tipo de evento, performance (duração) e status da execução.
get
Query Parameters
tipoEventostring
Tipo de evento do contexto de notas fiscais.
Allowed values:PreNotaAutomaticaPreNotaSimplificadaEmissaoNfeEmissaoNfceAutomaticaEmissaoNfceSimplificadaEmissaoNfceCancelarNotaFiscalInutilizarFaixaNumeracaoTransmitirNotaFiscalEmitidaEmContingenciaEmitirNfeEstornoEmitirNfeDevolucaoEmitirNfeDevolucaoXmlObterDanfeNfeObterDanfeNfceObterArquivoXmlEmitirCartaDeCorrecaoObterXmlCartaCorrecaoObterArquivoXmlNfseObterDanfeNfseCancelarNotaFiscalServicoEmissaoNfse
sucessoboolean
Filtrar por eventos com sucesso ou erro.
buscastring
Filtrar pela busca genérica por texto.
dataInicialstring(date-time)
Filtrar pela data de início do evento “a partir de”.
dataFinalstring(date-time)
Filtrar pela data de início do evento “até”.
duracaoInicialMilissegundosnumber(double)
Filtrar pela duração mínima em milissegundos.
duracaoFinalMilissegundosnumber(double)
Filtrar pela duração máxima em milissegundos.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
Resumo do histórico de eventos de nota fiscal.
* Additional properties are NOT allowed.
tipoEventostring
Tipo de evento do contexto de notas fiscais.
Allowed values:PreNotaAutomaticaPreNotaSimplificadaEmissaoNfeEmissaoNfceAutomaticaEmissaoNfceSimplificadaEmissaoNfceCancelarNotaFiscalInutilizarFaixaNumeracaoTransmitirNotaFiscalEmitidaEmContingenciaEmitirNfeEstornoEmitirNfeDevolucaoEmitirNfeDevolucaoXmlObterDanfeNfeObterDanfeNfceObterArquivoXmlEmitirCartaDeCorrecaoObterXmlCartaCorrecaoObterArquivoXmlNfseObterDanfeNfseCancelarNotaFiscalServicoEmissaoNfse
totalEventosinteger(int32)
Quantidade total de eventos registrados para o tipo de evento e filtros aplicados.
totalSucessointeger(int32)
Quantidade total de eventos processados com sucesso para o tipo de evento e filtros aplicados.
totalFalhainteger(int32)
Quantidade total de eventos processados com falha para o tipo de evento e filtros aplicados.
get/api/v1/DocumentoFiscal/HistoricoEventos/Resumo
Authentication
Query Parameters
Headers
RecursosAdicionais
Controlador de Recursos Adicionais e Tabelas Auxiliares da Stone Tax API.
Fornece acesso a tabelas normatizadas e metadados fiscais essenciais para o preenchimento de documentos eletrônicos,
garantindo a integridade dos dados de classificação e operação fiscal.
Centraliza a consulta a códigos de tabelas externas (como CFOP e NCM), permitindo que o sistema parceiro
valide parâmetros de negócio contra as regras vigentes da SEFAZ e órgãos reguladores.
Todos os recursos disponibilizados exigem autenticação e visam apoiar a manutenção de cadastros
mestres e a correta parametrização de fluxos de entrada e saída de mercadorias.
Localização e Logradouro - Consultar por CEP.
Realiza a busca detalhada de informações do logradouro com base no Código de Endereçamento Postal (CEP).
Este recurso é essencial para a padronização de cadastros de clientes, fornecedores e emissores, garantindo a integridade dos dados de localização.
⚠️ ATENÇÃO: O CEP informado deve conter apenas números (8 dígitos).
🔍 DICA DE INTEGRAÇÃO: Utilize este endpoint para o preenchimento automático de campos de endereço em interfaces de usuário, minimizando erros de digitação e facilitando o cálculo de alíquotas baseadas na localidade (ISS/ICMS).
get
Path Parameters
cepstringrequired
CEP - Código de Endereçamento Postal.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ConsultaCepViewModel
Dados detalhados da consulta de endereço via CEP.
* Additional properties are NOT allowed.
cepstring | null
Código de Endereçamento Postal.
logradourostring | null
Nome da rua, avenida ou logradouro.
complementostring | null
Informações adicionais do endereço.
bairrostring | null
Bairro onde se localiza o logradouro.
localidadestring | null
Nome da cidade ou localidade.
ufstring | null
Unidade Federativa (Estado).
ibgestring | null
Código do município no IBGE.
get/api/v1/RecursosAdicionais/Cep/{cep}/Consultar
Authentication
Path Parameters
Headers
Consultar dados do CNPJ.
Realiza a busca de informações cadastrais detalhadas de uma pessoa jurídica junto às bases de dados oficiais.
Este recurso é fundamental para a validação de emissores e garantia de que os dados cadastrais
estão atualizados para a correta aplicação das regras fiscais.
⚠️ ATENÇÃO: A consulta retorna dados públicos do registro da empresa. Certifique-se de que o CNPJ informado
esteje em formato válido para evitar erros de validação de máscara.
🧪 TESTE: Em ambiente de sandbox, a consulta pode retornar dados simplificados ou simulados para garantir
a agilidade do desenvolvimento sem onerar bureaus de crédito ou bases governamentais reais.
get
Path Parameters
cnpjstringrequired
CNPJ a ser consultado.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ConsultaCnpjViewModel
Representa os dados detalhados resultantes de uma consulta de CNPJ.
* Additional properties are NOT allowed.
cnpjstring | null
Número de inscrição no Cadastro Nacional da Pessoa Jurídica.
razaoSocialstring | null
Nome empresarial ou razão social completa da entidade.
nomeFantasiastring | null
Nome fantasia ou título do estabelecimento, se houver.
naturezaJuridicastring | null
Descrição da natureza jurídica da organização.
regimestring
Regime do CNPJ na consulta.
Allowed values:MeiSimplesNacionalNormal
dataAberturastring(date)
Data oficial de abertura da empresa.
Example:2025-03-31
statusstring | null
Situação cadastral atual (Ex: Ativa, Baixada, Suspensa).
ultimaAlteracaoStatusstring | null(date)
Data da última atualização da situação cadastral.
telefonesarray | null[string]
Lista de números de telefone para contato.
emailsarray | null[string]
Lista de endereços de e-mail para contato.
atividadePrincipalobject
Representa uma Classificação Nacional de Atividade Econômica (CNAE).
* Additional properties are NOT allowed.
Show Child Parameters
atividadesSecundariasarray | null[object]
Representa uma Classificação Nacional de Atividade Econômica (CNAE).
* Additional properties are NOT allowed.
Show Child Parameters
enderecoobject
Representa o endereço completo de uma entidade.
* Additional properties are NOT allowed.
Show Child Parameters
sociosarray | null[object]
Representa um membro do quadro societário ou administrativo.
* Additional properties are NOT allowed.
Show Child Parameters
inscricoesEstaduaisarray | null[object]
Representa os detalhes de uma inscrição estadual.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Cnpj/{cnpj}/Consultar
Authentication
Path Parameters
Headers
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.
get
Query Parameters
filtrostring
Filtrar pelo filtro utilizado na consulta.
dataConsultaInicialstring(date-time)
Filtrar pela data de consulta “a partir de”.
dataConsultaFinalstring(date-time)
Filtrar pela data de consulta “até”.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ObterResumoConsultaCnpjAplicacaoViewModel
Dados do resumo do histórico de consultas de CNPJ.
* Additional properties are NOT allowed.
totalConsultasinteger(int32)
Total de consultas realizadas pelo emissor.
totalSucessointeger(int32)
Total de consultas concluídas com sucesso.
totalNaoEncontradointeger(int32)
Total de consultas cujo CNPJ não foi encontrado.
totalFalhainteger(int32)
Total de consultas que apresentaram falhas no processo.
get/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Resumo