Treeunfe API B2C home pagelight logo
  1. Eventos de NFS-e
  2. Cancelar NFS-e
POST
/nfse/cancel
curl --request POST \
     --url https://api.treeunfe.com.br/api/v1/nfse/cancel \
     --header 'x-api-key: <api-key>' \
     --header 'x-api-key: <x_api_key>' \
     --header 'Content-Type: application/json' \
     --data '{
  "idDps": "<string>",
  "chaveAcesso": "<string>",
  "protocolo": "<string>",
  "cMotivo": 123.45,
  "xMotivo": "<string>"
}'

Cancela uma NFS-e autorizada. Notas em outros status não podem ser canceladas.

Identifique a nota por um destes campos: idDps, chaveAcesso ou protocolo. Veja o guia Cancelamento e substituição.

​
Autenticação

x-api-key
required
string

API Key da empresa.

​
Body

application/json

idDps
string

ID (UUID) da nota na Treeunfe (o nfseId da emissão).

chaveAcesso
string

Chave de acesso da NFS-e (44 a 60 dígitos).

protocolo
string

Protocolo / número da NFS-e.

cMotivo
required
number

Motivo: 1 = erro na emissão, 2 = serviço não prestado, 9 = outros.

xMotivo
required
string

Texto do motivo (15 a 255 caracteres).

​
Respostas

StatusDescrição
200NFS-e cancelada.
400Dados inválidos.
401x-api-key ausente ou inválida.
422Cancelamento recusado (nota não encontrada ou não elegível). Leia o motivo em error.
429Limite de requisições excedido.
curl -X POST "https://api.treeunfe.com.br/api/v1/nfse/cancel" \
  -H "x-api-key: SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "idDps": "123e4567-e89b-12d3-a456-426614174000",
    "cMotivo": 1,
    "xMotivo": "Erro na emissão da nota fiscal - dados do tomador incorretos"
  }'

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