Endpoints destinados à consulta de informações e documentos fiscais já processados pela API - NF-e, NFC-e, NFS-e, CT-e, MDF-e e demais documentos suportados.
O que esta seção cobre
- Listagem de documentos fiscais emitidos ou recebidos por período, com filtros por tipo (entradas/saídas) e identificador interno.
- Download do XML original e das representações gráficas (DANFE para NF-e, DANFCE para NFC-e, DACTE para CT-e).
- PDF consolidado reunindo múltiplos documentos em um único arquivo - ideal para auditorias e envios em lote.
- Download de arquivos de evento (carta de correção, cancelamento, manifestação, etc.) associados a um documento.
- Consulta por período para obter todos os arquivos XML de um intervalo.
- Consulta ao cadastro de contribuintes diretamente na SEFAZ.
- Status dos serviços da SEFAZ em cada UF, para diagnosticar indisponibilidades.
Casos de uso típicos
- Geração de relatórios fiscais internos.
- Auditoria e conciliação de movimentações.
- Download em lote para contabilidade.
- Integração de dados fiscais com o ERP.
- Monitoramento operacional da SEFAZ antes de transmitir.
Nota: O nível de detalhe retornado pode variar conforme o tipo de documento e o ambiente (homologação/produção).
Obter Notas Fiscais
Este método permite realizar a busca de documentos fiscais (NF-e, NFC-e, CT-e, NFS-e, entre outros) dentro de um período específico. A consulta pode ser filtrada por tipo de documento (entradas ou saídas) e, no caso de documentos de saída, também é possível pesquisar por um identificador interno associado.
O que este método faz?
Ele consulta a base de documentos fiscais da empresa e retorna uma lista consolidada contendo as principais informações de cada documento encontrado no intervalo informado.
Filtros disponíveis
- Período, Data inicial e final para busca.
- Tipo de documento, Entradas ou saídas.
- Identificador interno (opcional, apenas para saídas).
O que é retornado?
O método retorna uma lista de documentos, cada item contendo informações essenciais, como:
- Tipo do documento (NF-e, NFC-e, NFS-e, etc.).
- Número, série e chave.
- Emitente e destinatário.
- Datas relevantes.
- Valores principais.
- Situação atual (autorizado, cancelado, denegado, etc.).
Quando usar?
Utilize este endpoint para:
- Consultar documentos emitidos ou recebidos em um intervalo.
- Gerar relatórios internos.
- Cruzamento de informações fiscais.
- Auditoria e conferência de movimentações.
Nota: A quantidade e o nível de detalhes retornados podem variar conforme o tipo de documento e o ambiente de origem.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Obter Notas Fiscais › Request Body
TipoDocumentoFiscalTipo do documento fiscal a ser buscado.
Valores Possíveis:
0: Entradas
1: Saídas
DtInicioData inicial para o período da busca.
DtFimData final para o período da busca.
IndentificadorInternoBusca notas de saída que possuem o código interno informado.
Obter Notas Fiscais › Responses
Successful operation
Lista contendo as informações dos documentos fiscais encontrados.
ErrorDescrição de erro, caso a busca falhe.
AvisosLista de avisos ou mensagens informativas.
Consultar Lote NF-e
Consulta o estado de processamento de um lote de NF-e ou NFC-e transmitido via /EnviarNotaFiscalLote, identificado pelo CodLote retornado naquele endpoint.
Por que existe
O /EnviarNotaFiscalLote é assíncrono — a resposta HTTP apenas confirma o aceite do lote, e o resultado real chega no webhook nfe.lote.finalizado. Este endpoint serve como fallback de polling quando:
- O cliente ainda não configurou um webhook ativo (o lote continua sendo processado, mas não há notificação).
- O cliente perdeu o disparo do webhook (todas as 5 tentativas falharam) e precisa recuperar o estado.
- É necessário inspecionar o status do lote em uma interface de operação, sem depender da chegada do webhook.
Para fluxos com webhook configurado e estável, prefira esperar o disparo — evita polling desnecessário.
O que retorna
- O status agregado do lote (1–5), com a descrição textual em
DsStatusLote. - As contagens de
QtdTotal,QtdEmitida(autorizadas) eQtdErro(rejeitadas). - O detalhe de cada nota em
Notas[], com a chave de acesso (quando autorizada), o código/descrição do status SEFAZ e os totais — mesmo schema retornado por/EnviarNotaFiscal. - Em caso de falha no processamento do lote, a mensagem aparece em
erros[].descricao.
Escopo
- Apenas lotes de NF-e (modelo 55) ou NFC-e (modelo 65). Lotes de outros modelos não retornam por aqui.
- O lote precisa pertencer à empresa identificada pelo header
Token. Lotes de outras empresas retornamLote não encontradomesmo que oCodLoteexista.
Próximos passos
Este endpoint não retorna o XML nem o DANFE. Para baixar arquivos das notas autorizadas, use /ObterArquivoNotaFiscal passando a ChaveNF de cada item de Notas[].
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Consultar Lote NF-e › Request Body
CodLoteCódigo do lote retornado por /EnviarNotaFiscalLote no momento da transmissão. Identifica de forma única o lote dentro da empresa autenticada pelo header Token.
Consultar Lote NF-e › Responses
Successful operation
CodLoteEco do código do lote consultado.
StatusLoteStatus agregado do lote.
Valores Possíveis:
1: Aguardando salvar
2: Aguardando transmissão SEFAZ
3: Aguardando finalização
4: Lote finalizado
5: Lote finalizado com erro
DsStatusLoteDescrição textual do StatusLote.
QtdTotalQuantidade total de notas no lote (definida no momento da transmissão).
QtdEmitidaQuantidade de notas autorizadas pela SEFAZ (códigos de status 100 ou 150).
QtdErroQuantidade de notas que receberam resposta da SEFAZ mas não foram autorizadas (códigos diferentes de 100/150).
Detalhe de cada nota processada no lote.
Lista de erros ocorridos na consulta ou no processamento do lote.
avisosAvisos não-bloqueantes associados ao processamento do lote.
statusStatus agregado da resposta (0 quando OK; 2 quando há erros em erros).
Obter Arquivo da Nota Fiscal
Este método permite obter o arquivo de um documento fiscal, seja ele de entrada ou de saída. É possível solicitar tanto o XML original quanto a representação gráfica do documento, como DANFE (NF-e), DANFCE (NFC-e) ou DACTE (CT-e).
O que este método faz?
Ele recupera o arquivo correspondente à chave do documento informado ou, quando aplicável, consolida vários documentos em um único PDF.
Formas de consulta
- Chave única, Retorna o XML ou a representação gráfica do documento solicitado.
- Múltiplas chaves, Permite gerar um PDF unificado contendo diversos documentos, ideal para auditorias, armazenamento ou envios em lote.
Tipos de documentos suportados
- NF-e, XML original ou DANFE.
- NFC-e, XML ou DANFCE.
- CT-e, XML ou DACTE.
- Outros documentos, conforme disponibilidade na base.
Quando usar?
Este método é útil para:
- Recuperar documentos fiscais armazenados.
- Gerar PDFs consolidados para envio a clientes ou contabilidade.
- Baixar o XML oficial para validação, auditoria ou integração.
- Obter a versão gráfica para impressão ou visualização.
O que é retornado?
Dependendo da solicitação, a resposta pode incluir:
- O XML original do documento.
- O PDF individual da representação gráfica.
- Um PDF consolidado contendo vários documentos.
Nota: Para múltiplos documentos, o PDF unificado é retornado somente quando todos os documentos solicitados existirem na base.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Obter Arquivo da Nota Fiscal › Request Body
ChavesLista de chaves de acesso para buscar múltiplos documentos (Apenas para PDF).
ChaveNFChave de acesso do documento fiscal que se deseja obter.
FileTypeTipo do arquivo a ser retornado
Valores Possíveis:
1: XML
2: PDF
TipoDocumentoFiscalOrigem do documento.
Valores Possíveis:
0: Entrada
1: Saída
Base64LogoString em Base64 contendo a logo a ser inserida no PDF.
Caso não informado e o documento for emitido pela empresa será usado a logo do painel.
Obter Arquivo da Nota Fiscal › Responses
Successful operation
String em Base64 pura contendo o arquivo solicitado.
Obter Arquivo do Evento
Este método permite obter o arquivo de um evento específico associado a um documento fiscal, como uma Carta de Correção Eletrônica (CC-e).
A consulta é realizada utilizando dois identificadores principais:
- A chave do documento fiscal original (NF-e, CT-e, etc.).
- O protocolo do evento, que identifica de forma única o evento registrado na SEFAZ.
O que este método faz?
Ele recupera o arquivo correspondente ao evento informado, retornando:
- O XML do evento.
- A representação gráfica em PDF, quando disponível (ex.: CC-e, Cancelamento).
Quando usar?
Utilize este endpoint quando for necessário:
- Baixar a Carta de Correção enviada previamente.
- Recuperar qualquer evento associado ao documento para conferência.
- Gerar arquivos para contabilidade ou validações.
O que é retornado?
O método pode retornar:
- XML do evento.
- PDF da representação gráfica do evento.
Nota: É necessário fornecer tanto a chave do documento original quanto o protocolo do evento para garantir a identificação correta do registro na SEFAZ.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Obter Arquivo do Evento › Request Body
ChaveNFChave de acesso do documento fiscal que se deseja obter.
NuProtocoloNúmero do protocolo do evento que se deseja obter.
TipoArquivoTipo do arquivo do evento a ser retornado.
Valores Possíveis:
1: XML do evento
2: PDF da Carta de Correção (CC-e)
Obter Arquivo do Evento › Responses
Successful operation
String em Base64 pura contendo o arquivo solicitado.
Obter Arquivos por Período
Este método oferece um endpoint robusto para download em lote de documentos fiscais, permitindo obter arquivos em formato XML, PDF ou Excel conforme a necessidade da aplicação.
O pacote retornado pode incluir NF-e, NFC-e, NFS-e, CT-e, CT-e OS, MDF-e e DC-e, abrangendo tanto notas de saída (emitidas pela empresa) quanto notas de entrada/tomadas (recebidas de terceiros) - basta ajustar o filtro de tipo para retornar saídas, entradas ou ambos.
A consulta pode ser filtrada por diversos critérios, garantindo alta flexibilidade na extração dos documentos.
Filtros disponíveis
- Período, Data inicial e final da busca.
- Ambiente, Produção ou homologação.
- Tipo de documento, Saída, entrada ou ambos.
- CPFs/CNPJs específicos, Ideal para buscas direcionadas a clientes ou fornecedores.
O que este método faz?
Ele processa a busca dos documentos conforme os filtros enviados e gera um pacote consolidado contendo todos os arquivos encontrados.
Quando usar?
Este endpoint é ideal para:
- Extração fiscal em larga escala.
- Geração de relatórios periódicos.
- Auditorias e conferências contábeis.
- Processos de backup e armazenamento externo.
- Integrações que exigem recuperação rápida de múltiplos documentos.
Benefícios
- Alta performance para grandes volumes.
- Flexibilidade de filtros.
- Retorno consolidado em formato compacto.
- Padronização dos arquivos para múltiplos tipos de documentos.
Nota: O tamanho final do arquivo .zip pode variar conforme o volume de documentos retornados. Certifique-se de que o ambiente consumidor consiga manipular corretamente cadeias Base64 extensas.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Obter Arquivos por Período › Request Body
DtInicioData inicial para o período da busca.
DtFimData final para o período da busca.
TypeTipo do arquivo a ser retornado (Padrão: 1 - XML).
Valores Possíveis:
0: PDF
1: XML
2: EXCEL
TipoAmbienteTipo de ambiente (Padrão: 1 - Produção).
Valores Possíveis:
1: Produção
2: Homologação
TipoNotaTipo de nota a ser incluída (Padrão: 1 - Saídas).
Valores Possíveis:
1: Saídas
2: Entradas
3: Saídas e Entradas
ChavesLista de chaves de acesso para buscar documentos fiscais específicos.
cpfCnpjsLista de CPFs ou CNPJs dos clientes para filtrar as notas.
JuntarArquivosPDFSe verdadeiro, anexa todas as notas fiscais retornadas em um único arquivo PDF.
incluirCCeSe verdadeiro, inclui as cartas de correção emitidas no período.
aplicarPlanoAjustesSe verdadeiro, aplica o plano de ajustes de impostos (Padrão: true).
Obter Arquivos por Período › Responses
Successful operation
QuantidadeQuantidade de arquivos incluídos no pacote compactado.
Base64FilesCompactedString em Base64 contendo um arquivo .zip com todos os documentos solicitados ou arquivo excel (xlsx).
ErrorDescrição de erro, caso a operação falhe.
Lista de avisos ou mensagens informativas.
Consultar Cadastro SEFAZ
Este método realiza uma consulta ao Cadastro Centralizado de Contribuintes (CCC) da SEFAZ, permitindo verificar a situação cadastral de um contribuinte, pessoa física ou jurídica, em uma determinada Unidade Federativa.
A consulta pode ser realizada por CNPJ, CPF ou Inscrição Estadual (IE), oferecendo flexibilidade para validar informações fiscais de clientes, fornecedores ou parceiros comerciais.
Para que serve a consulta ao CCC?
Este endpoint é útil para:
- Verificar se o contribuinte está ativo, inapto, suspenso ou baixado.
- Confirmar dados cadastrais antes de emitir documentos fiscais.
- Evitar rejeições por irregularidades no cadastro do destinatário.
- Realizar auditorias e análises de conformidade fiscal.
O que é retornado?
A resposta pode incluir:
- Situação cadastral do contribuinte.
- UF de registro.
- Dados básicos associados ao CNPJ, CPF ou IE.
- Mensagens adicionais fornecidas pela SEFAZ.
Quando usar este método?
Utilize a consulta ao CCC sempre que for necessário garantir que:
- O destinatário esteja regular no cadastro estadual.
- A operação fiscal não será rejeitada por situação cadastral inválida.
- A empresa mantenha conformidade com as regras fiscais vigentes.
Nota: Nem todas as UFs possuem o mesmo grau de detalhamento no CCC. As informações retornadas podem variar conforme o estado consultado.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Consultar Cadastro SEFAZ › Request Body
ufSigla da Unidade Federativa onde a consulta será realizada.
cpfCnpjIeDocumento a ser consultado: CPF, CNPJ ou Inscrição Estadual.
Consultar Cadastro SEFAZ › Responses
Successful operation
statusStatus da consulta.
Valores Possíveis:
1: Sucesso
0: Erro ou Falha
cpfCnpjCPF ou CNPJ do contribuinte consultado.
cnaePrincipalCódigo CNAE principal do contribuinte.
ieInscrição Estadual.
ieAtualInscrição Estadual atual, em caso de alterações.
ieUnicaInscrição Estadual única.
dataInicioAtividadeData de início das atividades do contribuinte.
dataOcorrenciaBaixaData da baixa do cadastro, se houver.
dataUltimaAlteracaoCadastralData da última modificação no cadastro.
indicadorCredenciamentoCTeIndicador de credenciamento para emissão de Conhecimento de Transporte Eletrônico (CT-e).
Valores Possíveis:
1: Credenciado
0: Não Credenciado
indicadorCredenciamentoNFeIndicador de credenciamento para emissão de Nota Fiscal Eletrônica (NF-e).
Valores Possíveis:
1: Credenciado
0: Não Credenciado
situacaoCódigo da situação cadastral do contribuinte.
Valores Possíveis:
1: Habilitado
2: Suspenso
3: Baixado
4: Nulo
5: Outros
razaoSocialRazão Social do contribuinte.
nomeFantasiaNome Fantasia do contribuinte.
regimeApuracaoDescrição do regime de apuração de impostos (Ex: Simples Nacional, Regime Normal).
ufConsultadaUF em que a consulta foi realizada.
Objeto contendo os dados de endereço do contribuinte.
Objeto contendo os dados de contato do contribuinte.
Consultar Status SEFAZ
Este método verifica o status operacional dos serviços da SEFAZ (Secretaria da Fazenda) para um determinado modelo de documento fiscal e ambiente (produção ou homologação).
A consulta de status é essencial para identificar se os serviços da SEFAZ estão disponíveis, instáveis ou inoperantes antes de realizar transmissões de NF-e, NFC-e, MDF-e, CT-e e outros documentos.
Para que serve?
Este endpoint é útil para:
- Confirmar se os serviços da SEFAZ estão funcionando normalmente.
- Evitar tentativas de emissão durante períodos de indisponibilidade.
- Monitorar a estabilidade dos ambientes fiscais.
- Implementar rotinas automáticas de verificação antes de transmissões em massa.
O que é retornado?
A resposta geralmente inclui:
- Status do servidor (operante, instável ou indisponível).
- Motivo informado pela SEFAZ.
- Data e hora da última verificação.
- Informações complementares fornecidas pelo ambiente autorizador.
Quando usar este método?
Use este endpoint antes de:
- Emitir notas fiscais.
- Transmitir manifestos.
- Enviar documentos em lote.
- Inicializar rotinas automáticas de emissão.
Nota: A disponibilidade dos serviços da SEFAZ pode variar por UF e por modelo de documento, sendo recomendado consultar regularmente em sistemas que operam de forma contínua.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Consultar Status SEFAZ › Request Body
ModeloDocumentoCódigo do modelo do Documento Fiscal.
Valores Possíveis:
55: NF-e
58: MDF-e
57: CT-e
65: NFC-e
67: CT-e OS
TipoAmbienteIdentificação do Ambiente.
Valores Possíveis:
1: Produção
2: Homologação
Consultar Status SEFAZ › Responses
Successful operation
Objeto contendo as informações de status do serviço.
ErrorDescrição de erro, caso a consulta falhe.
AvisosLista de avisos não-bloqueantes da consulta (vazia em sucesso sem ressalvas).

