THthredfi
Invoice Payments

List invoice payments

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

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)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID provided by Thred (unique identifier for the business)

Query parameters

customer_idstring

Filter by customer ID (supports comma-separated UUIDs for multiple customers)

date_fromstring date-time

Filter payments from this date/time (ISO format)

date_tostring date-time

Filter payments to this date/time (ISO format)

fully_allocatedboolean

Filter by allocation status (true=fully allocated, false=partially/unallocated)

invoice_idstring uuid

Filter by invoice ID (payments allocated to this invoice)

max_amountinteger

Maximum payment amount in cents (e.g., 100000 for €1000.00)

methodstring

Filter by payment method

min_amountinteger

Minimum payment amount in cents (e.g., 10050 for €100.50)

orderstring

Sort order (asc, desc). Default: desc

pageinteger

Page number (default: 1)

page_sizeinteger

Items per page (default: 20, max: 100)

processorstring

Filter by payment processor

searchstring

Search by payment reference, external_id, processor_reference, bank_reference, customer name, or notes

sortstring

Sort field (payment_date, amount, created_at). Default: payment_date

statusstring

Filter by payment status (pending, processing, completed, failed, cancelled, refunded)

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.