Skip to main content
POST
Preview a consignado compensating adjustment

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
adjustmentAmount
string
required

Signed compensating entry magnitude, exact two-decimal string. Sign convention: payment_shortfall must be negative, payment_excess must be positive.

currency
string
required

ISO-4217 currency code.

Required string length: 3
justification
string
required

Operator's structured justification.

Required string length: 1 - 4000
numeroContrato
string
required

Canonical rail contract number.

Required string length: 2 - 15
reason
enum<string>
required

Closed reason catalog; no free-form 'other'.

Available options:
payment_shortfall,
payment_excess,
immutable_client_correction,
internal_ccb_residual
correctionEventId
string

Landed correction event this adjustment resolves. At most one of divergenceId/correctionEventId may be set.

Maximum string length: 255
debtAmountAfter
string

CCB debt after this adjustment. Both-or-neither with debtAmountBefore.

debtAmountBefore
string

CCB debt before this adjustment. Both-or-neither with debtAmountAfter.

divergenceId
string<uuid>

Divergence this adjustment resolves. At most one of divergenceId/correctionEventId may be set.

Response

OK

adjustmentAmount
string
required

Normalized signed amount, exact two-decimal string.

currency
string
required

ISO-4217 currency code.

numeroContrato
string
required

Canonical rail contract number.

principalSide
string
required

debit|credit: the direction the eventual posting intent moves the contract's principal (receivable) account. Always opposite suspenseSide.

reason
string
required

Closed reason catalog.

suspenseSide
string
required

debit|credit: the direction the eventual posting intent moves the tenant's suspense account.

debtAmountAfter
string

CCB debt after, when this adjustment changes the debt.

debtAmountBefore
string

CCB debt before, when this adjustment changes the debt.