Skip to main content
POST
Create a deadline

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json

JSON request payload.

color
string
obrigatório

Hex color used to identify the deadline.

Exemplo:

"#FF5733"

dueDate
string<date-time>
obrigatório

Date and time when the deadline is due.

Exemplo:

"2026-03-31T23:59:59Z"

frequency
string
obrigatório

Deadline recurrence frequency.

Exemplo:

"monthly"

name
string
obrigatório

Human-readable deadline name.

Exemplo:

"Monthly Regulatory Report"

type
string
obrigatório

Deadline category.

Exemplo:

"regulatory"

active
boolean

Whether the deadline is active.

Exemplo:

true

description
string

Optional deadline description.

Exemplo:

"Monthly regulatory compliance report"

monthsOfYear
integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Exemplo:
notifyDaysBefore
integer<int64>

Days before the due date when notifications begin.

Exemplo:

5

templateId
string

Template used to generate the deadline report.

Exemplo:

"00000000-0000-0000-0000-000000000001"

Resposta

Created

active
boolean

Whether the deadline is active.

Exemplo:

true

color
string

Hex color used to identify the deadline.

Exemplo:

"#FF5733"

createdAt
string<date-time>

Date and time when the deadline was created.

Exemplo:

"2026-01-01T00:00:00Z"

deliveredAt
string<date-time>

Date and time when the deadline was delivered.

Exemplo:

"2026-03-15T10:00:00Z"

description
string

Optional deadline description.

Exemplo:

"Monthly regulatory compliance report"

dueDate
string<date-time>

Date and time when the deadline is due.

Exemplo:

"2026-03-31T23:59:59Z"

frequency
string

Deadline recurrence frequency.

Exemplo:

"monthly"

id
string

Unique deadline identifier.

Exemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear
integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Exemplo:
name
string

Human-readable deadline name.

Exemplo:

"Monthly Regulatory Report"

notifyDaysBefore
integer<int64>

Days before the due date when notifications begin.

Exemplo:

5

status
string

Current derived deadline status.

Exemplo:

"pending"

templateId
string

Template used to generate the report.

Exemplo:

"00000000-0000-0000-0000-000000000000"

templateName
string

Human-readable name of the associated template.

Exemplo:

"Financial Template"

type
string

Deadline category.

Exemplo:

"regulatory"

updatedAt
string<date-time>

Date and time when the deadline was last updated.

Exemplo:

"2026-01-01T00:00:00Z"