Emissão de NFS-e

Cancela uma NFS-e autorizada

Evento de cancelamento no Sistema Nacional. Devolve a nota atualizada, com status cancelada e o protocolo em cancelamento.

post/v1/nfse/{id}/cancelamento

Request

  • Base URL: https://api.sudrel.com.br/api
  • URL: https://api.sudrel.com.br/api/v1/nfse/{id}/cancelamento
  • Auth: HTTP bearer

Path parameters

idstring required

Id Sudrel da nota, a sua referencia ou a chave de acesso.

Query parameters

empresa_idstring

Só quando a mesma referencia existe em duas empresas.

Request body

motivo'erro_emissao' | 'servico_nao_prestado' | 'outros' required
justificativastring required

Response

Cancelada.

idstring
referenciastring nullable
status'transmitindo' | 'autorizada' | 'rejeitada' | 'cancelada' | 'falha_transmissao' | 'descartada' | 'aguardando_confirmacao'
empresa_idstring
ambiente'producao' | 'sandbox'

sandbox = emitida com chave de teste, no ambiente de testes do Sistema Nacional, sem valor fiscal.

simulacaostring nullable

Cenário do simulador de falhas (X-Sudrel-Simular); null em nota de verdade. Nota simulada nunca foi à Sefin.

origem'api' | 'planilha' | 'manual' | 'monitoramento'
numerostring nullable
chave_acessostring nullable
valorstring

Texto decimal com ponto, sem separador de milhar. Número JSON é recusado (422 tipo_invalido).

tomadorobject
retencoesobject
apuracao_propriaobject
issobject
recuperada_emstring date-time nullable
regras_versaostring

Versões do catálogo de correções automáticas e do catálogo de regras de campo que decidiram esta nota, nessa ordem.

criada_emstring date-time
atualizada_emstring date-time

Example response

{
  "valor": "1500.00",
  "servico": {
    "competencia": "2026-10"
  },
  "rejeicao": {
    "explicacao": {
      "codigo": "inscricao_municipal_obrigatoria",
      "campo": "/prestador/inscricao_municipal"
    }
  },
  "confirmacao": {
    "competencia": "2026-09"
  },
  "ajustes": [
    {
      "campo": "/prestador/inscricao_municipal",
      "regra": "correcao.E0120"
    }
  ],
  "regras_versao": "2026-09-30.1+2026-10-02.1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.