Skip to main content
POST
Crie um ajuste compensatório do consignado

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 (lib-commons enforcer reads this). Reusing the same key on a retry returns the SAME durably accepted operation, never a duplicate.

Corpo

application/json
adjustmentAmount
string
obrigatório

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

currency
string
obrigatório

ISO-4217 currency code.

Required string length: 3
justification
string
obrigatório

Operator's structured justification.

Required string length: 1 - 4000
numeroContrato
string
obrigatório

Canonical rail contract number.

Required string length: 2 - 15
reason
enum<string>
obrigatório

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

Opções disponíveis:
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.

Resposta

Accepted

adjustmentAmount
string
obrigatório

Signed compensating entry magnitude, exact two-decimal string.

createdAt
string
obrigatório

RFC3339 UTC.

createdBy
string
obrigatório

Validated actor identity that created this operation.

currency
string
obrigatório

ISO-4217 currency code.

existing
boolean
obrigatório

True when this call replayed an already-committed operation for the same idempotency key, never a duplicate.

id
string
obrigatório

Compensating adjustment operation identifier.

idempotencyKey
string
obrigatório

Idempotency key this operation was created (or replayed) under.

justification
string
obrigatório

Operator's structured justification.

numeroContrato
string
obrigatório

Canonical rail contract number.

reason
string
obrigatório

Closed reason catalog.

correctionEventId
string

Landed correction event this adjustment resolves, when set.

debtAmountAfter
string

CCB debt after, when this adjustment changes the debt.

debtAmountBefore
string

CCB debt before, when this adjustment changes the debt.

divergenceId
string

Divergence this adjustment resolves, when set.

resolvedGlAccount
string

Suspense GL account this operation was authorized against. Empty when the currency had no configured suspense account at create time — the posting intent could not be recorded yet.