THthredfi
Bill Payments

List bill payments

    List all bill payments for a business with filtering and pagination.

    **Features:**
    - Filter by status (pending, processing, completed, failed, cancelled, returned)
    - Filter by payment method
    - Filter by vendor
    - Filter by bill
    - Filter by date range
    - Search by payment reference
    - Pagination support (default: 20 per page, max: 100)

    **Use Cases:**
    - View all pending payments requiring processing
    - Monitor payment status across all bills
    - Generate payment reports
    - Reconciliation dashboard

    **Available Filters:**
    - `status`: Filter by payment status
    - `payment_method`: Filter by payment method (bank_transfer, ach, wire, check, etc.)
    - `vendor_id`: Filter by vendor UUID
    - `bill_id`: Filter by bill UUID
    - `payment_date_start` / `payment_date_end`: Filter by date range
    - `search`: Search by payment_reference, check_number, processor_payment_id
get/v1/platform/businesses/{business_id}/bills/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

Query parameters

bill_idstring uuid

Filter by bill UUID

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

payment_date_endstring date

Filter payments to this date (YYYY-MM-DD)

payment_date_startstring date

Filter payments from this date (YYYY-MM-DD)

payment_methodstring

Filter by payment method

searchstring

Search by payment reference, check number, or processor payment ID

statusstring

Filter by payment status

vendor_idstring

Filter by vendor ID (supports comma-separated UUIDs for multiple vendors)

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.