Assemble an assignment set

Composes a DRAFT set from the chosen receivables: freezes each one’s facts and prices it with the fund’s own cession rate, so the composition a manager later approves is the composition that was measured. A receivable already travelling inside another set is refused, never silently dropped.

POST /api/v1/assignment/sets

Assemble an assignment set

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fundId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receivableRefs": [
    "<string>"
  ],
  "retainedFraction": "0",
  "sellerRetainsControl": false
}
'

201

{
  "items": [
    {
      "assignmentPrice": "<string>",
      "assignmentRate": "<string>",
      "assignorRef": "<string>",
      "borrowerRef": "<string>",
      "currency": "<string>",
      "custodyComplete": true,
      "discountAmount": "<string>",
      "dossierDigest": "<string>",
      "exitReason": "<string>",
      "exitSource": "<string>",
      "faceValue": "<string>",
      "hasOpenOverdue": true,
      "installmentCount": 123,
      "itemState": "<string>",
      "outstandingBalance": "<string>",
      "paymentSourceRef": "<string>",
      "principalAmount": "<string>",
      "receivableRef": "<string>",
      "registrationActive": true,
      "repriced": true,
      "snapshotObservedAt": "<string>",
      "valuationBaseDate": "<string>",
      "valuationVersion": "<string>",
      "trailInstallmentsRemaining": 123
    }
  ],
  "set": {
    "createdAt": "<string>",
    "createdBy": "<string>",
    "currency": "<string>",
    "eligibilityCheckedAt": "<string>",
    "fundId": "<string>",
    "id": "<string>",
    "inSetItemCount": 123,
    "registryProvider": "<string>",
    "retainedFraction": "<string>",
    "retentionThreshold": "<string>",
    "riskRetention": "<string>",
    "ruleVersion": "<string>",
    "sellerRetainsControl": true,
    "state": "<string>",
    "totalAssignmentPrice": "<string>",
    "totalFaceValue": "<string>",
    "updatedAt": "<string>",
    "valuationVersion": "<string>"
  },
  "approval": {
    "approvedAt": "<string>",
    "approvedBy": "<string>",
    "contentDigest": "<string>",
    "currency": "<string>",
    "fundId": "<string>",
    "id": "<string>",
    "itemCount": 123,
    "setId": "<string>",
    "totalAssignmentPrice": "<string>",
    "trailObservedAt": "<string>",
    "valuationVersion": "<string>"
  }
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json

fundId · string<uuid> · obrigatório

Fund registration this composition is offered to. Its cession rate prices every receivable and its regulation supplies the concentration limits.

receivableRefs · string[] | null · obrigatório

The receivables the desk chose, by rail contract reference. A reference the tenant's assignable pool does not carry is refused by name — never dropped from the set silently.

Required array length: 1 - 500 elements

retainedFraction · string

The share of the expected loss this institution keeps after THIS sale, a decimal string from 0 to 1 with at most 8 decimal places (0 keeps nothing, 0.1 keeps 10%). Omit it to take the fraction the fund proposes. Whichever results is frozen onto the cession next to the institution's substantial-retention threshold of that day, and the regime is derived from those two frozen values, never re-read from the fund. Refusals: null or blank LENDER-0503; not a decimal, below 0, above 1 or more than 8 decimal places LENDER-0506; a fraction at or above the threshold (substantial retention) LENDER-0504, not bookable yet.

Exemplo:

"0"

sellerRetainsControl · boolean

Whether the seller keeps control of what THIS sale transfers, the middle band of Res. CMN 4.966 art. 26 III that a fraction cannot express. Omit it to take what the fund proposes. Refusals: null LENDER-0503; true LENDER-0505, a band this product does not book and never will.

Exemplo:

false

Resposta

201

application/json

Created

items · object[] | null · obrigatório

Every receivable ever admitted to this set, survivors and departures alike, in the order the composition was read. Always present, empty slice when none.

Show child attributes

set · object · obrigatório

The set and the aggregates of its surviving composition.

Show child attributes

approval · object

The immutable approval fact. Absent while the composition has not been approved.

Show child attributes