Skip to main content
PATCH
Definir o estado de entrega do prazo
Esses endpoints permitem o gerenciamento de prazos no Console. Você também pode chamá-los diretamente para integrar prazos aos seus próprios sistemas.

Autorizações

Authorization
string
header
obrigatório

Token bearer JWT emitido pelo provedor de identidade.

Parâmetros de caminho

id
string
obrigatório

Identificador único do prazo.

Corpo

application/json

Payload JSON da requisição.

delivered
boolean | null
obrigatório

Se o prazo deve ser marcado como entregue ou se sua entrega deve ser revertida.

Exemplo:

true

Resposta

OK

active
boolean

Se o prazo está ativo.

Exemplo:

true

color
string

Cor hexadecimal usada para identificar o prazo.

Exemplo:

"#FF5733"

createdAt
string<date-time>

Data e hora em que o prazo foi criado.

Exemplo:

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

deliveredAt
string<date-time>

Data e hora em que o prazo foi entregue.

Exemplo:

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

description
string

Descrição opcional do prazo.

Exemplo:

"Monthly regulatory compliance report"

dueDate
string<date-time>

Data e hora de vencimento do prazo.

Exemplo:

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

frequency
string

Frequência de recorrência do prazo.

Exemplo:

"monthly"

id
string

Identificador único do prazo.

Exemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear
integer<int64>[] | null

Meses em que ocorre um prazo semestral ou anual.

Exemplo:
name
string

Nome legível do prazo.

Exemplo:

"Monthly Regulatory Report"

notifyDaysBefore
integer<int64>

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

Exemplo:

5

status
string

Status derivado atual do prazo.

Exemplo:

"pending"

templateId
string

Template usado para gerar o relatório.

Exemplo:

"00000000-0000-0000-0000-000000000000"

templateName
string

Nome legível do template associado.

Exemplo:

"Financial Template"

type
string

Categoria do prazo.

Exemplo:

"regulatory"

updatedAt
string<date-time>

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

Exemplo:

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