> ## 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 open extraordinary-collection instructions

> Returns the instructions the client's collection agent still has to act on, oldest first. Only issued instructions still inside their own validity window appear, and only those issued to the agent this tenant currently has appointed. Leaving the window means different things by kind: a payoff amount is frozen, so a payment made at or after the window closes is no longer the amount owed and must be re-quoted, never collected — though a payment made INSIDE the window is credited whenever the file declaring it arrives. This is identical whether the worker pays it (payoff) or the institution taking the contract over pays it (payoff_portability): the frozen amount, the window and the stale-receipt refusal do not care who pays, and the kind exists so the agent knows from WHOM it collects. An arrear residual does not go stale, so it merely leaves this queue and a payment collected inside the window is still accepted when the agent declares it late. The response carries no digitable line and no barcode — the agent registers the boleto in its own account and the borrower-facing code is never ours to state.



## OpenAPI

````yaml /en/openapi/v3-current/lender.yaml get /api/v1/br/consignado/collection-instructions
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). See
    docs/contracts/money-route-idempotency.md.
  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.
    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.
    name: Consignado
  - description: >-
      Credit-instrument document template registry: versioned drafting and
      publication of CCB clausulado.
    name: DocumentTemplates
paths:
  /api/v1/br/consignado/collection-instructions:
    get:
      tags:
        - Consignado
      summary: List open extraordinary-collection instructions
      description: >-
        Returns the instructions the client's collection agent still has to act
        on, oldest first. Only issued instructions still inside their own
        validity window appear, and only those issued to the agent this tenant
        currently has appointed. Leaving the window means different things by
        kind: a payoff amount is frozen, so a payment made at or after the
        window closes is no longer the amount owed and must be re-quoted, never
        collected — though a payment made INSIDE the window is credited whenever
        the file declaring it arrives. This is identical whether the worker pays
        it (payoff) or the institution taking the contract over pays it
        (payoff_portability): the frozen amount, the window and the
        stale-receipt refusal do not care who pays, and the kind exists so the
        agent knows from WHOM it collects. An arrear residual does not go stale,
        so it merely leaves this queue and a payment collected inside the window
        is still accepted when the agent declares it late. The response carries
        no digitable line and no barcode — the agent registers the boleto in its
        own account and the borrower-facing code is never ours to state.
      operationId: listConsignadoCollectionInstructions
      parameters:
        - description: Maximum instructions to return. Defaults to 50.
          explode: false
          in: query
          name: limit
          schema:
            description: Maximum instructions to return. Defaults to 50.
            format: int64
            maximum: 200
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionInstructionListHumaBody'
          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
        '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
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    CollectionInstructionListHumaBody:
      additionalProperties: false
      properties:
        data:
          description: Open instructions, oldest first.
          items:
            $ref: '#/components/schemas/CollectionInstructionHumaBody'
          type:
            - array
            - 'null'
      required:
        - data
      type: object
    Detail:
      additionalProperties: false
      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
    CollectionInstructionHumaBody:
      additionalProperties: false
      properties:
        agentAccountId:
          description: >-
            The agent account the money is received into. Never an account of
            ours.
          type: string
        agentName:
          description: The collection agent this instruction was issued to.
          type: string
        amount:
          description: >-
            Amount to collect, cent scale, decimal string; never a float. For a
            payoff this is the FROZEN number and it does not change inside the
            window.
          type: string
        competencia:
          description: >-
            YYYYMM payroll period the instruction answers for. Absent when the
            instruction answers for the whole debt rather than one period.
          type: string
        currency:
          description: ISO 4217 currency code.
          type: string
        instructionRef:
          description: >-
            The reference the baixa file must quote back for this instruction.
            Byte-exact.
          type: string
        instrumentId:
          description: Collection instrument identifier (uuid).
          type: string
        issuedAt:
          description: UTC instant this instruction was issued (RFC3339).
          type: string
        kind:
          description: >-
            What to collect: an overdue payroll instalment residual, a frozen
            full-payoff amount the worker pays, a frozen full-payoff amount the
            institution TAKING THE CONTRACT OVER pays, or the early settlement
            owed to a fund. The four literals are the closed vocabulary the
            durable instruction CHECK admits (BR migrations 000039 and 000044).
          enum:
            - arrear
            - payoff
            - payoff_portability
            - fund_settlement
          type: string
        loanAccountId:
          description: Servicing account the collection belongs to (uuid).
          type: string
        numeroContrato:
          description: Contract identity on the payroll rail.
          type: string
        validUntil:
          description: >-
            UTC instant this instruction leaves the agent's work queue
            (RFC3339). It bounds when the borrower may PAY, never when you may
            declare it: a receipt the agent collected inside the window is
            accepted whenever the file arrives. What differs by kind is the
            payment instant itself. A payoff amount is FROZEN, so it stops being
            the amount owed — a payment the borrower made at or after this
            instant is refused and the payoff must be re-quoted. An arrear
            residual does not go stale: the instruction stays valid, so even a
            late payment is accepted.
          type: string
      required:
        - instrumentId
        - loanAccountId
        - instructionRef
        - agentName
        - agentAccountId
        - kind
        - numeroContrato
        - amount
        - currency
        - issuedAt
        - validUntil
      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

````