Fluxo - Cancelamento da NFS-e

O cancelamento permite ao contribuinte invalidar uma nota fiscal já autorizada, nos casos em que o serviço não foi realizado ou houve erro na emissão da NFS-e.

API's Essenciais 💡​

API's Opcionais 🥈

Etapas e API's

Para detalharmos melhor a operação, a separamos em tópicos, porém você consegue ver o fluxo completo aqui 📝.

1) Emitindo o Cancelamento

Da mesma maneira que no Envio Assíncrono da NFS-e, também precisamos nos atentar para termos um token de acesso válido.

Tendo ele em mãos devemos então utilizaremos o endpoint:

Com base nos campos do endpoint acima, devemos preparar o JSON com as informações e então realizar a chamada da API.

Prazo máximo para cancelamento!

2) Retorno da chamada

Conforme falamos no tópico anterior, o retorno da chamada da API variará de acordo com o status do documento na Prefeitura. É com base nesse retorno que entendemos o que deve ser feito após a emissão do mesmo.

Assim como no Envio Assíncrono, nele existem algumas informações que podem ser interessantes você guardar, como o id do documento criado em nossa base, pois são utilizados em outras APIs.

Com base no retorno podemos chegar a 2 cenários:

a) Cancelamento da NFC-e (Sucesso); b) Rejeição no Cancelamento.

a) Cancelamento da NFS-e (Sucesso)

Cenário de sucesso na chamada da API. Para isso devemos observar as seguintes informações:

  • status: Retorno Cancelado;

  • sucesso: Retorno true.

Veja no exemplo abaixo:

{
  "id": 1486
  ...
  "status": "Cancelado",
  "sucesso": true,
  ...
}

b) Rejeição no Cancelamento

Caso o cancelamento possua algum erro, iremos retornar para você o que ocorreu, seja por conta de validação interna ou por alguma validação da Prefeitura. Abaixo um exemplo de um retorno:

"Documento não localizado, ou com status diferente de autorizado."

Terminamos esta etapa 😁. Para seguir, basta selecionar a card abaixo.

Last updated

Was this helpful?