Listar NFCe´s.

Fornece uma listagem detalhada das Notas Fiscais de Consumidor Eletrônicas (NFCe) 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.

get

Query Parameters

notaFiscalIdstring(uuid)

Filtrar pelo identificador único da nota fiscal no sistema.

codigoErpstring

Filtrar pelo código ERP.

buscastring

Filtrar pelo termo de busca genérica.

inscricaoEstadualEmissorstring

Filtrar pela inscrição estadual do emissor do documento.

numeroDocumentostring

Filtrar pelo número sequencial do documento fiscal.

seriestring

Filtrar pela série do documento fiscal.

chaveAcessoarray[string]

Filtrar pel lista de chaves de acesso (44 dígitos).

documentoParticipantestring

Filtrar pelo documento (CPF/CNPJ) do participante.

nomeParticipantestring

Filtrar pel nome ou razão social do participante.

dataEmissaoInicialstring(date-time)

Filtrar documentos emitidos a partir desta data.

dataEmissaoFinalstring(date-time)

Filtrar documentos emitidos até esta data.

dataCancelamentoInicialstring(date-time)

Filtrar documentos cancelados a partir desta data.

dataCancelamentoFinalstring(date-time)

Filtrar documentos cancelados até esta data.

valorDocumentoInicialnumber(double)

Filtrar pelo valor mínimo do documento.

valorDocumentoFinalnumber(double)

Filtrar pel valor máximo do documento.

statusstring

Status do documento eletrônico.

Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida

consumidorFinalboolean

Filtrar pelo indicador do documento emitido para consumidor final.

documentoTransportadorstring

Filtrar pelo documento (CPF/CNPJ) da transportadora.

nomeTransportadorstring

Filtrar pelo nome ou razão Social da transportadora.

modalidadeFretestring

Modalidade de frete.

Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte

documentoIntermediadorstring

Filtrar pelo documento (CPF/CNPJ) do intermediador.

identificadorIntermediadorstring

Filtrar pelo identificador do intermediador na plataforma.

modoContingenciaOfflineboolean

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.

ordenarPorstring

Campo pelo qual a listagem de notas fiscais será ordenada.

Allowed values:DataEmissaoSerieNumeracaoNomeDestinatario

ordemDecrescenteboolean

Define se a ordenação é decrescente. Padrão: true.

Default:true

offsetinteger(int32)

Paginação da listagem - offset.

Default:1

limitinteger(int32)

Paginação da listagem - limit.

Default:10

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ListarNotasFiscaisViewModelListPaginationResponse

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

Dados de listagem de notas fiscais eletrônicas (NFe e NFCe).

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

Resumo de NFCe´s.

Fornece dados totalizados e consolidados de notas fiscais de consumidor eletrônicas (NFCe) 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.

get

Query Parameters

notaFiscalIdstring(uuid)

Filtrar pelo identificador único da nota fiscal no sistema.

codigoErpstring

Filtrar pelo código ERP.

buscastring

Filtrar pelo termo de busca genérica.

inscricaoEstadualEmissorstring

Filtrar pela inscrição estadual do emissor do documento.

numeroDocumentostring

Filtrar pelo número sequencial do documento fiscal.

seriestring

Filtrar pela série do documento fiscal.

chaveAcessoarray[string]

Filtrar pel lista de chaves de acesso (44 dígitos).

documentoParticipantestring

Filtrar pelo documento (CPF/CNPJ) do participante.

nomeParticipantestring

Filtrar pel nome ou razão social do participante.

dataEmissaoInicialstring(date-time)

Filtrar documentos emitidos a partir desta data.

dataEmissaoFinalstring(date-time)

Filtrar documentos emitidos até esta data.

dataCancelamentoInicialstring(date-time)

Filtrar documentos cancelados a partir desta data.

dataCancelamentoFinalstring(date-time)

Filtrar documentos cancelados até esta data.

valorDocumentoInicialnumber(double)

Filtrar pelo valor mínimo do documento.

valorDocumentoFinalnumber(double)

Filtrar pel valor máximo do documento.

statusstring

Status do documento eletrônico.

Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida

consumidorFinalboolean

Filtrar pelo indicador do documento emitido para consumidor final.

documentoTransportadorstring

Filtrar pelo documento (CPF/CNPJ) da transportadora.

