Operações (playground)
Cancelar nota
POST
Registra o evento de cancelamento na SEFIN. Irreversível. Só nota autorizada.
bearerheader
AutorizaçãoBearer <token>Token gerado no painel (Integrações → Tokens de API), começa com nf_
id*integerid da nota no nfse-digital
Faixa
1 <= valueapplication/json- body
reason*stringValue in
"erro_emissao""servico_nao_prestado""outros"description*stringjustificativa
Tamanho
15 <= length <= 255confirm_production?booleanobrigatório true para nota de produção
Padrão
falseCancelada
application/json- response
id*integeridempotency_key?stringstatus*InvoiceStatusValue in
"pending""authorized""rejected""cancelled"status_label*stringenvironment*EnvironmentValue in
"homologation""production"dps_series*stringdps_number*integernfse_number?stringnúmero da NFS-e (autorizada)
access_key?stringchave de acesso de 50 dígitos (autorizada)
amount*stringponto decimal, duas casas
competence?stringFormato
dateissued_at?stringFormato
date-timecustomer_id*integertemplate_id*integerdescription*stringerror_code?stringcódigo da SEFIN (rejeitada)
message?stringerro da SEFIN traduzido, ou aviso de resposta pendente
curl -X POST 'https://nfse.bassi.engineer/api/v1/invoices/1/cancel' \ -H 'Content-Type: application/json' \ -d '{ "reason": "erro_emissao", "description": "Valor da fatura informado errado"}'Exemplo de resposta
{ "id": 0, "idempotency_key": "string", "status": "pending", "status_label": "string", "environment": "homologation", "dps_series": "string", "dps_number": 0, "nfse_number": "string", "access_key": "string", "amount": "string", "competence": "2019-08-24", "issued_at": "2019-08-24T14:15:22Z", "customer_id": 0, "template_id": 0, "description": "string", "error_code": "string", "message": "string"}