> ## 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.

# Settle a chart change onto every contract's balances

> Moves every live contract's balances onto the accounts the product's new chart names, one posting per contract on the effective date, so no contract ends with its balance split across two accounts. Safe to rerun at any point, including after a crash halfway through: rerunning is the recovery procedure and records nothing the first pass already recorded. It carries the same permission as the supersession itself.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles/supersessions/sweeps
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/loan-products/{id}/accounting-profiles/supersessions/sweeps:
    post:
      tags:
        - LoanProducts
      summary: Settle a chart change onto every contract's balances
      description: >-
        Moves every live contract's balances onto the accounts the product's new
        chart names, one posting per contract on the effective date, so no
        contract ends with its balance split across two accounts. Safe to rerun
        at any point, including after a crash halfway through: rerunning is the
        recovery procedure and records nothing the first pass already recorded.
        It carries the same permission as the supersession itself.
      operationId: sweepLoanProductChartBalanceTransfers
      parameters:
        - description: Loan product identifier.
          in: path
          name: id
          required: true
          schema:
            description: Loan product identifier.
            examples:
              - 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
        - description: >-
            Canonical idempotency request ID. Required: this request enqueues a
            posting per contract, and without a key a retry cannot be told apart
            from a second instruction.
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: >-
              Canonical idempotency request ID. Required: this request enqueues
              a posting per contract, and without a key a retry cannot be told
              apart from a second instruction.
            examples:
              - 550e8400-e29b-41d4-a716-446655440004
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SweepChartBalanceTransfersHumaInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SweepChartBalanceTransfersHumaBody'
          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
components:
  schemas:
    SweepChartBalanceTransfersHumaInputBody:
      additionalProperties: false
      properties:
        effectiveFrom:
          description: >-
            The civil day (YYYY-MM-DD) the chart being settled took force. The
            sweep refuses to run before that day has arrived: the balance it
            moves is the one the account holds ON that day, and until then the
            old chart is still in force and still filing postings there.
          examples:
            - '2026-08-01'
          format: date
          type: string
      required:
        - effectiveFrom
      type: object
    SweepChartBalanceTransfersHumaBody:
      additionalProperties: false
      properties:
        contractsVisited:
          description: Every contract the pass read the book for.
          examples:
            - 1200
          format: int64
          type: integer
        effectiveFrom:
          description: The civil day (YYYY-MM-DD) of the chart change settled by this pass.
          examples:
            - '2026-08-01'
          type: string
        loanProductId:
          description: The product whose contracts were swept (uuid).
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        transfersRecorded:
          description: >-
            How many of them had a balance to move. Zero on a rerun of a
            finished change.
          examples:
            - 318
          format: int64
          type: integer
      required:
        - loanProductId
        - effectiveFrom
        - contractsVisited
        - transfersRecorded
      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
    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

````