cronotaDocumentação da API

/invoices

Cria a nota e a coloca na fila de emissão (202, status queued). A empresa precisa do certificado A1 ativo e do município preenchido. Com replaces, a nota nova substitui uma autorizada: quando o Sefin a autoriza, cancela a antiga sozinho e o webhook invoice.substituted é enviado.

Server URLhttps://cronota.clowk.in/api/v1
POST/invoices

Autorização

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

Parâmetros

Idempotency-Keystring · headerobrigatório

Uma string única por operação (o id do pedido serve). Repetir a mesma key devolve o primeiro resultado, sem criar outro.

Request body

application/json, obrigatório

customer_idstringopcional

O tomador já cadastrado. Ou envie customer.

Formato uuid
customerobjectopcional

O tomador, achado pelo CNPJ ou CPF, ou criado.

documentstringobrigatório

CNPJ ou CPF, com ou sem pontuação.

namestringopcional
emailstringopcional
Formato email
amountstringobrigatório

Em reais, com ponto decimal.

descriptionstringobrigatório

Aceita as variáveis {mes_extenso}, {ano}, {mes}, {dia} e ± N, como {mes_extenso - 1}.

competencestringopcional

O mês da prestação, AAAA-MM. O padrão é o mês atual.

invoice_template_idstringopcional

Usa o serviço e os tributos do modelo.

Formato uuid
service_code_nationalstringopcional

Sem modelo, obrigatório: o código da lista nacional, 6 dígitos.

nbs_codestringopcional
replacesobjectopcional

Para substituir uma nota autorizada.

invoice_idstringobrigatório
Formato uuid
reason_codestringobrigatório

01 desenquadramento do Simples, 02 enquadramento, 03/04 imunidade ou isenção, 05 rejeição pelo tomador, 99 outros.

Um de 01, 02, 03, 04, 05, 99
reasonstringobrigatório

De 15 a 255 caracteres.

Respostas

202Na fila de emissão.
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
400POST sem `Idempotency-Key`.
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).

401Chave ausente, errada, revogada ou vencida.
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).

402O plano Grátis não inclui a API.
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).

422A nota não passou nas validações.
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).