Discard an assignment set

Calls a composition off and RELEASES its receivables back to the assignable pool. Allowed from every state except accepted, whose receivables were sold and written off, and refused for any composition that already sold part of itself: a line already accepted and written off, or a title already moved to the fund at the registry. Nothing is deleted: the set rests in the terminal cancelled state with its items, its transitions, its approval and its custodied signature evidence intact, and one append-only audit row names who called it off and why. Discarding a set that is already cancelled is inert.

POST /api/v1/assignment/sets/{setId}/discard

Discard an assignment set

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/discard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>"
}
'

200

{
  "fromState": "<string>",
  "replayed": true,
  "setId": "<string>",
  "state": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

setId · string<uuid> · requerido

Assignment set identifier.

Cuerpo

application/json

reason · enum<string> · requerido

Why the composition was called off. abandoned: nobody is going to finish it. member_ineligible: a line in it can never be sold and was holding every other line with it. counterparty_declined: the fund or its administrator walked away outside the remessa. superseded: replaced by another composition. Required — free text is a disposition nobody can count.

Opciones disponibles: abandoned, member_ineligible, counterparty_declined, superseded

note · string

The particulars, in the operator's own words. Optional; omitted rather than blanked on the audit row when there is nothing to add.

Maximum string length: 512

Respuesta

200

application/json

OK

fromState · string · requerido

Where the set stood when the decision landed, or the state it was already in on a replay.

replayed · boolean · requerido

True when this set was ALREADY discarded and nothing was written. No second audit row was appended and no second decision was recorded.

setId · string · requerido

The composition that was called off.

state · string · requerido

Always cancelled: the terminal state a discarded composition rests in. Nothing is deleted — the items, the transitions, the approval and the custodied evidence all stand.