Criar um Prazo

curl --request POST \ --url https://reporter.sandbox.lerian.net/v1/deadlines \ --header 'Content-Type: application/json' \ --header 'X-Organization-id: <x-organization-id>' \ --data ' { "name": "Monthly Regulatory Report", "description": "Monthly regulatory compliance report", "type": "regulatory", "frequency": "monthly", "dueDate": "2026-03-31T23:59:59Z", "color": "#FF5733", "notifyDaysBefore": 5, "monthsOfYear": [ 1, 6 ], "templateId": "00000000-0000-0000-0000-000000000000", "active": true } '

{ "id": "<string>", "name": "<string>", "description": "<string>", "type": "<string>", "frequency": "<string>", "dueDate": "<string>", "color": "<string>", "notifyDaysBefore": 123, "monthsOfYear": [ 123 ], "templateId": "<string>", "templateName": "<string>", "status": "<string>", "active": true, "deliveredAt": "<string>", "createdAt": "<string>", "updatedAt": "<string>" }

Cabeçalhos

Authorization

string

O token de autorização no formato 'Bearer '.

Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

X-Organization-id

string

obrigatório

O identificador único da Organização associada à requisição.

X-Idempotency

string

Chave de idempotência opcional para retentativas seguras. Se omitida, o servidor pode gerar uma automaticamente.

Consulte Retentativas e idempotência para mais detalhes.

Corpo

application/json

O payload de entrada para criar um prazo.

name

string

obrigatório

Nome legível do prazo.

type

string

obrigatório

Tipo do prazo (ex. regulatory, custom).

frequency

string

obrigatório

Com que frequência o prazo se repete (ex. monthly, annual).

dueDate

string

obrigatório

Data e hora de vencimento do prazo, no formato RFC 3339.

color

string

obrigatório

Cor usada para identificar visualmente o prazo (formato hexadecimal).

description

string

Descrição opcional do prazo.

notifyDaysBefore

integer

Número de dias antes da data de vencimento em que as notificações começam.

monthsOfYear

integer[]

Meses do ano (1-12) em que o prazo se aplica.

templateId

string

Identificador único do template usado para cumprir o prazo (UUID).

active

boolean

Indica se o prazo está ativo.

Resposta

Indica que o prazo foi criado com sucesso.

Detalhes sobre um prazo.

string

Identificador único do prazo (UUID).

name

string

Nome legível do prazo.

description

string

Descrição do prazo.

type

string

Tipo do prazo (ex. regulatory, custom).

frequency

string

Com que frequência o prazo se repete (ex. monthly, annual).

dueDate

string

Data e hora de vencimento do prazo, no formato RFC 3339.

color

string

Cor usada para identificar visualmente o prazo (formato hexadecimal).

notifyDaysBefore

integer

Número de dias antes da data de vencimento em que as notificações começam.

monthsOfYear

integer[]

Meses do ano (1-12) em que o prazo se aplica.

templateId

string

Identificador único do template usado para cumprir o prazo (UUID).

templateName

string

Nome do template usado para cumprir o prazo.

status

string

Status atual do prazo (ex. pending, overdue, delivered).

active

boolean

Indica se o prazo está ativo.

deliveredAt

string

Data e hora em que o prazo foi entregue, se aplicável.

createdAt

string

Data e hora em que o prazo foi criado.

updatedAt

string

Data e hora da última atualização do prazo.