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.

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/Nfe/{filtro}/StatusFiscal
 

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.

get

Path Parameters

tipoDanfestringrequired

Tipo de danfe para NFe.

Allowed values:RetratoSimplificado

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/Nfe/{filtro}/ObterDanfe/{tipoDanfe}/{formato}
 

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.

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/Nfe/{filtro}/ObterXml
 

Cancelamento de NFe.

Registra um Evento de Cancelamento para uma nota fiscal eletrônico (NFe). Esta operação invalida a existência jurídica do documento perante a SEFAZ.

⚠️ NOTAS REJEITADAS: Caso o documento fiscal esteja com status de Rejeitado, o processo de cancelamento nesta API acionará automaticamente a Inutilização de Numeração. Isso garante que a sequência numérica do emissor permaneça íntegra e em conformidade com as normas da SEFAZ, evitando “buracos” na numeração fiscal.

⏳ PRAZO LEGAL: O cancelamento deve respeitar o prazo regulamentar definido pela legislação estadual vigente (geralmente 24h para NFe). Após este período, a operação poderá exigir procedimentos administrativos ou estar sujeita a penalidades por cancelamento extemporâneo.

📄 CONDIÇÃO DE USO: Só é possível cancelar uma nota que tenha sido Autorizada ou Rejeitada (via inutilização), e cujo Fato Gerador (saída da mercadoria) ainda não tenha ocorrido.

🧪 TESTE: Em ambiente de homologação, o cancelamento é processado junto aos servidores de teste, permitindo validar a estrutura da justificativa (mínimo 15 caracteres) e o comportamento da inutilização para números rejeitados.

post

Path Parameters

filtrostringrequired

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

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Body

Dados para o cancelamento da nota fiscal.

CancelarNotaFiscalInputModel

Dados para cancelamento de nota fiscal (NFe ou NFCe).

* Additional properties are NOT allowed.
justificativastringrequired

Justificativa do cancelamento. (Mínimo de 15 caracteres)

>= 15 characters<= 255 characters

Response

No Content

post/api/v1/Nfe/{filtro}/Cancelar

Body

{ "justificativa": "justificativa" }
 

NFe - Carta de Correção Eletrônica (CCe).

Registra um Evento de Carta de Correção Eletrônica (CCe) para uma NFe autorizada. Permite corrigir informações acessórias do documento fiscal perante a SEFAZ.

⚠️ RESTRIÇÃO: A CCe é suportada exclusivamente para NFe (modelo 55). Não é aplicável para NFC-e.

❌ VEDAÇÕES LEGAIS: Não é permitido utilizar a CCe para corrigir: dados que impliquem mudança no remetente ou destinatário, data de emissão, data de saída, valor total da NFe, base de cálculo, alíquotas e quantidades de mercadorias.

🔢 SEQUÊNCIA: Cada CCe possui um número de sequência gerado automaticamente. Podem ser emitidas múltiplas CCes para a mesma NFe, sendo que a mais recente prevalece sobre as anteriores para os campos corrigidos.

🧪 TESTE: Em ambiente de homologação, a CCe é transmitida para os servidores de teste da SEFAZ, permitindo validar a estrutura e o conteúdo da correção.

post

Path Parameters

filtrostringrequired

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

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Body

Dados para emissão da carta de correção.

EmitirCartaDeCorrecaoInputModel

Dados para emissão de carta de correção de nota fiscal (NF-e).

* Additional properties are NOT allowed.
descricaoCorrecaostringrequired

Descrição da correção. (Mínimo de 15 e máximo de 1000 caracteres)

>= 15 characters<= 1000 characters

Response

No Content

post/api/v1/Nfe/{filtro}/CartaCorrecao/Enviar

Body

{ "descricaoCorrecao": "descricaoCorrecao" }