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

# List loan payments

> Returns a list of loan payments across all loans for the specified business. Results are paginated; see [Pagination](/api-details/pagination) for details.



## OpenAPI

````yaml get /v1/businesses/{businessId}/loans/payments
openapi: 3.0.1
info:
  title: API
  version: latest
servers: []
security:
  - BearerAuth: []
tags: []
externalDocs:
  url: /
paths:
  /v1/businesses/{businessId}/loans/payments:
    get:
      tags: []
      summary: List loan payments
      description: >-
        Returns a list of loan payments across all loans for the specified
        business. Results are paginated; see
        [Pagination](/api-details/pagination) for details.
      operationId: business.loans.payments.get
      parameters:
        - name: businessId
          in: path
          description: The UUID of the business.
          required: true
          schema:
            type: string
            format: uuid
        - name: sort_by
          in: query
          required: false
          description: Field to sort by. Defaults to `date`.
          schema:
            type: string
            default: date
        - name: sort_order
          in: query
          required: false
          description: Sort direction. Defaults to `ASC`.
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: ASC
        - name: cursor
          in: query
          required: false
          description: >-
            Pagination cursor returned by the previous list request. Omit for
            the first page.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Maximum number of results to return. Defaults to 100.
          schema:
            type: integer
            default: 100
        - name: show_total_count
          in: query
          required: false
          description: >-
            If true, include `total_count` in the pagination metadata. Has a
            performance cost; defaults to false.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: A list of loan payments.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApiLoanPayment'
                  meta:
                    $ref: '#/components/schemas/RequestMetadata'
