v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Accounting

Create accrual run

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

post/api/v1/accrual-runs

Request body

businessDatestring date required

Business date (YYYY-MM-DD) the accrual batch is queued for.

loanProductIdsstring[] nullable

Optional loan product identifiers to scope the run.

modestring required

Accrual run mode (e.g. daily).

Example request

{
  "businessDate": "2026-06-14",
  "mode": "daily"
}

Response

Created

businessDatestring required

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

correlationIdstring required

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

idstring required

Server-assigned UUID of the queued accrual run.

journalReferenceIdstring required

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

outboxEventIdstring

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

statusstring required

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

Example response

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