Crear un plazo

curl --request POST \
  --url http://localhost:4005/v1/deadlines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "name": "<string>",
  "type": "<string>",
  "active": true,
  "description": "<string>",
  "monthsOfYear": [
    123
  ],
  "notifyDaysBefore": 123,
  "templateId": "<string>"
}
'

import requests

url = "http://localhost:4005/v1/deadlines"

payload = {
    "color": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "frequency": "<string>",
    "name": "<string>",
    "type": "<string>",
    "active": True,
    "description": "<string>",
    "monthsOfYear": [123],
    "notifyDaysBefore": 123,
    "templateId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    frequency: '<string>',
    name: '<string>',
    type: '<string>',
    active: true,
    description: '<string>',
    monthsOfYear: [123],
    notifyDaysBefore: 123,
    templateId: '<string>'
  })
};

fetch('http://localhost:4005/v1/deadlines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4005",
  CURLOPT_URL => "http://localhost:4005/v1/deadlines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'color' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'frequency' => '<string>',
    'name' => '<string>',
    'type' => '<string>',
    'active' => true,
    'description' => '<string>',
    'monthsOfYear' => [
        123
    ],
    'notifyDaysBefore' => 123,
    'templateId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4005/v1/deadlines"

	payload := strings.NewReader("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:4005/v1/deadlines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:4005/v1/deadlines")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "id": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "status": "<string>",
  "templateId": "<string>",
  "templateName": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

deadlines

Crear un plazo

curl --request POST \
  --url http://localhost:4005/v1/deadlines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "name": "<string>",
  "type": "<string>",
  "active": true,
  "description": "<string>",
  "monthsOfYear": [
    123
  ],
  "notifyDaysBefore": 123,
  "templateId": "<string>"
}
'

import requests

url = "http://localhost:4005/v1/deadlines"

payload = {
    "color": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "frequency": "<string>",
    "name": "<string>",
    "type": "<string>",
    "active": True,
    "description": "<string>",
    "monthsOfYear": [123],
    "notifyDaysBefore": 123,
    "templateId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    frequency: '<string>',
    name: '<string>',
    type: '<string>',
    active: true,
    description: '<string>',
    monthsOfYear: [123],
    notifyDaysBefore: 123,
    templateId: '<string>'
  })
};

fetch('http://localhost:4005/v1/deadlines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4005",
  CURLOPT_URL => "http://localhost:4005/v1/deadlines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'color' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'frequency' => '<string>',
    'name' => '<string>',
    'type' => '<string>',
    'active' => true,
    'description' => '<string>',
    'monthsOfYear' => [
        123
    ],
    'notifyDaysBefore' => 123,
    'templateId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4005/v1/deadlines"

	payload := strings.NewReader("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:4005/v1/deadlines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:4005/v1/deadlines")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "id": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "status": "<string>",
  "templateId": "<string>",
  "templateName": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

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.

Cuerpo

application/json

Cuerpo JSON de la solicitud.

color

string

requerido

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

Ejemplo:

"#FF5733"

dueDate

string<date-time>

requerido

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

Ejemplo:

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

frequency

string

requerido

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

Ejemplo:

"monthly"

name

string

requerido

Nombre legible del plazo.

Ejemplo:

"Monthly Regulatory Report"

type

string

requerido

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

Ejemplo:

"regulatory"

active

boolean

Indica si el plazo está activo.

Ejemplo:

true

description

string

Descripción del plazo.

Ejemplo:

"Monthly regulatory compliance report"

monthsOfYear

integer<int64>[] | null

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

Ejemplo:

[1, 6]

notifyDaysBefore

integer<int64>

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

Ejemplo:

5

templateId

string

Plantilla utilizada para generar el informe asociado al plazo.

Ejemplo:

"00000000-0000-0000-0000-000000000001"

Respuesta

Creado

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"

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:

[1, 6]

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"

⌘I

Primeros pasos

API de Templates

API del Constructor de Templates

API de Reportes

API de Plazos

API de Fuentes de Datos

API de Métricas

API de Streaming

Manejo de errores

Crear un plazo

Autorizaciones

Cuerpo

Respuesta