Assign consignado contract divergence

Claims an open item for an operator. Compare-and-swap guarded by expectedVersion; idempotent via the X-Idempotency header enforced by the platform middleware.

POST /api/v1/internal/br/consignado/divergences/{id}/assign

Assign consignado contract divergence

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/divergences/{id}/assign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "assignee": "<string>",
  "expectedVersion": 2
}
'

200

{
  "adjustmentStatus": "<string>",
  "authority": "<string>",
  "category": "<string>",
  "classification": "<string>",
  "contractId": "<string>",
  "createdAt": "<string>",
  "dispositionState": "<string>",
  "effect": "<string>",
  "firstObservedAt": "<string>",
  "id": "<string>",
  "latestObservedAt": "<string>",
  "occurrenceKey": "<string>",
  "railAcceptedAt": "<string>",
  "slaDueAt": "<string>",
  "updatedAt": "<string>",
  "version": 123,
  "amountCurrency": "<string>",
  "assignedAt": "<string>",
  "assignee": "<string>",
  "calculatedAt": "<string>",
  "clientDeclaredAmount": "<string>",
  "disposable": true,
  "disposedAt": "<string>",
  "dispositionActor": "<string>",
  "dispositionJustification": "<string>",
  "dispositionResult": "<string>",
  "lenderCalculatedAmount": "<string>",
  "openShortfall": "<string>",
  "rerunnable": true,
  "residualAvailable": "<string>",
  "ruleVersion": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

Canonical idempotency request ID.

Parámetros de ruta

id · string<uuid> · requerido

Contract divergence identifier.

Cuerpo

application/json

assignee · string · requerido

Operator now responsible for the item.

Required string length: 1 - 255

expectedVersion · integer<int64> · requerido

Compare-and-swap guard: the version this request was read against.

Rango requerido: x >= 1

Respuesta

200

application/json

OK

adjustmentStatus · string · requerido

not_required|required|requested|posted.

authority · string · requerido

Source of truth for the contested value: client|dataprev|gateway|lender.

category · string · requerido

Bounded category: cash|rate|terms|margin|registration|technical.

classification · string · requerido

Specific durable exception inside the category.

contractId · string · requerido

Contract the divergence belongs to.

createdAt · string · requerido

RFC3339 UTC.

dispositionState · string · requerido

open|disposed.

effect · string · requerido

What the item does to the flow: audit_only|posting_pending|adjustment_required|booking_blocked.

firstObservedAt · string · requerido

First durable persist (RFC3339 UTC); the SLA clock start.

id · string · requerido

Contract divergence identifier.

latestObservedAt · string · requerido

Most recent observation (RFC3339 UTC).

occurrenceKey · string · requerido

Replay-fencing key for the observed occurrence.

railAcceptedAt · string · requerido

Instant the rail accepted the underlying fact (RFC3339 UTC).

slaDueAt · string · requerido

Resolution deadline (RFC3339 UTC).

updatedAt · string · requerido

RFC3339 UTC.

version · integer<int64> · requerido

Compare-and-swap guard: every mutation supplies this as expectedVersion.

amountCurrency · string

ISO-4217 currency of the contested amounts.

assignedAt · string

Instant of the current assignment (RFC3339 UTC).

assignee · string

Operator currently responsible, when assigned.

calculatedAt · string

Instant the Lender calculation was produced (RFC3339 UTC).

clientDeclaredAmount · string

Authoritative value the client declared, when a comparison exists; on a ceded_cash_unplaced item, the router's current figure of the rail's cash no desk line holds.

disposable · boolean

True when the item is open and Dispose accepts it. False on a closed item and on a competência parked for its re-run (posting_pending employer_shortfall of a month no live cession holds, or reconciliation_hold_for_review), which leaves only by Requeue; true on its placed item (occurrenceKey run=placed|...), on a run held for its escrituração, on the review hold of a settle the rail never confirmed (lenderEvidence rail 0) and on every review hold of a month whose escrituração Dataprev flagged or a live cession holds, whose money the operador then holds. An employer_shortfall of a month a live cession holds (sold or retained) is also true: disposing it posts nothing, and a repurchase still books the employer's receivable from the escrituração.

disposedAt · string

Instant of disposition (RFC3339 UTC), present once disposed.

dispositionActor · string

Identity that disposed the item, present once disposed.

dispositionJustification · string

Free-text justification, present once disposed.

dispositionResult · string

Structured outcome, present once disposed.

lenderCalculatedAmount · string

Lender calculation. Audit evidence only, never authoritative.

openShortfall · string

Decimal string, present on a refinance_payoff_vs_rail item whose Lender payoff is above the rail's: the shortfall less every settle against the CCB residual and every clearing. A clearing (refinance_payoff_short_recovered or refinance_payoff_short_loss) moves exactly this amount.

rerunnable · boolean

True when the item is open and Requeue re-executes it: a parked payroll competência, an unserviced repasse, a renegociação link, a closed contract's month, a ceded_cash_unplaced item whose month no live cession holds, or a review hold naming money on a month a live cession holds. The re-run reads the live books and can still be refused with its reason (a contract sold again, cash the cession's desk holds, an escrituração Dataprev flagged), the item staying open. False on a closed item, where the requeue only records a retry signal, and where the item itself shows a refusal every time: an item naming the fund's money, a ceded_cash_unplaced item of a month a live cession holds.

residualAvailable · string

Decimal string, present on a refinance_payoff_vs_rail item only: the CCB residual of the same contract the shortfall can still settle against (refinance_payoff_short_settled_residual). The desk offers the settle only when it is positive and openShortfall is too.

ruleVersion · string

Version of the rule that produced the Lender calculation.