Saltar al contenido principal
PATCH
Entregar un plazo
Estos endpoints sustentan la gestión de plazos en la Consola. También puede llamarlos directamente para integrar los plazos en sus propios sistemas.

Autorizaciones

Authorization
string
header
requerido

Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'. Solo es obligatoria cuando el plugin de autenticación está habilitado.

Parámetros de ruta

id
string
requerido

Identificador único del plazo (UUID).

Cuerpo

application/json

Cuerpo JSON de la solicitud.

delivered
boolean | null
requerido

Indica si se debe marcar el plazo como entregado o revertir su entrega.

Ejemplo:

true

Respuesta

Correcto

active
boolean

Indica si el plazo está activo.

Ejemplo:

true

color
string

Color usado para identificar visualmente el plazo (formato hexadecimal).

Ejemplo:

"#FF5733"

createdAt
string<date-time>

Fecha y hora en que se creó el plazo.

Ejemplo:

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

deliveredAt
string<date-time>

Fecha y hora en que se entregó el plazo, si aplica.

Ejemplo:

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

description
string

Descripción del plazo.

Ejemplo:

"Monthly regulatory compliance report"

dueDate
string<date-time>

Fecha y hora de vencimiento del plazo, en formato RFC 3339.

Ejemplo:

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

frequency
string

Con qué frecuencia se repite el plazo (p. ej., monthly, annual).

Ejemplo:

"monthly"

id
string

Identificador único del plazo (UUID).

Ejemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear
integer<int64>[] | null

Meses del año (1-12) en los que aplica el plazo.

Ejemplo:
name
string

Nombre legible del plazo.

Ejemplo:

"Monthly Regulatory Report"

notifyDaysBefore
integer<int64>

Número de días antes de la fecha de vencimiento en que comienzan las notificaciones.

Ejemplo:

5

status
string

Estado actual del plazo (p. ej., pending, overdue, delivered).

Ejemplo:

"pending"

templateId
string

Identificador único de la plantilla usada para cumplir el plazo (UUID).

Ejemplo:

"00000000-0000-0000-0000-000000000000"

templateName
string

Nombre de la plantilla usada para cumplir el plazo.

Ejemplo:

"Financial Template"

type
string

Tipo del plazo (p. ej., regulatory, custom).

Ejemplo:

"regulatory"

updatedAt
string<date-time>

Fecha y hora de la última actualización del plazo.

Ejemplo:

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