cronotaDocumentação da API

/invoices/{id}/cancel

Envia o evento de cancelamento ao Sefin e responde a nota em cancelled. O prazo para cancelar é definido pelo município; fora dele o Sefin recusa (cancel_refused).

Server URLhttps://cronota.clowk.in/api/v1
POST/invoices/{id}/cancel

Autorização

Bearer token: sk_live_… (Live) ou sk_test_… (Sandbox). A chave define a empresa e o ambiente.

Parâmetros

idstring · pathobrigatório

O id do recurso.

Request body

application/json, obrigatório

reasonstringobrigatório

O motivo, com pelo menos 15 caracteres.

reason_codestringopcional

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

Um de 1, 2, 9Padrão 9

Respostas

200Cancelada.
idstringopcional
Formato uuid
objectstringopcional
livemodebooleanopcional
statusstringopcional
Um de queued, sending, unknown, authorized, rejected, cancelled, substituted, pending_approval, blocked_plan, draft, imported
amountstringopcional
competencestringopcional
descriptionstringopcional
customer_idstring | nullopcional
Formato uuid
template_idstring | nullopcional
Formato uuid
nfse_numberstring | nullopcional
access_keystring | nullopcional

A chave de acesso de 50 dígitos.

dpsobject | nullopcional
seriesstringopcional
numberintegeropcional
pdf_readybooleanopcional
errorsobject[]opcional

Os erros do Sefin, numa nota rejeitada.

codestringopcional
messagestringopcional
sefin_codestringopcional
issued_atstring | nullopcional
Formato date-time
cancelled_atstring | nullopcional
Formato date-time
replaces_invoice_idstring | nullopcional

A nota que esta substitui.

Formato uuid
substituted_atstring | nullopcional
Formato date-time
public_urlstring | nullopcional

O link público da nota (PDF e XML, sem login), válido por 7 dias. Só em notas da API e de integrações.

Formato uri
public_url_expires_atstring | nullopcional
Formato date-time
created_atstringopcional
Formato date-time
422O Sefin recusou, ou o motivo é curto.
errorobjectopcional
codestringopcional

Estável, para o seu código decidir.

messagestringopcional

Para pessoas, em português.

fieldsobjectopcional

Nos 422 de validação: as mensagens de cada campo, com os nomes que a API recebe (como address.street).