Create accrual run

Queues an accrual batch for a business date and returns available journal/outbox reference data.

POST /api/v1/accrual-runs

Create accrual run

cURL

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": "daily",
  "loanProductIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

201

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

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 up to today in São Paulo works, and no account is skipped for the day of the month it was disbursed on; a date after today in São Paulo is refused with 422 (LENDER-0424) and nothing is written, because a run does not accept a future business date. 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

Label recorded on the run for correlation and logs. It does not change the cadence or select which accounts are recognized. The label is part of the run's correlation id, so "heartbeat" is reserved for the scheduled driver and is refused here.

Required string length: 1 - 32

Ejemplo:

"daily"

loanProductIds · string<uuid>[] | null

Optional loan product identifiers to scope the run.

Maximum array length: 100

Respuesta

201

application/json

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"

id · 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"