components:
  schemas:
    ApiLoanPayment:
      type: object
      description: >-
        A payment made against a loan, broken down into principal, interest, and
        fee splits.
      required:
        - id
        - business_id
        - loan_id
        - splits
        - amount
        - date
        - defer_posting
        - method
        - transaction_tags
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the loan payment.
        business_id:
          type: string
          format: uuid
          description: ID of the business that made the payment.
        external_id:
          type: string
          nullable: true
          description: Unique ID of the payment in your system for linking purposes.
        loan_id:
          type: string
          format: uuid
          description: ID of the loan this payment applies to.
        splits:
          type: array
          items:
            $ref: '#/components/schemas/ApiLoanPaymentSplit'
          description: The principal, interest, and fee splits that make up this payment.
        amount:
          type: integer
          format: int64
          description: Total payment amount, in cents.
        date:
          type: string
          format: date
          description: Date of the payment.
        defer_posting:
          type: boolean
          description: Whether posting to the ledger is deferred.
        method:
          $ref: '#/components/schemas/PaymentMethod'
        processor:
          type: string
          nullable: true
          description: Payment processor, if any.
        payment_clearing_account:
          allOf:
            - $ref: '#/components/schemas/SingleApiChartAccount'
          nullable: true
          description: The clearing account used for the payment, if any.
        archived_at:
          type: string
          format: date-time
          nullable: true
          description: When the payment was archived, if applicable.
        memo:
          type: string
          nullable: true
          description: Internal note about the payment.
        metadata:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            Arbitrary JSON object you can attach for your own use. Layer stores
            and returns it unchanged.
        reference_number:
          type: string
          nullable: true
          description: Reference number for the payment.
        transaction_tags:
          type: array
          items:
            $ref: '#/components/schemas/ApiTag'
          description: Tags applied to this record.
    RequestMetadata:
      type: object
      description: Request metadata. Present on paginated list responses.
      properties:
        type:
          type: string
          description: Metadata type discriminator. Value will be `request_metadata`.
          example: request_metadata
        pagination:
          $ref: '#/components/schemas/PaginationMetadata'
    ApiLoanPaymentSplit:
      type: object
      description: >-
        A split allocating part of a loan payment to principal, interest, or
        fee.
      required:
        - id
        - split_type
        - amount
        - account
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the split.
        external_id:
          type: string
          nullable: true
          description: Unique ID of the split in your system for linking purposes.
        split_type:
          $ref: '#/components/schemas/LoanPaymentSplitType'
        amount:
          type: integer
          format: int64
          description: Split amount, in cents.
        account:
          allOf:
            - $ref: '#/components/schemas/AccountIdentifier'
          description: The ledger account this split posted to.
    PaymentMethod:
      type: string
      enum:
        - CASH
        - CHECK
        - CREDIT_CARD
        - ACH
        - CREDIT_BALANCE
        - OTHER
    SingleApiChartAccount:
      type: object
      properties:
        type:
          type: string
          description: Resource type. Value will be `Single_Chart_Account`.
          example: Single_Chart_Account
        id:
          $ref: '#/components/schemas/AccountIdentifier'
        name:
          type: string
          description: Name of the account.
          example: Current Assets
        account_number:
          type: string
          nullable: true
          description: Account number if configured.
          example: '4000'
        stable_name:
          $ref: '#/components/schemas/AccountStableName'
        normality:
          $ref: '#/components/schemas/BankTransactionDirection'
        account_type:
          $ref: '#/components/schemas/ApiLedgerAccountType'
        account_subtype:
          $ref: '#/components/schemas/ApiLedgerAccountSubtype'
      description: A single ledger account without nested children.
    ApiTag:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: ID for the tag.
        key:
          type: string
          description: Key for the tag.
          example: ExampleTagKey
        dimension_display_name:
          type: string
          nullable: true
          description: Display name for the tag dimension.
        value:
          type: string
          description: Value for the tag.
          example: ExampleTagValue
        value_display_name:
          type: string
          nullable: true
          description: Display name for the tag value definition.
        dimension_id:
          type: string
          format: uuid
          description: ID of the tag dimension this tag belongs to.
        definition_id:
          type: string
          format: uuid
          description: ID of the tag value definition.
        archived_at:
          type: string
          format: date-time
          nullable: true
          description: When the tag was archived.
      required:
        - id
        - key
        - value
        - dimension_id
        - definition_id
    PaginationMetadata:
      type: object
      description: >-
        Cursor-based pagination metadata returned alongside paginated list
        responses.
      properties:
        sort_by:
          type: string
          nullable: true
          description: Field the result set is sorted by.
        sort_order:
          type: string
          enum:
            - ASC
            - DESC
          description: Sort direction applied to the result set.
        cursor:
          type: string
          nullable: true
          description: >-
            Opaque cursor to pass as `pagination_cursor` to fetch the next page.
            Null when there are no further pages.
        has_more:
          type: boolean
          description: Whether additional pages are available after the current one.
        total_count:
          type: integer
          format: int64
          nullable: true
          description: Total number of records across all pages, when available.
      required:
        - sort_by
        - sort_order
        - cursor
        - has_more
    LoanPaymentSplitType:
      type: string
      description: The portion of a loan payment a split applies to.
      enum:
        - PRINCIPAL
        - INTEREST
        - FEE
    AccountIdentifier:
      oneOf:
        - $ref: '#/components/schemas/AccountId'
          description: ID of the account.
          title: Account ID
        - $ref: '#/components/schemas/AccountStableName'
          description: Stable name associated with the account.
          title: Account Stable Name
    AccountStableName:
      type: object
      required:
        - type
        - stable_name
      properties:
        type:
          type: string
          enum:
            - StableName
          description: Resource type. Value will be `StableName`.
          example: StableName
        stable_name:
          type: string
          example: CURRENT_ASSETS
          description: Stable name of the account.
    BankTransactionDirection:
      type: string
      enum:
        - CREDIT
        - DEBIT
    ApiLedgerAccountType:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/LedgerAccountType'
          description: Type of the account.
        display_name:
          type: string
          description: Display name of the account type.
          example: Asset
    ApiLedgerAccountSubtype:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/LedgerAccountSubtype'
        display_name:
          type: string
          description: Display name of the account subtype.
          example: Current Assets
    AccountId:
      type: object
      required:
        - type
        - id
      properties:
        type:
          type: string
          enum:
            - AccountId
          description: Resource type. Value will be `AccountId`.
          example: AccountId
        id:
          type: string
          format: uuid
          description: ID of the account.
    LedgerAccountType:
      type: string
      enum:
        - ASSET
        - LIABILITY
        - EQUITY
        - REVENUE
        - EXPENSE
    LedgerAccountSubtype:
      type: string
      enum:
        - BANK_ACCOUNTS
        - ACCOUNTS_RECEIVABLE
        - INVENTORY
        - PAYMENT_PROCESSOR_CLEARING_ACCOUNT
        - FIXED_ASSET
        - ACCUMULATED_DEPRECIATION
        - CASH
        - UNDEPOSITED_FUNDS
        - CURRENT_ASSET
        - NON_CURRENT_ASSET
        - PREPAID_EXPENSES
        - DEVELOPMENT_COSTS
        - LOANS_RECEIVABLE
        - INTANGIBLE_ASSET
        - ACCOUNTS_PAYABLE
        - CREDIT_CARD
        - TAXES_PAYABLE
        - INCOME_TAXES_PAYABLE
        - SALES_TAXES_PAYABLE
        - OTHER_TAXES_PAYABLE
        - PAYROLL_TAXES_PAYABLE
        - UNEARNED_REVENUE
        - PAYROLL_LIABILITY
        - PAYROLL_CLEARING
        - LINE_OF_CREDIT
        - TIPS
        - REFUND_LIABILITIES
        - UNDEPOSITED_OUTFLOWS
        - OUTGOING_PAYMENT_CLEARING_ACCOUNT
        - OTHER_CURRENT_LIABILITY
        - LOANS_PAYABLE
        - NOTES_PAYABLE
        - SHAREHOLDER_LOAN
        - NON_CURRENT_LIABILITY
        - CONTRIBUTIONS
        - DISTRIBUTIONS
        - COMMON_STOCK
        - PREFERRED_STOCK
        - ADDITIONAL_PAID_IN_CAPITAL
        - RETAINED_EARNINGS
        - ACCUMULATED_ADJUSTMENTS
        - OPENING_BALANCE_EQUITY
        - OTHER_EQUITY
        - SALES
        - UNCATEGORIZED_REVENUE
        - RETURNS_ALLOWANCES
        - DIVIDEND_INCOME
        - INTEREST_INCOME
        - OTHER_INCOME
        - COGS
        - OPERATING_EXPENSES
        - PAYROLL
        - TAXES_LICENSES
        - UNCATEGORIZED_EXPENSE
        - CHARITABLE_CONTRIBUTIONS
        - LOAN_EXPENSES
        - FINANCE_COSTS
        - INTEREST_EXPENSES
        - DEPRECIATION
        - AMORTIZATION
        - BAD_DEBT
        - OTHER_EXPENSES
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````