> ## Documentation Index
> Fetch the complete documentation index at: https://docs.younegotiate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Consumer Profile scheduled transactions

> Return the Payment Plans tab scheduled and failed transactions for one Consumer Profile detail page account. The account must belong to the authenticated creditor company and assigned sub-account when applicable. Remaining balance is projected from the active negotiation balance over the schedule-date order.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /manage-consumers/{consumer}/scheduled-transactions
openapi: 3.1.0
info:
  title: YouNegotiate Creditor API
  version: '2.0'
  description: >-
    Stateless API endpoints for creditor portal authentication and account
    access.
servers:
  - url: https://api.creditor.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public creditor domain system and health endpoints.
  - name: Authentication
    description: Creditor registration, login, password, and email verification endpoints.
  - name: Account Settings
    description: >-
      Authenticated creditor profile, contact, operating-hours, and
      profile-image endpoints.
  - name: Account Profile
    description: >-
      Creditor onboarding profile, membership, billing, and setup status
      endpoints.
  - name: Setup Wizard
    description: >-
      Creditor setup wizard status, required-step completion, and optional-step
      completion.
  - name: Dashboard
    description: Creditor dashboard work queues and performance widgets.
  - name: Import / Export
    description: >-
      Creditor consumer import upload sessions, queued imports, history,
      downloads, and failed-row files.
  - name: Membership Settings
    description: >-
      Creditor membership dashboard, plan changes, payment method, cancellation,
      special-plan inquiry, and over-limit retry endpoints.
  - name: Merchant Account
    description: >-
      Existing merchant processor credentials, Tilled onboarding, and merchant
      application endpoints.
  - name: Header Profiles
    description: >-
      CSV header profile upload, mapping, download, and setup wizard completion
      endpoints.
  - name: SFTP Connections
    description: >-
      Creditor-managed SFTP connection profiles for imports, exports, and setup
      wizard completion.
  - name: Sub Accounts
    description: >-
      Creditor-managed sub account list, export, create, update, and delete
      endpoints.
  - name: Pay Terms Offers
    description: >-
      Creditor-managed master, sub-account, group, and group-sub-account Pay
      Terms endpoints.
  - name: Individual Custom Offers
    description: Creditor individual custom offer list endpoints.
  - name: Negotiations
    description: >-
      Creditor negotiation work queues, including notice responses and offer
      review counts.
  - name: Communications / CFPB Validation Letter
    description: >-
      CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export,
      and print/download actions.
  - name: Communications / EcoLetter Template
    description: >-
      Creditor EcoLetter template management for secure eLetter communications
      and campaigns.
  - name: Communications / Groups
    description: >-
      Creditor communication group management for dynamic consumer targeting and
      campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Creditor EcoLetter campaign scheduling, quote, immediate send, and
      delivery queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Creditor campaign tracker reporting, refresh, and consumer export
      endpoints.
  - name: Consumer Profiles
    description: Creditor Consumer Profiles list, filter options, and CSV export endpoints.
  - name: Terms & Conditions
    description: Creditor-managed master and sub-account Terms & Conditions templates.
  - name: About Us & Contact
    description: Creditor-managed company About Us content shown to consumers.
  - name: Logo & Links
    description: >-
      Creditor-managed master and sub-account personalized logo colors, size,
      and consumer link metadata.
  - name: Users
    description: >-
      Master creditor user management, invitations, and account deletion
      endpoints.
paths:
  /manage-consumers/{consumer}/scheduled-transactions:
    get:
      tags:
        - Consumer Profiles
      summary: List Consumer Profile scheduled transactions
      description: >-
        Return the Payment Plans tab scheduled and failed transactions for one
        Consumer Profile detail page account. The account must belong to the
        authenticated creditor company and assigned sub-account when applicable.
        Remaining balance is projected from the active negotiation balance over
        the schedule-date order.
      operationId: creditorListManageConsumerScheduledTransactions
      parameters:
        - name: consumer
          in: path
          required: true
          description: Consumer account ID.
          schema:
            type: integer
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - schedule_date
              - amount
              - payment_profile
              - previous_schedule_date
              - remaining_balance
            default: schedule_date
        - name: direction
          in: query
          required: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Scheduled transactions returned.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ManageConsumerScheduledTransactionListResponse
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/ActiveMembershipRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    ManageConsumerScheduledTransactionListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ManageConsumerScheduledTransaction'
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    ManageConsumerScheduledTransaction:
      type: object
      additionalProperties: false
      required:
        - id
        - schedule_date
        - amount
        - payment_profile_label
        - frequency_label
        - previous_schedule_date
        - original_date_label
        - status
        - remaining_balance
        - actions
        - action_items
      properties:
        id:
          type: integer
        schedule_date:
          type: string
          format: date
        schedule_time:
          type: string
          nullable: true
          example: '12:00:00'
        amount:
          type: string
          example: '100.00'
        payment_profile_label:
          type: string
          example: CARD (xx-4242)
        frequency_label:
          type: string
          example: Monthly
        previous_schedule_date:
          type: string
          format: date
          nullable: true
        original_date_label:
          type: string
          example: Apr 10, 2026
        status:
          type: object
          additionalProperties: false
          required:
            - value
            - label
          properties:
            value:
              type: string
              enum:
                - scheduled
                - failed
            label:
              type: string
              description: >-
                Uses `Consumer Hold` while the consumer account is on hold;
                otherwise the scheduled transaction status label.
              example: Scheduled
        remaining_balance:
          type: string
          description: >-
            Projected remaining balance after this scheduled row in
            schedule-date order.
          example: '110.00'
        actions:
          type: object
          additionalProperties: false
          required:
            - can_change_date
            - can_skip
          properties:
            can_change_date:
              type: boolean
            can_skip:
              type: boolean
        action_items:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - label
              - available
            properties:
              key:
                type: string
                enum:
                  - change_date
                  - skip
              label:
                type: string
              available:
                type: boolean
    PaginationMeta:
      type: object
      additionalProperties: true
      properties:
        current_page:
          type: integer
        from:
          type: integer
          nullable: true
        last_page:
          type: integer
        path:
          type: string
        per_page:
          type: integer
        to:
          type: integer
          nullable: true
        total:
          type: integer
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ActiveMembershipRequired:
      description: Authenticated creditor does not have an active membership.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: An active membership is required.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````