Set deadline delivery state

curl --request PATCH \
  --url https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delivered": true
}
'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver"

	payload := strings.NewReader("{\n  \"delivered\": true\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({delivered: true})
};

fetch('https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver"

payload = { "delivered": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "active": true,
  "color": "#FF5733",
  "createdAt": "2026-01-01T00:00:00Z",
  "deliveredAt": "2026-03-15T10:00:00Z",
  "description": "Monthly regulatory compliance report",
  "dueDate": "2026-03-31T23:59:59Z",
  "filters": {
    "accounts": {
      "account": {
        "vencimento": {
          "period": "previous_month"
        }
      }
    }
  },
  "frequency": "monthly",
  "id": "00000000-0000-0000-0000-000000000000",
  "institution": "00000000-0000-0000-0000-000000000000",
  "monthsOfYear": [
    1,
    6
  ],
  "name": "Monthly Regulatory Report",
  "notifyDaysBefore": 5,
  "status": "pending",
  "templateId": "00000000-0000-0000-0000-000000000000",
  "templateName": "Financial Template",
  "timezone": "America/Sao_Paulo",
  "type": "regulatory",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

PATCH

deadlines

{id}

deliver

Set deadline delivery state

curl --request PATCH \
  --url https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delivered": true
}
'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver"

	payload := strings.NewReader("{\n  \"delivered\": true\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({delivered: true})
};

fetch('https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/deadlines/{id}/deliver"

payload = { "delivered": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "active": true,
  "color": "#FF5733",
  "createdAt": "2026-01-01T00:00:00Z",
  "deliveredAt": "2026-03-15T10:00:00Z",
  "description": "Monthly regulatory compliance report",
  "dueDate": "2026-03-31T23:59:59Z",
  "filters": {
    "accounts": {
      "account": {
        "vencimento": {
          "period": "previous_month"
        }
      }
    }
  },
  "frequency": "monthly",
  "id": "00000000-0000-0000-0000-000000000000",
  "institution": "00000000-0000-0000-0000-000000000000",
  "monthsOfYear": [
    1,
    6
  ],
  "name": "Monthly Regulatory Report",
  "notifyDaysBefore": 5,
  "status": "pending",
  "templateId": "00000000-0000-0000-0000-000000000000",
  "templateName": "Financial Template",
  "timezone": "America/Sao_Paulo",
  "type": "regulatory",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

Unique deadline identifier.

Cuerpo

application/json

JSON request payload.

delivered

boolean | null

requerido

Whether to mark the deadline delivered or revert its delivery.

Ejemplo:

true

Respuesta

active

boolean

Whether the deadline is active.

Ejemplo:

true

color

string

Hex color used to identify the deadline.

Ejemplo:

"#FF5733"

createdAt

string<date-time>

Date and time when the deadline was created.

Ejemplo:

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

deliveredAt

string<date-time>

Date and time when the deadline was delivered.

Ejemplo:

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

description

string

Optional deadline description.

Ejemplo:

"Monthly regulatory compliance report"

dueDate

string<date-time>

Date and time when the deadline is due. Its clock time is the hour the reminder starts firing from.

Ejemplo:

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

filters

object

Filter conditions this deadline applies when it fires, grouped by data source, table, and field. Absent when the deadline filters nothing.

Show child attributes

Ejemplo:

{
  "accounts": {
    "account": {
      "vencimento": { "period": "previous_month" }
    }
  }
}

frequency

string

Deadline recurrence frequency.

Ejemplo:

"monthly"

string

Unique deadline identifier.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

institution

string

The institution the reports this deadline generates read for: an institution id, or "all". Absent, each report takes the tenant's only institution when it fires, reads everything when the tenant has none, and is refused when it has several.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Ejemplo:

[1, 6]

name

string

Human-readable deadline name.

Ejemplo:

"Monthly Regulatory Report"

notifyDaysBefore

integer<int64>

Days before the due date when notifications begin.

Ejemplo:

5

status

string

Current derived deadline status.

Ejemplo:

"pending"

templateId

string

Template used to generate the report.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

templateName

string

Human-readable name of the associated template.

Ejemplo:

"Financial Template"

timezone

string

IANA timezone name that gives the dueDate clock time its meaning, along which the recurrence advances, and in which today's calendar day is counted for the past-day refusal and daysUntilDue. Empty means UTC.

Ejemplo:

"America/Sao_Paulo"

type

string

Deadline category.

Ejemplo:

"regulatory"

updatedAt

string<date-time>

Date and time when the deadline was last updated.

Ejemplo:

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

Primeros pasos

API de Plantillas

API del Constructor de Plantillas

API de Informes

API de Plazos

API de Fuentes de Datos

API de Instituciones

API de Catálogo Regulatorio

API de Suscripciones Regulatorias

API de Mapeos Regulatorios

API de Informes Regulatorios

API de Métricas

API de Streaming

Manejo de errores

Eventos

Set deadline delivery state

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta