Create accrual run

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/accrual-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "businessDate": "2026-06-14",
  "mode": "monthly",
  "loanProductIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

	payload := strings.NewReader("{\n  \"businessDate\": \"2026-06-14\",\n  \"mode\": \"monthly\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    businessDate: '2026-06-14',
    mode: 'monthly',
    loanProductIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/accrual-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

payload = {
    "businessDate": "2026-06-14",
    "mode": "monthly",
    "loanProductIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "businessDate": "2026-06-14",
  "correlationId": "550e8400-e29b-41d4-a716-446655440002",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "journalReferenceId": "550e8400-e29b-41d4-a716-446655440001",
  "status": "queued",
  "outboxEventId": "550e8400-e29b-41d4-a716-446655440003"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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

api

accrual-runs

Create accrual run

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/accrual-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "businessDate": "2026-06-14",
  "mode": "monthly",
  "loanProductIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

	payload := strings.NewReader("{\n  \"businessDate\": \"2026-06-14\",\n  \"mode\": \"monthly\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    businessDate: '2026-06-14',
    mode: 'monthly',
    loanProductIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/accrual-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

payload = {
    "businessDate": "2026-06-14",
    "mode": "monthly",
    "loanProductIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "businessDate": "2026-06-14",
  "correlationId": "550e8400-e29b-41d4-a716-446655440002",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "journalReferenceId": "550e8400-e29b-41d4-a716-446655440001",
  "status": "queued",
  "outboxEventId": "550e8400-e29b-41d4-a716-446655440003"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "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.

Encabezados

X-Idempotency

string

requerido

Canonical idempotency request ID. Required: this request moves money, and without a key a retry cannot be told apart from a second instruction.

Cuerpo

application/json

businessDate

string<date>

requerido

Business date (YYYY-MM-DD) the run is executed on. The run recognizes the last CIVIL MONTH that fully elapsed before this date — a run dated anywhere in July closes June — for the WHOLE book, pro rata temporis by calendar days, with the loan's contracting month apportioned within that month. Any date works: no account is skipped for the day of the month it was disbursed on. Re-running the same competência is a no-op, so this is also the backfill lever: to close a month that was missed, post a date inside the following month.

Ejemplo:

"2026-06-14"

mode

string

requerido

Accrual run cadence. The scheduled driver sends monthly, one competencia per loan.

Required string length: 1 - 32

Ejemplo:

"monthly"

loanProductIds

string<uuid>[] | null

Optional loan product identifiers to scope the run.

Maximum array length: 100

Respuesta

Created

businessDate

string

requerido

Business date (YYYY-MM-DD, UTC) the run was queued for.

Ejemplo:

"2026-06-14"

correlationId

string

requerido

Correlation identifier linking the run to its journal/outbox lineage and downstream events.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

string

requerido

Server-assigned UUID of the queued accrual run.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

journalReferenceId

string

requerido

UUID of the journal reference recording this run's posting lineage.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

status

string

requerido

Lifecycle status of the queued run (e.g. queued).

Ejemplo:

"queued"

outboxEventId

string

UUID of the emitted outbox event; omitted when no outbox event was recorded.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440003"

Productos de préstamo de Brasil

Operaciones de consignado

Ciclo de vida del producto

Versiones del producto

Configuración del producto

Tablas de tasa flotante

Plantillas de documento

Solicitudes de Préstamo

Instrumentos de crédito

Divulgaciones regulatorias y riesgo

Liquidación y prepago

Resumen y auditoría de cuenta

Cargos y calendario

Pagos

Transacciones

Cuentas por cobrar de pago devuelto

Fondos de cesión

Lotes de cesión

Excepciones y registradora de la cesión

Contabilidad

Paneles de cartera

Jurisdicciones

Impuestos

Sesión

Streaming

Manejo de errores

Eventos

Create accrual run

Autorizaciones

Encabezados

Cuerpo

Respuesta