> ## 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 assignment sets

> Returns one page of the validated tenant's sets, newest first, each with the item count and the totals of its SURVIVING composition. Optionally narrowed to one fund or one lifecycle state.



## OpenAPI

````yaml /pt/openapi/v3-current/lender.yaml get /api/v1/assignment/sets
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:
    get:
      tags:
        - AssignmentSets
      summary: List assignment sets
      description: >-
        Returns one page of the validated tenant's sets, newest first, each with
        the item count and the totals of its SURVIVING composition. Optionally
        narrowed to one fund or one lifecycle state.
      operationId: listAssignmentSets
      parameters:
        - description: Narrow to the sets offered to one fund.
          explode: false
          in: query
          name: fundId
          schema:
            description: Narrow to the sets offered to one fund.
            examples:
              - 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
        - description: >-
            Narrow to one step of the lifecycle, to cancelled for the
            compositions that were discarded, or to settled for the art. 29
            cessions whose funding obligation is extinguished.
          explode: false
          in: query
          name: state
          schema:
            description: >-
              Narrow to one step of the lifecycle, to cancelled for the
              compositions that were discarded, or to settled for the art. 29
              cessions whose funding obligation is extinguished.
            enum:
              - draft
              - eligibility_checked
              - pending_approval
              - approved
              - offer_sent
              - remessa_received
              - term_signed
              - paid
              - transferred
              - accepted
              - cancelled
              - settled
            type: string
        - description: Page size.
          explode: false
          in: query
          name: limit
          schema:
            default: 25
            description: Page size.
            format: int64
            maximum: 100
            minimum: 1
            type: integer
        - description: Page offset.
          explode: false
          in: query
          name: offset
          schema:
            default: 0
            description: Page offset.
            format: int64
            maximum: 10000
            minimum: 0
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignmentSetListHumaBody'
          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
        '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: Error
components:
  schemas:
    AssignmentSetListHumaBody:
      additionalProperties: false
      properties:
        data:
          description: >-
            One row per set, newest first; always present, empty slice when none
            match.
          items:
            $ref: '#/components/schemas/AssignmentSetHumaBody'
          type:
            - array
            - 'null'
      required:
        - data
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    AssignmentSetHumaBody:
      additionalProperties: false
      properties:
        assignorConcentrationLimit:
          description: >-
            Per-assignor concentration limit frozen from the fund at assembly,
            decimal fraction string, scale 8. Null: no per-assignor limit
            applies.
          type:
            - string
            - 'null'
        borrowerConcentrationLimit:
          description: >-
            Per-debtor concentration limit frozen from the fund at assembly,
            decimal fraction string, scale 8. Null: no per-debtor limit applies.
          type:
            - string
            - 'null'
        createdAt:
          description: Creation timestamp (RFC3339, UTC).
          type: string
        createdBy:
          description: Validated actor identity that assembled the composition.
          type: string
        currency:
          description: ISO currency code every amount of this set is denominated in.
          type: string
        eligibilityCheckedAt:
          description: Instant the composition was scored (RFC3339, UTC). Empty on a draft.
          type: string
        eligibilityMode:
          description: >-
            Eligibility mode this composition is scored and approved under,
            frozen from the fund at assembly. Under none the limits below are
            not applied.
          enum:
            - full
            - prefilter
            - none
          type: string
        fundId:
          description: Fund registration this composition is offered to.
          type: string
        fundPaidAmount:
          description: >-
            What the fund sent for the lot, as the operator last stated it on a
            paid fact, decimal string; what the desk settles for each line taken
            out is on that line's case (refundToFund). Null until the first
            paid.
          type:
            - string
            - 'null'
        id:
          description: Assignment set identifier (uuid).
          type: string
        inSetItemCount:
          description: How many receivables are still in the composition.
          format: int64
          type: integer
        paymentSourceConcentrationLimit:
          description: >-
            Per-payment-source concentration limit frozen from the fund at
            assembly, decimal fraction string, scale 8. Null: no
            per-payment-source limit applies.
          type:
            - string
            - 'null'
        paymentTolerance:
          description: >-
            How far, in the lot's currency, what the fund paid may sit from what
            its paid lines are due, frozen from the fund at assembly. 0.00 is
            exact to the centavo.
          type: string
        registryProvider:
          description: >-
            Registradora regime this cession runs under, frozen from the fund
            when the composition was assembled. The fund's registration governs
            the NEXT set, never this one.
          type: string
        retainedFraction:
          description: >-
            Share of the expected loss this institution keeps after the sale,
            frozen when the composition was assembled (the sale's own fraction,
            or the fund's proposal when the sale stated none), decimal string
            from 0 to 1, scale 8. Re-declaring the fund never changes it.
          type: string
        retentionThreshold:
          description: >-
            The institution's substantial-retention threshold in force when the
            composition was assembled, frozen next to the fraction, decimal
            string, scale 8. A later change of the threshold never re-classifies
            this cession.
          type: string
        riskRetention:
          description: >-
            Res. CMN 4.966 art. 26 regime this cession is booked under, DERIVED
            from the two frozen numbers, never declared: substantial when
            retainedFraction is at or above retentionThreshold (the asset stays
            on this balance sheet against a liability, art. 29), none below it
            (the receivables leave on acceptance, art. 28).
          type: string
        ruleVersion:
          description: >-
            Eligibility/concentration ruler that scored this composition. Empty
            on a draft nobody has measured yet.
          type: string
        sellerRetainsControl:
          description: >-
            Whether the seller keeps control of what it sold (Res. CMN 4.966
            art. 26 III), frozen at assembly. Always false on a composition that
            exists: true is refused (LENDER-0505).
          type: boolean
        state:
          description: >-
            Lifecycle state: draft, eligibility_checked, pending_approval,
            approved, offer_sent, remessa_received, term_signed, paid,
            transferred, accepted — plus cancelled, the terminal state a
            DISCARDED composition rests in. cancelled is a sideways exit, not a
            step of the forward walk: its receivables are released back to the
            assignable pool and nothing advances it.
          type: string
        termMode:
          description: >-
            Who produces the endorsement term for this cession, frozen from the
            fund at assembly: administrator_generated opens payment at the
            fund's return file, lender_emitted waits for the term the Lender
            emits. The fund's registration governs the NEXT set, never this one.
          enum:
            - lender_emitted
            - administrator_generated
          type: string
        totalAssignmentPrice:
          description: >-
            Assignment price of the SURVIVING composition, decimal string, scale
            2.
          type: string
        totalFaceValue:
          description: Face value of the SURVIVING composition, decimal string, scale 2.
          type: string
        updatedAt:
          description: Last-update timestamp (RFC3339, UTC).
          type: string
        valuationVersion:
          description: Deterministic pricing ruler every item price came out of.
          type: string
      required:
        - id
        - fundId
        - registryProvider
        - retainedFraction
        - retentionThreshold
        - sellerRetainsControl
        - termMode
        - eligibilityMode
        - borrowerConcentrationLimit
        - paymentSourceConcentrationLimit
        - assignorConcentrationLimit
        - paymentTolerance
        - fundPaidAmount
        - riskRetention
        - state
        - currency
        - valuationVersion
        - ruleVersion
        - eligibilityCheckedAt
        - createdBy
        - createdAt
        - updatedAt
        - inSetItemCount
        - totalFaceValue
        - totalAssignmentPrice
      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
  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.