Skip to main content
POST
Settle a chart change onto every contract's balances

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Canonical idempotency request ID. Required: this request enqueues a posting per contract, and without a key a retry cannot be told apart from a second instruction.

Example:

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

Path Parameters

id
string<uuid>
required

Loan product identifier.

Example:

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

Body

application/json
effectiveFrom
string<date>
required

The civil day (YYYY-MM-DD) the chart being settled took force. The sweep refuses to run before that day has arrived: the balance it moves is the one the account holds ON that day, and until then the old chart is still in force and still filing postings there.

Example:

"2026-08-01"

Response

OK

contractsVisited
integer<int64>
required

Every contract the pass read the book for.

Example:

1200

effectiveFrom
string
required

The civil day (YYYY-MM-DD) of the chart change settled by this pass.

Example:

"2026-08-01"

loanProductId
string
required

The product whose contracts were swept (uuid).

Example:

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

transfersRecorded
integer<int64>
required

How many of them had a balance to move. Zero on a rerun of a finished change.

Example:

318