Listar NFe´s.
Fornece uma listagem detalhada das Notas Fiscais Eletrônicas (NFe) emitidas ou processadas pelo Emissor.
🔍 CAPACIDADE DE BUSCA: O recurso suporta filtros complexos que permitem a extração de relatórios e a reconciliação fiscal. O campo busca realiza uma varredura genérica em múltiplos campos (número, série, chave e participantes).
📑 PAGINAÇÃO: A API utiliza o modelo de offset e limit. Recomendamos o uso de limites baixos (ex: 50 registros) para garantir a performance da resposta e economia de banda.
⚖️ CONTEXTO FISCAL: Os resultados refletem o estado atual dos documentos na base da Stone Tax, permitindo filtrar por status específicos (Autorizada, Cancelada, Rejeitada, etc.) e intervalos de valores ou datas.
Query Parameters
Filtrar pelo identificador único da nota fiscal no sistema.
Filtrar pelo código ERP.
Filtrar pelo termo de busca genérica.
Filtrar pela inscrição estadual do emissor do documento.
Filtrar pelo número sequencial do documento fiscal.
Filtrar pela série do documento fiscal.
Filtrar pel lista de chaves de acesso (44 dígitos).
Filtrar pelo documento (CPF/CNPJ) do participante.
Filtrar pel nome ou razão social do participante.
Filtrar documentos emitidos a partir desta data.
Filtrar documentos emitidos até esta data.
Filtrar documentos cancelados a partir desta data.
Filtrar documentos cancelados até esta data.
Filtrar pelo valor mínimo do documento.
Filtrar pel valor máximo do documento.
Status do documento eletrônico.
Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida
Filtrar pelo indicador do documento emitido para consumidor final.
Filtrar pelo documento (CPF/CNPJ) da transportadora.
Filtrar pelo nome ou razão Social da transportadora.
Modalidade de frete.
Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte
Filtrar pelo documento (CPF/CNPJ) do intermediador.
Filtrar pelo identificador do intermediador na plataforma.
Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.
Campo pelo qual a listagem de notas fiscais será ordenada.
Allowed values:DataEmissaoSerieNumeracaoNomeDestinatario
Define se a ordenação é decrescente. Padrão: true.
Default:true
Paginação da listagem - offset.
Default:1
Paginação da listagem - limit.
Default:10
Headers
Documento do emissor.
Response
Response
OK
ListarNotasFiscaisViewModelListPaginationResponse
Dados de listagem de notas fiscais eletrônicas (NFe e NFCe).
Show Child Parameters
Authentication
Query Parameters
Headers
Resumo de NFe´s.
Fornece dados totalizados e consolidados de notas fiscais com base nos filtros aplicados.
Este recurso é ideal para alimentar dashboards, painéis de conferência ou indicadores financeiros (KPIs),
permitindo uma visão macro do volume de documentos e valores sem a necessidade de processar a listagem completa.
A consulta suporta múltiplos critérios de filtragem, abrangendo desde dados básicos do documento (número, série, chave)
até informações de atores envolvidos (participante, transportador e intermediador).
🔍 DICA DE PERFORMANCE: Para consultas em grandes volumes de dados, priorize o uso da Chave de Acesso
ou o intervalo de Data de Emissão para garantir maior agilidade no retorno.
Query Parameters
Filtrar pelo identificador único da nota fiscal no sistema.
Filtrar pelo código ERP.
Filtrar pelo termo de busca genérica.
Filtrar pela inscrição estadual do emissor do documento.
Filtrar pelo número sequencial do documento fiscal.
Filtrar pela série do documento fiscal.
Filtrar pel lista de chaves de acesso (44 dígitos).
Filtrar pelo documento (CPF/CNPJ) do participante.
Filtrar pel nome ou razão social do participante.
Filtrar documentos emitidos a partir desta data.
Filtrar documentos emitidos até esta data.
Filtrar documentos cancelados a partir desta data.
Filtrar documentos cancelados até esta data.
Filtrar pelo valor mínimo do documento.
Filtrar pel valor máximo do documento.
Status do documento eletrônico.
Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida
Filtrar pelo indicador do documento emitido para consumidor final.
Filtrar pelo documento (CPF/CNPJ) da transportadora.
Filtrar pelo nome ou razão Social da transportadora.
Modalidade de frete.
Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte
Filtrar pelo documento (CPF/CNPJ) do intermediador.
Filtrar pelo identificador do intermediador na plataforma.
Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.
Headers
Documento do emissor.
Response
Response
OK
ObterTotalizacaoListagemViewModel
Dados totalizados da listagem de notas fiscais.
Quantidade total de notas.
Quantidade total de notas aprovadas.
Quantidade total de notas canceladas, em cancelamento ou inutilizadas.
Quantidade total de notas rejeitadas.
Quantidade total de notas pendentes de emissão.
Quantidade total de notas geradas em contingência pendentes de transmissão.
Quantidade total de notas substituidas por nota em contingencia devido a timed out na emissão.
Valor total em notas fiscais.
Valor total de notas aprovadas.
Valor total de notas canceladas, em cancelamento ou inutilizadas.
Valor total de notas rejeitadas.
Valor total de notas pendentes de emissão.
Valor total de notas geradas em contingência pendentes de transmissão.
Valor total de notas substituidas por nota em contingencia devido a timed out na emissão.
Authentication
Query Parameters
Headers
Status da NFe.
Retorna o status de uma nota fiscal identificada pelo código ERP ou chave de acesso.
🔍 IDENTIFICAÇÃO: O filtro aceita a chave de acesso da nota fiscal (44 dígitos numéricos) ou o código ERP informado pelo integrador no momento da emissão.
📋 RETORNO: Inclui modelo, série, número, chave de acesso, status, protocolos de autorização/cancelamento e mensagem da SEFAZ.
Path Parameters
Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.
Headers
Documento do emissor.
Response
Response
OK
ObterStatusFiscalViewModel
Dados fiscais de uma nota fiscal identificada pelo código ERP.
Identificador da operação fiscal no ERP.
Modelo de nota fiscal.
Allowed values:NfeNfce
Série do documento fiscal.
Número do documento fiscal.
Chave de acesso do documento fiscal.
Data de emissão do documento fiscal.
Natureza da operação.
Tipo de ambiente da SEFAZ.
Allowed values:ProducaoHomologacao
Status do documento eletrônico.
Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida
Último código de status retornado pela sefaz.
Última mensagem retornada pela SEFAZ.
Link do QR Code da NFC-e.
Protocolo de autorização emitido pela SEFAZ.
Protocolo de cancelamento emitido pela SEFAZ.
Authentication
Path Parameters
Headers
DANFE NFe (PDF).
Recupera a representação gráfica da NFe, conhecida como DANFE (Documento Auxiliar da Nota Fiscal Eletrônica).
📄 FORMATO DE SAÍDA: O recurso retorna o arquivo em formato PDF, codificado em Base64. Para a visualização, o sistema consumidor deve realizar o decode da string e salvar o binário com a extensão .pdf.
⚖️ VALIDADE JURÍDICA: O DANFE é apenas um documento auxiliar para facilitar a consulta e o transporte das mercadorias. Ele não substitui o arquivo XML, que é o documento fiscal eletrônico de existência apenas digital e valor jurídico real.
🧪 TESTE: Em ambiente de sandbox, o DANFE gerado conterá a marca d’água “SEM VALOR FISCAL - AMBIENTE DE HOMOLOGAÇÃO”, conforme exigência da SEFAZ para testes.
🔍 DISPONIBILIDADE: O documento só poderá ser gerado para chaves de acesso que possuam o status de Autorizada ou Cancelada na base de dados.
Path Parameters
Tipo de danfe para NFe.
Allowed values:RetratoSimplificado
Formato do DANFE
Allowed values:HtmlPdf
Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.
Headers
Documento do emissor.
Response
Response
OK
Authentication
Path Parameters
Headers
Notas Fiscais - Obter XML (procNFe).
Recupera o arquivo XML de distribuição da nota fiscal eletrônica. Este é o documento oficial com validade jurídica, contendo o protocolo de autorização da SEFAZ.
⚖️ GUARDA FISCAL: Conforme a legislação vigente, o emitente e o destinatário devem manter os arquivos digitais das NFe pelo prazo decadencial estabelecido na lei tributária (geralmente 5 anos), sendo este endpoint a ferramenta ideal para o download e arquivamento.
🛠️ ESTRUTURA: O retorno consiste no XML completo, incluindo as tags de assinatura digital e o nó protNFe (Protocolo de Autorização), caracterizando o documento como processado e apto para a escrituração contábil.
🧪 TESTE: Em ambiente de homologação, o XML retornado possui as tags de ambiente identificadas como tpAmb = 2, indicando que o documento não possui validade comercial ou fiscal.
Path Parameters
Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.
Headers
Documento do emissor.
Response
Response
OK