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

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 enqueues a posting per contract, and without a key a retry cannot be told apart from a second instruction.

Ejemplo:

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

Parámetros de ruta

id
string<uuid>
requerido

Loan product identifier.

Ejemplo:

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

Cuerpo

application/json
effectiveFrom
string<date>
requerido

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.

Ejemplo:

"2026-08-01"

Respuesta

OK

contractsVisited
integer<int64>
requerido

Every contract the pass read the book for.

Ejemplo:

1200

effectiveFrom
string
requerido

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

Ejemplo:

"2026-08-01"

loanProductId
string
requerido

The product whose contracts were swept (uuid).

Ejemplo:

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

transfersRecorded
integer<int64>
requerido

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

Ejemplo:

318