Cancelar NFS-e
Solicita o cancelamento de uma NFS-e a partir do identificador interno da nota no ClickFin. Para NFS-e municipal, uma solicitação aceita fica com status cancelling até o webhook do PlugNotas confirmar CANCELADO e então passa para cancelled. Uma nova solicitação durante esse processamento ou após a confirmação retorna sucesso sem reenviar o pedido ao provedor. Se a PlugNotas ainda não considerar a NFS-e CONCLUIDO, a solicitação é recusada e o status permanece issued, permitindo nova tentativa posterior. Se a PlugNotas retornar erro transitório ou resultado incerto (por exemplo, 408, 429 ou 5xx), a API responde 503 com SERVICE_INVOICE.CANCEL_FAILED e conserva a reserva de cancelamento. Uma repetição não reenvia o cancelamento até a confirmação ou conciliação do resultado com o provedor. Uma rejeição definitiva (4xx exceto 408/429) devolve a nota para issued e retorna 400 SERVICE_INVOICE.CANCEL_FAILED. Para NFS-e nacional, a nota é reservada em cancelling antes do envio à SEFIN. Uma rejeição definitiva da SEFIN (4xx exceto 408/429) devolve a nota para issued e retorna 400 SERVICE_INVOICE.NATIONAL_CANCEL_FAILED; um resultado incerto (5xx, 408, 429, falha de rede) retorna 502 SERVICE_INVOICE.NATIONAL_CANCEL_FAILED e mantém a reserva (fail-closed intencional): repetições respondem "Service invoice cancellation is already being processed." sem reenviar o evento. Requer perfil de administrador. Para NFS-e nacional, se a SEFIN já tiver aceitado o cancelamento mas a geração dos documentos locais falhar, uma nova chamada reconcilia os artefatos sem reenviar o evento de cancelamento à SEFIN. O motivo é normalizado sem espaços nas extremidades. Para NFS-e nacional, o motivo normalizado deve ter entre 15 e 255 caracteres.
service_invoices:writeParâmetros
- serviceInvoiceIdpath
Sem descrição disponível.
Respostas
Solicitação de cancelamento aceita, em processamento ou já confirmada.
Erro de validação nos parâmetros da consulta.
Token ausente, inválido ou sem empresa selecionada.
Falha de autorização.
Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.
Erro de regra de negócio ou integração.
Erro de regra de negócio ou integração.