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" }
 

CCe - Listagem de cartas de correção eletrônicas.

Retorna uma lista paginada de cartas de correção eletrônicas (CCe) associadas às NFes do emissor autenticado.

É possível filtrar por busca genérica (CNPJ, nome do destinatário, chave de acesso ou código ERP), por status da CCe e por intervalo de data do evento.

Os registros são ordenados por data de emissão em ordem decrescente (mais recente primeiro).

get

Query Parameters

buscastring

Campo de busca genérico: CNPJ e Nome do destinatário, Chave de acesso da NFe (44 dígitos) ou Código ERP.

statusstring

Status da carta de correção eletrônica (CC-e).

Allowed values:PendenteAutorizadaRejeitadaSubstituida

dataEventoCartaCorrecaoInicialstring(date-time)

Data inicial do intervalo do evento da CCe.

dataEventoCartaCorrecaoFinalstring(date-time)

Data final do intervalo do evento da CCe.

offsetinteger(int32)

Paginação da listagem - offset (padrão 1).

Default:1

limitinteger(int32)

Paginação da listagem - limit (padrão 10, máximo 100).

Default:10

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

ListarCartasCorrecaoViewModelListPaginationResponse

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

Dados de listagem de cartas de correção eletrônicas (CC-e).

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

CCe - Obter XML.

Obter o XML de uma Carta de Correção Eletrônica (CCe) previamente emitida.

get

Path Parameters

filtrostringrequired

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

sequenciainteger(int32)required

Número de sequência da carta de correção.

Headers

DocumentoEmissorstringrequired

Documento do emissor.

Response

OK

string
get/api/v1/Nfe/{filtro}/CartaCorrecao/{sequencia}/ObterXml