/schedules
O modelo precisa ter tomador e valor fixos. Na data, o Cronota cria a nota e emite (mode: auto) ou espera a sua aprovação por e-mail (approve). Um agendamento ativo em Live conta no plano: no Grátis, 1.
https://cronota.clowk.in/api/v1/schedulesAutorização
Bearer token: sk_live_… (Live) ou sk_test_… (Sandbox). A chave define a empresa e o ambiente.
Request body
application/json, obrigatório
template_idstringobrigatórioUm modelo com tomador e valor fixos.
frequencystringobrigatóriomonthly usa day_of_month; weekly, weekday; custom, cron.
day_of_monthintegeropcional1 a 31. Em meses menores, o último dia.
weekdayintegeropcional0 (domingo) a 6 (sábado).
cronstringopcionalCinco campos, no fuso da empresa.
weekend_rulestringopcionalSe a data cair no fim de semana. Padrão next_business_day.
competence_rulestringopcionalA competência da nota: o mês da emissão ou o anterior.
modestringopcionalauto emite; approve espera a sua aprovação por e-mail.
starts_onstringopcionalSem ele, hoje.
ends_onstring | nullopcionalSem ele, não termina.
Respostas
201O agendamento, com `next_run_on`.
idstringopcionalobjectstringopcionallivemodebooleanopcionaltemplate_idstringopcionalactivebooleanopcionalfrequencystringopcionalday_of_monthinteger | nullopcionalweekdayinteger | nullopcionalcronstring | nullopcionalweekend_rulestringopcionalcompetence_rulestringopcionalmodestringopcionalstarts_onstringopcionalends_onstring | nullopcionalnext_run_onstring | nullopcionalA próxima emissão.
skippedbooleanopcionalA próxima data foi pulada.
created_atstringopcionalupdated_atstringopcional402O plano Grátis não inclui a API.
errorobjectopcionalcodestringopcionalEstável, para o seu código decidir.
messagestringopcionalPara pessoas, em português.
fieldsobjectopcionalNos 422 de validação: as mensagens de cada campo, com os nomes que a API recebe (como address.street).
404Não existe nesta empresa e ambiente.
errorobjectopcionalcodestringopcionalEstável, para o seu código decidir.
messagestringopcionalPara pessoas, em português.
fieldsobjectopcionalNos 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.
errorobjectopcionalcodestringopcionalEstável, para o seu código decidir.
messagestringopcionalPara pessoas, em português.
fieldsobjectopcionalNos 422 de validação: as mensagens de cada campo, com os nomes que a API recebe (como address.street).