Create a deadline

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/deadlines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "#FF5733",
  "dueDate": "2026-03-31T23:59:59Z",
  "frequency": "monthly",
  "name": "Monthly Regulatory Report",
  "type": "regulatory",
  "active": true,
  "description": "Monthly regulatory compliance report",
  "filters": {
    "accounts": {
      "account": {
        "vencimento": {
          "period": "previous_month"
        }
      }
    }
  },
  "monthsOfYear": [
    1,
    6
  ],
  "notifyDaysBefore": 5,
  "templateId": "00000000-0000-0000-0000-000000000001"
}
'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/deadlines"

	payload := strings.NewReader("{\n  \"color\": \"#FF5733\",\n  \"dueDate\": \"2026-03-31T23:59:59Z\",\n  \"frequency\": \"monthly\",\n  \"name\": \"Monthly Regulatory Report\",\n  \"type\": \"regulatory\",\n  \"active\": true,\n  \"description\": \"Monthly regulatory compliance report\",\n  \"filters\": {\n    \"accounts\": {\n      \"account\": {\n        \"vencimento\": {\n          \"period\": \"previous_month\"\n        }\n      }\n    }\n  },\n  \"monthsOfYear\": [\n    1,\n    6\n  ],\n  \"notifyDaysBefore\": 5,\n  \"templateId\": \"00000000-0000-0000-0000-000000000001\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '#FF5733',
    dueDate: '2026-03-31T23:59:59Z',
    frequency: 'monthly',
    name: 'Monthly Regulatory Report',
    type: 'regulatory',
    active: true,
    description: 'Monthly regulatory compliance report',
    filters: {accounts: {account: {vencimento: {period: 'previous_month'}}}},
    monthsOfYear: [1, 6],
    notifyDaysBefore: 5,
    templateId: '00000000-0000-0000-0000-000000000001'
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/deadlines', 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"

payload = {
    "color": "#FF5733",
    "dueDate": "2026-03-31T23:59:59Z",
    "frequency": "monthly",
    "name": "Monthly Regulatory Report",
    "type": "regulatory",
    "active": True,
    "description": "Monthly regulatory compliance report",
    "filters": { "accounts": { "account": { "vencimento": { "period": "previous_month" } } } },
    "monthsOfYear": [1, 6],
    "notifyDaysBefore": 5,
    "templateId": "00000000-0000-0000-0000-000000000001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(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"
  }
}

{
  "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"
  }
}

POST

deadlines

Create a deadline

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/deadlines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "#FF5733",
  "dueDate": "2026-03-31T23:59:59Z",
  "frequency": "monthly",
  "name": "Monthly Regulatory Report",
  "type": "regulatory",
  "active": true,
  "description": "Monthly regulatory compliance report",
  "filters": {
    "accounts": {
      "account": {
        "vencimento": {
          "period": "previous_month"
        }
      }
    }
  },
  "monthsOfYear": [
    1,
    6
  ],
  "notifyDaysBefore": 5,
  "templateId": "00000000-0000-0000-0000-000000000001"
}
'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/deadlines"

	payload := strings.NewReader("{\n  \"color\": \"#FF5733\",\n  \"dueDate\": \"2026-03-31T23:59:59Z\",\n  \"frequency\": \"monthly\",\n  \"name\": \"Monthly Regulatory Report\",\n  \"type\": \"regulatory\",\n  \"active\": true,\n  \"description\": \"Monthly regulatory compliance report\",\n  \"filters\": {\n    \"accounts\": {\n      \"account\": {\n        \"vencimento\": {\n          \"period\": \"previous_month\"\n        }\n      }\n    }\n  },\n  \"monthsOfYear\": [\n    1,\n    6\n  ],\n  \"notifyDaysBefore\": 5,\n  \"templateId\": \"00000000-0000-0000-0000-000000000001\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '#FF5733',
    dueDate: '2026-03-31T23:59:59Z',
    frequency: 'monthly',
    name: 'Monthly Regulatory Report',
    type: 'regulatory',
    active: true,
    description: 'Monthly regulatory compliance report',
    filters: {accounts: {account: {vencimento: {period: 'previous_month'}}}},
    monthsOfYear: [1, 6],
    notifyDaysBefore: 5,
    templateId: '00000000-0000-0000-0000-000000000001'
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/deadlines', 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"

payload = {
    "color": "#FF5733",
    "dueDate": "2026-03-31T23:59:59Z",
    "frequency": "monthly",
    "name": "Monthly Regulatory Report",
    "type": "regulatory",
    "active": True,
    "description": "Monthly regulatory compliance report",
    "filters": { "accounts": { "account": { "vencimento": { "period": "previous_month" } } } },
    "monthsOfYear": [1, 6],
    "notifyDaysBefore": 5,
    "templateId": "00000000-0000-0000-0000-000000000001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(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"
  }
}

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

JSON request payload.

color

string

required

Hex color used to identify the deadline.

Example:

"#FF5733"

dueDate

string<date-time>

required

Date and time when the deadline is due.

Example:

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

frequency

string

required

Deadline recurrence frequency.

Example:

"monthly"

name

string

required

Human-readable deadline name.

Example:

"Monthly Regulatory Report"

type

string

required

Deadline category.

Example:

"regulatory"

active

boolean

Whether the deadline is active.

Example:

true

description

string

Optional deadline description.

Example:

"Monthly regulatory compliance report"

filters

object

Filter conditions this deadline applies when it fires, grouped by data source, table, and field. Optional: omit it for a deadline that filters nothing.

Show child attributes

Example:

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

monthsOfYear

integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Example:

[1, 6]

notifyDaysBefore

integer<int64>

Days before the due date when notifications begin.

Example:

5

templateId

string

Template used to generate the deadline report.

Example:

"00000000-0000-0000-0000-000000000001"

Response

Created

active

boolean

Whether the deadline is active.

Example:

true

color

string

Hex color used to identify the deadline.

Example:

"#FF5733"

createdAt

string<date-time>

Date and time when the deadline was created.

Example:

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

deliveredAt

string<date-time>

Date and time when the deadline was delivered.

Example:

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

description

string

Optional deadline description.

Example:

"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.

Example:

"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

Example:

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

frequency

string

Deadline recurrence frequency.

Example:

"monthly"

string

Unique deadline identifier.

Example:

"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.

Example:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Example:

[1, 6]

name

string

Human-readable deadline name.

Example:

"Monthly Regulatory Report"

notifyDaysBefore

integer<int64>

Days before the due date when notifications begin.

Example:

5

status

string

Current derived deadline status.

Example:

"pending"

templateId

string

Template used to generate the report.

Example:

"00000000-0000-0000-0000-000000000000"

templateName

string

Human-readable name of the associated template.

Example:

"Financial Template"

timezone

string

IANA timezone name that gives the dueDate clock time its meaning and along which the recurrence advances. Empty means UTC.

Example:

"America/Sao_Paulo"

type

string

Deadline category.

Example:

"regulatory"

updatedAt

string<date-time>

Date and time when the deadline was last updated.

Example:

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

Getting started

Templates API

Template Builder API

Reports API

Deadlines API

Data Sources API

Institutions API

Regulatory Catalog API

Regulatory Subscriptions API

Regulatory Bindings API

Regulatory Reports API

Metrics API

Streaming API

Error handling

Events

Create a deadline

Authorizations

Body

Response