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

# Schedules a proposed limit would make unviable

> The totals route seen from the other side: given a proposed limit, returns the future schedules that would exceed it, so the institution can see the consequence BEFORE concluding a reduction. This route reads -- it does not apply the reduction and does not judge it. Each item carries its date's total, so a caller can see why a small schedule is affected rather than only that it is. Nothing affected is an empty page, never null.



## OpenAPI

````yaml /pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-limit-impact
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Public API for outbound Pix transfers, refunds, and scheduled payments. This
    release provides a mock-provider integration for testing; live BACEN
    connectivity is not included.
  license:
    name: Lerian Studio General License
  title: Pix Lerian — Payments
  version: 1.0.0
servers:
  - url: https://api.example.com/spi/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Create, list, and retrieve Pix refunds.
    name: Refunds
  - name: Scheduled Payments
    description: Register, list, retrieve, and cancel scheduled Pix payments.
  - description: Initiate, process, list, and retrieve outbound Pix transfers.
    name: Transfers
paths:
  /scheduled-payment-limit-impact:
    get:
      tags:
        - Scheduled Payments
      summary: Schedules a proposed limit would make unviable
      description: >-
        The totals route seen from the other side: given a proposed limit,
        returns the future schedules that would exceed it, so the institution
        can see the consequence BEFORE concluding a reduction. This route reads
        -- it does not apply the reduction and does not judge it. Each item
        carries its date's total, so a caller can see why a small schedule is
        affected rather than only that it is. Nothing affected is an empty page,
        never null.
      operationId: getScheduledPaymentLimitImpact
      parameters:
        - description: Payer account.
          explode: false
          in: query
          name: account_id
          schema:
            description: Payer account.
            examples:
              - 019606a1-3b4c-7d8e-9f01-234567890abc
            type: string
        - description: >-
            The limit being considered. This route reports what it would break;
            it does NOT apply the reduction.
          explode: false
          in: query
          name: proposed_limit
          schema:
            description: >-
              The limit being considered. This route reports what it would
              break; it does NOT apply the reduction.
            examples:
              - '1000.00'
            type: string
        - description: Earliest settlement date to consider, inclusive.
          explode: false
          in: query
          name: start_date
          schema:
            description: Earliest settlement date to consider, inclusive.
            format: date
            type: string
        - description: Latest settlement date to consider, inclusive.
          explode: false
          in: query
          name: end_date
          schema:
            description: Latest settlement date to consider, inclusive.
            format: date
            type: string
        - description: >-
            Page size, 1..100. Absent means 20. A value outside that range is
            REFUSED, never clamped -- the same rule the sibling list route
            follows.
          explode: false
          in: query
          name: limit
          schema:
            description: >-
              Page size, 1..100. Absent means 20. A value outside that range is
              REFUSED, never clamped -- the same rule the sibling list route
              follows.
            format: int64
            type: integer
        - description: Opaque cursor from a previous page.
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque cursor from a previous page.
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitImpactPageView'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            The cursor is not one this service issued, or it was truncated
            (PIX-0789).
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            A parameter cannot be used: a proposed limit that is not a
            non-negative decimal amount (PIX-0788), a date that is not a civil
            date, or an end_date earlier than start_date. Zero IS a valid
            proposed limit and a meaningful question -- it asks what a total
            freeze would break.
components:
  schemas:
    LimitImpactPageView:
      additionalProperties: false
      properties:
        items:
          description: >-
            The affected schedules, soonest first. Empty when nothing is
            affected -- never null.
          items:
            $ref: '#/components/schemas/LimitImpactItemView'
          type:
            - array
            - 'null'
        nextCursor:
          type: string
        proposedLimit:
          description: >-
            Echoed back, so the page is self-describing when it is saved or
            forwarded.
          type: string
      required:
        - proposedLimit
        - items
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
    LimitImpactItemView:
      additionalProperties: false
      properties:
        amount:
          type: string
        dateTotal:
          description: >-
            Total scheduled for that date. It travels with the row so the caller
            sees WHY a schedule is affected rather than only that it is: a small
            schedule sharing its date with a large one is unviable because of
            the other, and without this that reads as a bug.
          type: string
        recurrenceId:
          type: string
        scheduleId:
          type: string
        scheduledDate:
          format: date
          type: string
      required:
        - scheduleId
        - scheduledDate
        - amount
        - dateTotal
      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

````