nomeTransportadorstring

Filtrar pelo nome ou razão Social da transportadora.

modalidadeFretestring

Modalidade de frete.

Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte

documentoIntermediadorstring

Filtrar pelo documento (CPF/CNPJ) do intermediador.

identificadorIntermediadorstring

Filtrar pelo identificador do intermediador na plataforma.

modoContingenciaOfflineboolean

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

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ObterTotalizacaoListagemViewModel

Dados totalizados da listagem de notas fiscais.

* Additional properties are NOT allowed.
quantidadeTotalNotasinteger(int32)

Quantidade total de notas.

quantidadeTotalNotasAprovadasinteger(int32)

Quantidade total de notas aprovadas.

quantidadeTotalNotasCanceladasinteger(int32)

Quantidade total de notas canceladas, em cancelamento ou inutilizadas.

quantidadeTotalNotasRejeitadasinteger(int32)

Quantidade total de notas rejeitadas.

quantidadeTotalNotasPendentesinteger(int32)

Quantidade total de notas pendentes de emissão.

quantidadeTotalNotasEmContingenciainteger(int32)

Quantidade total de notas geradas em contingência pendentes de transmissão.

quantidadeTotalNotasSubstituidasinteger(int32)

Quantidade total de notas substituidas por nota em contingencia devido a timed out na emissão.

valorTotalNotasnumber(double)

Valor total em notas fiscais.

valorTotalNotasAprovadasnumber(double)

Valor total de notas aprovadas.

valorTotalNotasCanceladasnumber(double)

Valor total de notas canceladas, em cancelamento ou inutilizadas.

valorTotalNotasRejeitadasnumber(double)

Valor total de notas rejeitadas.

valorTotalNotasPendentesnumber(double)

Valor total de notas pendentes de emissão.

valorTotalNotasEmContingencianumber(double)

Valor total de notas geradas em contingência pendentes de transmissão.

valorTotalNotasSubstituidasnumber(double)

Valor total de notas substituidas por nota em contingencia devido a timed out na emissão.

get/api/v1/Nfce/Resumo
 

Status da NFCe.

Retorna o status de uma nota fiscal de consumidor eletrônica (NFCe) 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.

get

Path Parameters

filtrostringrequired

Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ObterStatusFiscalViewModel

Dados fiscais de uma nota fiscal identificada pelo código ERP.

* Additional properties are NOT allowed.
codigoErpstring | null

Identificador da operação fiscal no ERP.

modelostring

Modelo de nota fiscal.

Allowed values:NfeNfce

seriestring | null

Série do documento fiscal.

numeroDocumentointeger(int64)

Número do documento fiscal.

chaveAcessostring | null

Chave de acesso do documento fiscal.

dataEmissaostring(date-time)

Data de emissão do documento fiscal.

naturezaOperacaostring | null

Natureza da operação.

tipoAmbientestring

Tipo de ambiente da SEFAZ.

Allowed values:ProducaoHomologacao

statusstring

Status do documento eletrônico.

Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida

ultimoCstatinteger | null(int32)

Último código de status retornado pela sefaz.

mensagemSefazstring | null

Última mensagem retornada pela SEFAZ.

qrcodeLinkstring | null

Link do QR Code da NFC-e.

protocoloAutorizacaostring | null

Protocolo de autorização emitido pela SEFAZ.

protocoloCancelamentostring | null

Protocolo de cancelamento emitido pela SEFAZ.

get/api/v1/Nfce/{filtro}/StatusFiscal
 

DANFE NFCe (PDF).

Recupera a representação gráfica da NFCe, 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.

get

Path Parameters

tipoDanfestringrequired

Tipo de danfe para NFCe.

Allowed values:Danfe56mmDanfe80mm

formatostringrequired

Formato do DANFE

Allowed values:HtmlPdf

filtrostringrequired

Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

string
get/api/v1/Nfce/{filtro}/ObterDanfe/{tipoDanfe}/{formato}
 

Obter XML (procNFCe).

Recupera o arquivo XML de distribuição da nota fiscal de consumidor 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 NF-e/NFCe 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.

get

Path Parameters

filtrostringrequired

Chave de acesso da nota fiscal (44 dígitos) ou Código ERP.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

string
get/api/v1/Nfce/{filtro}/ObterXml