cronotaDocumentação da API

/templates

Um modelo guarda o serviço, os tributos, a descrição (com variáveis como {mes_extenso} e {ano}) e, se quiser, o tomador e o valor fixos. O município do serviço, sem service_municipality_code, é o da empresa.

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

Autorização

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

Request body

application/json, obrigatório

namestringobrigatório
customer_idstring | nullopcional

Tomador fixo (desta empresa). Sem ele, escolhido em cada nota.

Formato uuid
amountstring | nullopcional

Em reais, com ponto. Sem ele, informado em cada nota.

service_code_nationalstringobrigatório

Código de tributação nacional (cTribNac), 6 dígitos, com ou sem pontos.

service_code_municipalstringopcional

Código municipal, se o município usa.

nbs_codestringopcional

Item da NBS.

service_municipality_codestringopcional

IBGE do local da prestação. Sem ele, o município da empresa.

descriptionstringobrigatório

A descrição do serviço. Aceita {mes}, {mes_extenso}, {ano}, {dia} e ± N, como {mes_extenso - 1}.

complementstringopcional

Informações complementares (xInfComp).

issobjectopcional

Tributação municipal, com os nomes da DPS: tribISSQN, tpRetISSQN, pAliq, pTotTribSN…

ibscbsobjectopcional

IBS/CBS, com os nomes da DPS: CST, cClassTrib, cIndOp, indDest.

federalobjectopcional

Tributos federais: CST, pAliqPis, pAliqCofins, vRetIRRF, vRetCSLL, vRetCP…

tax_totalsobjectopcional

Valor aproximado dos tributos (Lei 12.741): mode (money, percent, sn, none) e os valores.

intermediaryobjectopcional

Intermediário do serviço, quando há.

Respostas

201O modelo.
idstringopcional
Formato uuid
objectstringopcional
namestringopcional
service_code_nationalstringopcional
amountstring | nullopcional

Em reais; null quando o valor é informado na hora.

customer_idstring | nullopcional
Formato uuid
service_code_municipalstring | nullopcional
nbs_codestring | nullopcional
service_municipality_codestring | nullopcional
descriptionstringopcional
complementstring | nullopcional
issobjectopcional
ibscbsobjectopcional
federalobjectopcional
tax_totalsobjectopcional
intermediaryobjectopcional
created_atstringopcional
Formato date-time
updated_atstringopcional
Formato date-time
404O `customer_id` não é desta empresa.
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).

422Não passou nas validações: `fields` diz o que falta em cada campo.
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).