Create accrual run
Queues an accrual batch for a business date and returns available journal/outbox reference data.
Authorizations
JWT bearer token issued by the identity provider.
Headers
Canonical idempotency request ID. Required: this request moves money, and without a key a retry cannot be told apart from a second instruction.
Body
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.
"2026-06-14"
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.
1 - 32"daily"
Optional loan product identifiers to scope the run.
100Response
Created
Business date (YYYY-MM-DD, UTC) the run was queued for.
"2026-06-14"
Correlation identifier linking the run to its journal/outbox lineage and downstream events.
"550e8400-e29b-41d4-a716-446655440002"
Server-assigned UUID of the queued accrual run.
"550e8400-e29b-41d4-a716-446655440000"
UUID of the journal reference recording this run's posting lineage.
"550e8400-e29b-41d4-a716-446655440001"
Lifecycle status of the queued run (e.g. queued).
"queued"
UUID of the emitted outbox event; omitted when no outbox event was recorded.
"550e8400-e29b-41d4-a716-446655440003"

