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

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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.

Exemplo:

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

Parâmetros de caminho

id
string<uuid>
obrigatório

Loan product identifier.

Exemplo:

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

Corpo

application/json
effectiveFrom
string<date>
obrigatório

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.

Exemplo:

"2026-08-01"

Resposta

OK

contractsVisited
integer<int64>
obrigatório

Every contract the pass read the book for.

Exemplo:

1200

effectiveFrom
string
obrigatório

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

Exemplo:

"2026-08-01"

loanProductId
string
obrigatório

The product whose contracts were swept (uuid).

Exemplo:

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

transfersRecorded
integer<int64>
obrigatório

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

Exemplo:

318