1. Guias de NFS-e
  2. Cancelamento e substituição de NFS-e

​
Cancelamento

POST /nfse/cancel cancela uma NFS-e autorizada. Notas em outros status não podem ser canceladas.

Identifique a nota por um destes campos:

CampoDescrição
idDpsID da nota na Treeunfe (o nfseId devolvido na emissão).
chaveAcessoChave de acesso da NFS-e (44 a 60 dígitos).
protocoloProtocolo / número da NFS-e.

E informe o motivo:

CampoDescrição
cMotivo1 = erro na emissão, 2 = serviço não prestado, 9 = outros.
xMotivoTexto do motivo, de 15 a 255 caracteres.
{
  "idDps": "123e4567-e89b-12d3-a456-426614174000",
  "cMotivo": 1,
  "xMotivo": "Erro na emissão da nota fiscal - dados do tomador incorretos"
}

Resposta:

{
  "outcome": "SUCCESS",
  "chaveAcesso": "41152002223903417000160000000000009026036350469270",
  "protocolo": "NFS41152002223903417000160000000000009026036350469270"
}

Se a nota não for encontrada ou não puder ser cancelada, a API responde 422 com outcome: "FAILED" e o motivo em error.

​
Substituição

POST /nfse/substitute troca uma NFS-e autorizada por uma nova, numa única requisição: a Treeunfe copia a nota original, aplica as correções e emite a substituta.

Informe a nota original por originalDpsId ou chaveAcesso, junto com os campos que mudaram:

{
  "originalDpsId": "123e4567-e89b-12d3-a456-426614174000",
  "vServ": 250
}

Use a substituição quando o serviço foi prestado, mas a nota saiu com dado errado. Se o serviço não foi prestado, cancele.

​
Status divergente

Se a situação da nota na Treeunfe não bate com a da SefIN Nacional (por exemplo, cancelada lá e autorizada aqui), use Sincronizar com a SefIN. A Treeunfe consulta a nota, atualiza o status e gera de novo o PDF.