---
title: "List invoice payments"
method: GET
path: "/v1/platform/businesses/{business_id}/invoices/payments/"
tags: ["Invoice Payments"]
---

# List invoice payments

`GET /v1/platform/businesses/{business_id}/invoices/payments/`

## Request

- Base URL: `https://docs.thredfi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP basic
  - HTTP bearer
  - HTTP bearer

List all invoice payments for a business with filtering, pagination, and summary statistics.

## Path parameters

- `business_id` string, uuid, required

## Query parameters

- `customer_id` string
- `date_from` string, date-time
- `date_to` string, date-time
- `fully_allocated` boolean
- `invoice_id` string, uuid
- `max_amount` integer
- `method` string
- `min_amount` integer
- `order` string
- `page` integer
- `page_size` integer
- `processor` string
- `search` string
- `sort` string
- `status` string

## Response `200`

- PaginatedInvoicePaymentListList
  - `count` integer, required: Total number of items
  - `page_info` object, required
    - `total_count` integer, required: Total number of items (same as count)
    - `current_page` integer, required: Current page number (1-indexed)
    - `total_pages` integer, required: Total number of pages
    - `page_size` integer, required: Number of items per page
  - `results` InvoicePaymentList[], required
    - `id` string, uuid, required
    - `external_id` string
    - `payment_reference` string
    - `processor_reference` string
    - `customer` CustomerEmbedded, required: Customer details embedded in payment and other response objects.
      - `id` string, uuid, required: Customer UUID
      - `name` string, required: Customer display name
      - `email` string, email, required: Customer email address
      - `company_name` string, required: Company name
    - `customer_name` string, required: Customer display name
    - `customer_email` string, required: Customer email address
    - `payment_date` string, date-time
    - `payment_method` 'bank_transfer' | 'credit_card' | 'debit_card' | 'ach' | 'check' | 'cash' | 'paypal' | 'stripe' | 'other', required: * `bank_transfer` - Bank Transfer * `credit_card` - Credit Card * `debit_card` - Debit Card * `ach` - ACH/Direct Debit * `check` - Check/Cheque * `cash` - Cash * `paypal` - PayPal * `stripe` - Stripe * `other` - Other
    - `payment_processor` string
    - `currency` 'EUR' | 'GBP' | 'USD' | 'SEK' | 'NOK' | 'DKK' | 'ISK' | 'MYR' | 'SGD': * `EUR` - Euro * `GBP` - British Pound * `USD` - US Dollar * `SEK` - Swedish Krona * `NOK` - Norwegian Krone * `DKK` - Danish Krone * `ISK` - Icelandic Króna * `MYR` - Malaysian Ringgit * `SGD` - Singapore Dollar
    - `total_amount` integer, required: Total payment amount in cents
    - `allocated_amount` integer, required: Amount allocated to invoices in cents
    - `unallocated_amount` integer, required: Unallocated amount remaining in cents (customer credit if positive)
    - `net_amount` integer, required: Net amount after deducting all fees in cents
    - `processing_fee` integer, required: Platform processing fee charged in cents
    - `processing_fee_cents` integer, required: Platform processing fee charged in cents (raw database field)
    - `display_amount` string, required: Human-readable payment amount with currency symbol
    - `status` 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | 'refunded': * `pending` - Pending * `processing` - Processing * `completed` - Completed * `failed` - Failed * `cancelled` - Cancelled * `refunded` - Refunded
    - `is_fully_allocated` boolean, required: Whether payment is fully allocated to invoices (true if allocated_amount >= total_amount)
    - `is_completed` boolean, required: Whether payment processing is completed (status='completed')
    - `processed_at` string, date-time, nullable, required
    - `failed_at` string, date-time, nullable, required
    - `failure_reason` string
    - `transaction_tags` unknown
    - `metadata` unknown
    - `notes` string
    - `bank_reference` string
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `allocations` InvoicePaymentAllocationDetail[], required
      - `id` string, uuid, required
      - `invoice_id` string, uuid, required: UUID of the invoice
      - `invoice_number` string, required: Invoice number (e.g., INV-0042)
      - `invoice_status` string, required: Current invoice status (sent, paid, overdue, etc.)
      - `amount` integer, required: Amount allocated to this invoice in cents
      - `allocated_at` string, date-time, required: Date and time when allocation was created
      - `transaction_tags` unknown
      - `notes` string
    - `refund_allocations` PaymentRefundAllocationSummary[], required: Refund allocations linked to this payment
      - `refund_id` string, uuid, required
      - `reference_number` string
      - `amount_cents` integer, required
      - `allocated_at` string, date-time, required
    - `reconciled_bank_transactions` EntityReconciliationDetail[], required: Bank transactions this payment is reconciled to
      - `payment_type` string
      - `bank_transaction_id` string, uuid, required
      - `bank_transaction_date` string, date-time, required
      - `bank_transaction_amount_cents` integer, required
      - `bank_transaction_direction` string, required
      - `reconciled_amount_cents` integer, required
      - `reconciliation_link_id` string, uuid, required
      - `reconciled_at` string, date-time, required
      - `currency` string, required
      - `bank_account_name` string
      - `notes` string

---

[API](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api.md) - [All operations](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/revisions/0c1918254db3?raw)