cronotaDocumentação da API

/templates/{id}/invoices

O atalho mais comum: o modelo já tem o serviço, os tributos, o valor e a descrição. Todos os campos são opcionais e, quando vazios, vêm do modelo.

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

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.

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, opcional

customerobjectopcional

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

documentstringobrigatório

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

namestringopcional
emailstringopcional
Formato email
amountstringopcional

Em reais, com ponto: "149.90". Sem ele, o valor do modelo.

competencestringopcional

AAAA-MM. Sem ele, o mês atual.

descriptionstringopcional

Sem ela, a descrição do modelo. Aceita as variáveis {mes_extenso}, {ano} e outras.

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
404Não existe nesta empresa e ambiente.
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).