> ## 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 over-deduction refunds owed to workers

> Returns the tenant's over-deduction refund cases, oldest obligation first — payroll deducted MORE than a competência was worth and the residual is owed back to the worker. `recorded` is an open obligation and `disposed` carries the execution fact of who returned it, when, and under which reference.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/overdeduction-refunds
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/internal/br/consignado/overdeduction-refunds:
    get:
      tags:
        - Consignado
      summary: List over-deduction refunds owed to workers
      description: >-
        Returns the tenant's over-deduction refund cases, oldest obligation
        first — payroll deducted MORE than a competência was worth and the
        residual is owed back to the worker. `recorded` is an open obligation
        and `disposed` carries the execution fact of who returned it, when, and
        under which reference.
      operationId: listConsignadoOverDeductionRefunds
      parameters:
        - description: Restrict to open obligations or to returned ones. Omit for both.
          explode: false
          in: query
          name: status
          schema:
            description: Restrict to open obligations or to returned ones. Omit for both.
            enum:
              - recorded
              - disposed
            type: string
        - description: Maximum cases to return. Defaults to 50.
          explode: false
          in: query
          name: limit
          schema:
            description: Maximum cases to return. Defaults to 50.
            format: int64
            maximum: 200
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverDeductionRefundListHumaBody'
          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:
    OverDeductionRefundListHumaBody:
      additionalProperties: false
      properties:
        data:
          description: Refund cases, oldest obligation first.
          items:
            $ref: '#/components/schemas/OverDeductionRefundHumaBody'
          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
    OverDeductionRefundHumaBody:
      additionalProperties: false
      properties:
        amount:
          description: Owed back to the worker, cent scale, decimal string; never a float.
          type: string
        competencia:
          description: YYYYMM the worker was over-deducted in.
          type: string
        currency:
          description: ISO 4217 currency code.
          type: string
        detectingRunId:
          description: >-
            Reconciliation run that first observed it. Provenance, never
            identity.
          type: string
        disposedAt:
          description: >-
            UTC instant the money was returned (RFC3339). Absent while the
            obligation is open.
          type: string
        dispositionActor:
          description: Validated identity that recorded the return.
          type: string
        dispositionReference:
          description: The reference the money was returned under.
          type: string
        executionSource:
          description: Where the execution fact came from.
          type: string
        id:
          description: Case identifier (uuid).
          type: string
        loanAccountId:
          description: Servicing account the over-deduction hit (uuid).
          type: string
        numeroContrato:
          description: Contract identity on the payroll rail.
          type: string
        recordedAt:
          description: UTC instant the obligation was recorded (RFC3339).
          type: string
        reversalSourceReference:
          description: The reversal posting-intent this case is the counterpart of.
          type: string
        status:
          description: recorded is an OPEN obligation; disposed carries the execution fact.
          enum:
            - recorded
            - disposed
          type: string
      required:
        - id
        - numeroContrato
        - competencia
        - detectingRunId
        - loanAccountId
        - amount
        - currency
        - reversalSourceReference
        - status
        - recordedAt
      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

````