> ## 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 accrual runs

> Returns a page of the accrual runs executed for this tenant, newest first. Filtering by correlationId returns EVERY run sharing that identifier, which is how the full lineage behind one correlation is read.



## OpenAPI

````yaml /pt/openapi/v3-current/lender.yaml get /api/v1/accrual-runs
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/accrual-runs:
    get:
      tags:
        - Accounting
      summary: List accrual runs
      description: >-
        Returns a page of the accrual runs executed for this tenant, newest
        first. Filtering by correlationId returns EVERY run sharing that
        identifier, which is how the full lineage behind one correlation is
        read.
      operationId: listAccrualRuns
      parameters:
        - description: Narrow to the runs executed on one business date.
          explode: false
          in: query
          name: businessDate
          schema:
            description: Narrow to the runs executed on one business date.
            examples:
              - '2026-06-14'
            format: date
            type: string
        - description: Narrow to one run lifecycle status.
          explode: false
          in: query
          name: status
          schema:
            description: Narrow to one run lifecycle status.
            examples:
              - queued
            maxLength: 32
            type: string
        - description: >-
            Narrow by the state of the downstream ledger posting. pending: the
            ledger has not confirmed it. posted: the ledger accepted it.
            no_items: the run recognized nothing, so nothing was sent.
          explode: false
          in: query
          name: postingStatus
          schema:
            description: >-
              Narrow by the state of the downstream ledger posting. pending: the
              ledger has not confirmed it. posted: the ledger accepted it.
              no_items: the run recognized nothing, so nothing was sent.
            enum:
              - pending
              - posted
              - no_items
            type: string
        - description: >-
            Narrow to every run sharing one correlation identifier. Several runs
            can share one, so this returns a page, not a single row.
          explode: false
          in: query
          name: correlationId
          schema:
            description: >-
              Narrow to every run sharing one correlation identifier. Several
              runs can share one, so this returns a page, not a single row.
            maxLength: 256
            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/AccrualRunListHumaBody'
          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
components:
  schemas:
    AccrualRunListHumaBody:
      additionalProperties: false
      properties:
        data:
          description: >-
            Page of accrual runs, newest first; always present, empty slice when
            none match.
          items:
            $ref: '#/components/schemas/AccrualRunReadHumaBody'
          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
    AccrualRunReadHumaBody:
      additionalProperties: false
      properties:
        businessDate:
          description: Business date the run was executed for (YYYY-MM-DD, UTC).
          examples:
            - '2026-06-14'
          type: string
        correlationId:
          description: >-
            Correlation identifier linking the run to its journal lineage and
            downstream events. Not unique: several runs can share one.
          examples:
            - accrual-run-2026-05-31
          type: string
        createdAt:
          description: Creation timestamp (RFC3339, UTC).
          examples:
            - '2026-06-14T03:00:00Z'
          type: string
        externalJournalReferenceId:
          description: >-
            Always omitted on a run: a run emits one posting per contract per
            competência per kind, so no single ledger transaction identifies it.
            The ledger's identifier is per posting — resolve one through GET
            /api/v1/journal-references with that posting's correlation
            identifier.
          type: string
        id:
          description: Accrual run identifier (uuid).
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        journalReferenceId:
          description: Journal reference (uuid) recording this run's posting lineage.
          examples:
            - 550e8400-e29b-41d4-a716-446655440001
          type: string
        postingStatus:
          description: >-
            State of the downstream ledger posting. "pending" means the ledger
            has not confirmed it, "posted" means it accepted it, "no_items"
            means the run recognized nothing so nothing was sent.
          examples:
            - pending
          type: string
        status:
          description: Lifecycle status of the run.
          examples:
            - queued
          type: string
        updatedAt:
          description: Last update timestamp (RFC3339, UTC).
          examples:
            - '2026-06-14T03:05:00Z'
          type: string
      required:
        - id
        - businessDate
        - status
        - correlationId
        - journalReferenceId
        - postingStatus
        - createdAt
        - updatedAt
      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

````