cronotaDocumentação da API

/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.

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

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

template_idstringobrigatório

Um modelo com tomador e valor fixos.

Formato uuid
frequencystringobrigatório

monthly usa day_of_month; weekly, weekday; custom, cron.

Um de monthly, weekly, custom
day_of_monthintegeropcional

1 a 31. Em meses menores, o último dia.

weekdayintegeropcional

0 (domingo) a 6 (sábado).

cronstringopcional

Cinco campos, no fuso da empresa.

weekend_rulestringopcional

Se a data cair no fim de semana. Padrão next_business_day.

Um de next_business_day, same_day, previous_business_day
competence_rulestringopcional

A competência da nota: o mês da emissão ou o anterior.

Um de same_month, previous_month
modestringopcional

auto emite; approve espera a sua aprovação por e-mail.

Um de auto, approve
starts_onstringopcional

Sem ele, hoje.

Formato date
ends_onstring | nullopcional

Sem ele, não termina.

Formato date

Respostas

201O agendamento, com `next_run_on`.
idstringopcional
Formato uuid
objectstringopcional
livemodebooleanopcional
template_idstringopcional
Formato uuid
activebooleanopcional
frequencystringopcional
Um de monthly, weekly, custom
day_of_monthinteger | nullopcional
weekdayinteger | nullopcional
cronstring | nullopcional
weekend_rulestringopcional
competence_rulestringopcional
modestringopcional
Um de auto, approve
starts_onstringopcional
Formato date
ends_onstring | nullopcional
Formato date
next_run_onstring | nullopcional

A próxima emissão.

Formato date
skippedbooleanopcional

A próxima data foi pulada.

created_atstringopcional
Formato date-time
updated_atstringopcional
Formato date-time
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).

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).

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).