> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # List an approved assignment set's receivables > Answers, in one call, the members that survive the set's approval, each with its booked terms, its canonical outstanding balance, the digests of its custodied documents and its persisted schedule. A member whose facts are not persisted now comes back as incomplete. Answers in every state after approval, cancelled included; a set never approved is refused (LENDER-0545). No personal data leaves here. ## OpenAPI ````yaml /en/openapi/v3-current/lender.yaml get /api/v1/assignment/sets/{setId}/receivables openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Code-first OpenAPI 3.1 surface for the Lender service. Routes that move money are at-most-once per X-Idempotency: when one answers 5xx, the X-Idempotency-Fenced response header says whether that key is now refusing resends (true) or free to retry (false or absent). license: name: Lerian Studio General License title: Lender API version: 1.0.0 servers: - url: https://lender.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Caller session projection: validated subject and effective permissions for the presented token. name: Session - description: >- Ledger accounting operations: journal entries and accrual postings for loan accounts. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Accounting - description: >- Loan application intake and lifecycle: submission, decisioning, and status. name: LoanApplications - description: >- Loan product catalog: definition, versioning, and activation of lending products. name: LoanProducts - description: >- Loan account servicing operations: balances, schedules, and account-level actions. name: Loan Accounts - description: >- Portfolio dashboard read operations: aggregated portfolio and performance views. name: Dashboard - description: >- Jurisdiction registry: supported jurisdiction profiles and their capabilities. name: Jurisdictions - description: >- Jurisdiction-specific loan application operations (Brazil origination surface). name: Loan Applications - description: >- Tax computation operations for jurisdiction-specific lending (e.g. Brazil IOF). name: Tax - description: >- Brazil consignado privado operations: contract lifecycle, exclusion repair, and compensating adjustments. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Consignado - description: >- Inbound record quarantine. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Streaming - description: >- Credit-instrument document template registry: versioned drafting and publication of CCB clausulado. name: DocumentTemplates paths: /api/v1/assignment/sets/{setId}/receivables: get: tags: - AssignmentDocuments summary: List an approved assignment set's receivables description: >- Answers, in one call, the members that survive the set's approval, each with its booked terms, its canonical outstanding balance, the digests of its custodied documents and its persisted schedule. A member whose facts are not persisted now comes back as incomplete. Answers in every state after approval, cancelled included; a set never approved is refused (LENDER-0545). No personal data leaves here. operationId: listAssignmentSetReceivables parameters: - description: Assignment set identifier. in: path name: setId required: true schema: description: Assignment set identifier. format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssignmentSetReceivablesHumaBody' description: OK '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable '504': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Gateway Timeout default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Any other status this operation may carry, rendered as a problem document — including a refusal produced ahead of the service, such as a gateway or ingress answering on its behalf. components: schemas: AssignmentSetReceivablesHumaBody: additionalProperties: false properties: approval: $ref: '#/components/schemas/AssignmentSetReceivablesApprovalHumaBody' data: description: >- The members surviving the approval, in ascending receivableRef order. items: $ref: '#/components/schemas/AssignmentSetReceivableHumaBody' type: array set: $ref: '#/components/schemas/AssignmentSetReceivablesSetHumaBody' required: - set - approval - data type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object AssignmentSetReceivablesApprovalHumaBody: additionalProperties: false properties: approvedAt: description: UTC approval instant (RFC3339). type: string contentDigest: description: SHA-256 hex digest of the approved composition. type: string id: description: Approval fact identifier. type: string required: - id - contentDigest - approvedAt type: object AssignmentSetReceivableHumaBody: additionalProperties: false properties: aggregates: $ref: '#/components/schemas/AssignmentSetReceivableAggregatesHumaBody' description: The schedule counted and totalled as of asOf. availableMarginAtBooking: description: >- The available payroll margin the registration reported for the borrower, before this contract's installment, decimal string at scale 2. Absent on a contract registered before the Lender stored it. type: string bookedTerms: $ref: '#/components/schemas/AssignmentSetReceivableBookedTermsHumaBody' description: The terms booked for the receivable. contractType: description: >- How the contract came to be: refinance for the new contract of a refinance, portability for a contract that arrived by portability, new otherwise. The Lender keeps no lineage for any other origin. enum: - new - refinance - portability type: string factsStatus: description: >- incomplete when the Lender holds no persisted facts for the member now, for example after a payoff or a renegotiation; such a member carries nothing else. enum: - complete - incomplete type: string identityPackDigest: description: >- SHA-256 hex digest of the custodied identity pack. Absent for a rail_proven member, which carries no artifact digests. type: string observedAt: description: UTC instant the facts were read (RFC3339). type: string outstandingBalance: $ref: '#/components/schemas/AssignmentSetReceivableBalanceHumaBody' description: The latest canonical outstanding balance. receivableRef: description: The receivable, as an opaque identifier. type: string registrationStatus: description: Registration status at the rail, opaque to this surface. type: string schedule: description: The persisted current schedule. items: $ref: '#/components/schemas/AssignmentSetReceivableInstallmentHumaBody' type: - array - 'null' scheduleAnnualRatePct: description: >- scheduleMonthlyRatePct compounded over twelve months, percent, decimal string at scale 8. type: string scheduleMonthlyRatePct: description: >- Monthly interest rate the schedule was priced at, percent, decimal string at scale 8. It differs from bookedTerms.monthlyInterestRatePct only when registration found the declared terms imply another rate. type: string signedInstrumentDigest: description: >- SHA-256 hex digest of the custodied signed instrument. Absent for a rail_proven member, which carries no artifact digests. type: string signedOn: description: >- Civil day in São Paulo the borrower consented to the credit instrument (YYYY-MM-DD); for a refinanced successor, which no one signed, the day the rail accepted the operation. type: string required: - receivableRef - factsStatus type: object AssignmentSetReceivablesSetHumaBody: additionalProperties: false properties: currency: description: ISO currency of every amount in the set. type: string fundId: description: The fund the set is offered to. type: string id: description: Assignment set identifier. type: string state: description: >- The set's lifecycle state now. The read answers in every state after approval, cancelled included. type: string required: - id - fundId - state - currency type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object AssignmentSetReceivableAggregatesHumaBody: additionalProperties: false properties: asOf: description: >- The São Paulo civil day the read was made on (YYYY-MM-DD); the cut every figure below is measured at. type: string openAmount: description: >- Sum of what the open installments still owe, decimal string at scale 2. type: string openInstallments: description: >- Installments still owing whose due day is before asOf. A partly paid installment counts here, never as paid. format: int64 type: integer paidInstallments: description: Installments with nothing left to pay. format: int64 type: integer toFallDueAmount: description: >- Sum of what the installments yet to fall due still owe, decimal string at scale 2. type: string toFallDueInstallments: description: >- Installments still owing that fall due on or after asOf. The three counts add up to the schedule's length. format: int64 type: integer required: - asOf - paidInstallments - openInstallments - toFallDueInstallments - openAmount - toFallDueAmount type: object AssignmentSetReceivableBookedTermsHumaBody: additionalProperties: false properties: cetAnnualPct: description: Annual total effective cost, percent, decimal string at scale 8. type: string cetMonthlyPct: description: Monthly total effective cost, percent, decimal string at scale 8. type: string expectedDisbursementDate: description: Expected disbursement day (YYYY-MM-DD). type: string installmentAmount: description: Booked installment, decimal string at scale 2. type: string installmentCount: description: Booked number of installments. format: int64 type: integer iofAmount: description: Booked IOF, decimal string at scale 2. type: string liberatedAmount: description: Amount released to the borrower, decimal string at scale 2. type: string loanProductVersion: description: The loan product version the contract was booked under. type: string monthlyInterestRatePct: description: >- Monthly interest rate declared at registration, percent, decimal string at scale 8. type: string principalAmount: description: Booked principal, decimal string at scale 2. type: string required: - principalAmount - liberatedAmount - installmentAmount - installmentCount - monthlyInterestRatePct - cetMonthlyPct - cetAnnualPct - iofAmount - expectedDisbursementDate - loanProductVersion type: object AssignmentSetReceivableBalanceHumaBody: additionalProperties: false properties: amount: description: Outstanding balance, decimal string at scale 2. type: string currency: description: ISO currency of the balance. type: string effectiveAt: description: UTC instant the revision is effective from (RFC3339). type: string revision: description: >- Revision of the canonical balance this figure comes from. It versions the balance only; the schedule is read separately. format: int64 type: integer required: - amount - currency - revision - effectiveAt type: object AssignmentSetReceivableInstallmentHumaBody: additionalProperties: false properties: dueDate: description: Due day (YYYY-MM-DD). type: string installmentNumber: description: Installment number. format: int64 type: integer paidAmount: description: >- What payments recorded since the current schedule version paid on the installment, net of reversals, decimal string at scale 2; 0.00 when none. Absent with scheduledAmount. type: string remainingAmount: description: >- What the installment still owes net of payments, decimal string at scale 2; 0.00 once paid. type: string scheduledAmount: description: >- The installment as the current schedule version records it, before late charges and payments, decimal string at scale 2. Absent, with paidAmount, when that version already netted earlier payments (after a prepayment or a reversal replay). type: string status: description: Installment status. type: string required: - installmentNumber - dueDate - remainingAmount - status type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.