List invoice payments

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

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

List invoice payments

cURL

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/ \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "[e-mail]",
        "company_name": "<string>"
      },
      "customer_name": "<string>",
      "customer_email": "<string>",
      "total_amount": 123,
      "allocated_amount": 123,
      "unallocated_amount": 123,
      "net_amount": 123,
      "processing_fee": 123,
      "processing_fee_cents": 123,
      "display_amount": "<string>",
      "is_fully_allocated": true,
      "is_completed": true,
      "processed_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_number": "<string>",
          "invoice_status": "<string>",
          "amount": 123,
          "allocated_at": "2023-11-07T05:31:56Z",
          "transaction_tags": "<unknown>",
          "notes": "<string>"
        }
      ],
      "refund_allocations": [
        {
          "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount_cents": 123,
          "allocated_at": "2023-11-07T05:31:56Z",
          "reference_number": "<string>"
        }
      ],
      "reconciled_bank_transactions": [
        {
          "bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bank_transaction_date": "2023-11-07T05:31:56Z",
          "bank_transaction_amount_cents": 123,
          "bank_transaction_direction": "<string>",
          "reconciled_amount_cents": 123,
          "reconciliation_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "reconciled_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "payment_type": "<string>",
          "bank_account_name": "<string>",
          "notes": "<string>"
        }
      ],
      "external_id": "<string>",
      "payment_reference": "<string>",
      "processor_reference": "<string>",
      "payment_date": "2023-11-07T05:31:56Z",
      "payment_processor": "<string>",
      "failure_reason": "<string>",
      "transaction_tags": "<unknown>",
      "metadata": "<unknown>",
      "notes": "<string>",
      "bank_reference": "<string>"
    }
  ]
}

Authorizations

PartnerJWTBusinessScopedJWTBasicAuthBearerUnscopedBearerBusinessScoped

Authorization · string · header · required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id · string<uuid> · required

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

Query Parameters

customer_id · string

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

date_from · string<date-time>

Filter payments from this date/time (ISO format)

date_to · string<date-time>

Filter payments to this date/time (ISO format)

fully_allocated · boolean

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

invoice_id · string<uuid>

Filter by invoice ID (payments allocated to this invoice)

max_amount · integer

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

method · string

Filter by payment method

min_amount · integer

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

order · string

Sort order (asc, desc). Default: desc

page · integer

Page number (default: 1)

page_size · integer

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

processor · string

Filter by payment processor

search · string

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

sort · string

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

status · string

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

Response

200 - application/json

count · integer · required

Total number of items

Example:

123

page_info · object · required

Show child attributes

Example:

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

results · object[] · required

Show child attributes