Skip to main content
POST
Close an integration case whose item was delivered by another channel

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

caseId
string<uuid>
required

Exception case identifier.

Body

application/json
disposition
string
required

Why the item is resent or how it was delivered, in the operator's own words.

Required string length: 1 - 512

Response

OK

assignmentFundId
string
required

The fund it was offered to.

assignmentSetId
string
required

The set this case happened to.

caseType
string
required

What happened: repeated_cut, remessa_conflict, remessa_divergence, offer_sent_without_remessa (the fund returned no file within its window after the offer was sent), derecognition_unpostable (the receivable's product carries no write-off posting rule), derecognition_unvaluable (the receivable's carried figure cannot be read or cannot be trusted), derecognition_already_sold (another assignment set has already sold this receivable), derecognition_unsellable (the receivable is not this tenant's to sell: suspended, excluded, ported or already discharged), derecognition_contract_closed (the receivable's debt closed after approval; the detail names the cause), transfer_absent (the administrator accepted a receivable whose title movement no registradora ever confirmed), registry_command_unconfirmed (a title transfer commanded at the registradora that never came back settled), assigned_contract_passthrough, fund_payment_divergence (what the fund paid for the lot differs from what its paid lines are due beyond the lot's tolerance; the acceptance is held, and detail.fundPayment names the numbers, amountPaid net of what the desk refunded for lines taken out), integration_item_stuck (an integration item the orchestrator could not deliver; one case per set, receivable, destination, purpose and step), or one of the lifecycle orphans.

detail
string
required

A JSON object with what a desk needs to act: the cut tally that tripped the brake, the two conflicting digests, the references that failed to reconcile. A case whose line was taken out of its lot carries removedLine: the line's frozen faceValue, assignmentPrice, discountAmount and currency, factsRecorded (paid, transferred) for how far the fund got with it, and refundToFund, what the exception desk settles with the fund for it: what the fund paid for the line less its share of the lot's accepted or tolerated difference. An integration_item_stuck case carries destination, purpose, step, itemStatus and attempts, with httpStatus, externalCode and fields when known, and once resolved by resend or delivered-outside, resolutionAction: resend or delivered_outside.

id
string
required

Case identifier (uuid).

openedAt
string
required

UTC instant the case was opened (RFC3339).

receivableRef
string
required

The one receivable this case is about; empty when the case is about a whole file.

state
string
required

open or resolved.

disposition
string

What they decided; resolved cases only.

resolvedAt
string

UTC instant it was disposed of (RFC3339); resolved cases only.

resolvedBy
string

Validated identity that disposed of it; resolved cases only.