Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
bills
/
payments
List bill payments
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bills/payments/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_name": "<string>",
      "payment_reference": "<string>",
      "payment_date": "2023-12-25",
      "amount_cents": 123,
      "currency": "<string>",
      "payment_method": "<string>",
      "status": "<string>",
      "allocated_amount_cents": 123,
      "unallocated_amount_cents": 123,
      "is_fully_allocated": true,
      "allocations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_number": "<string>",
          "vendor_bill_number": "<string>",
          "bill_status": "<string>",
          "amount_cents": 123,
          "allocation_date": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<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>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

​
business_id
string<uuid>
required

Business UUID

Query Parameters

​
bill_id
string<uuid>

Filter by bill UUID

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
payment_date_end
string<date>

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

​
payment_date_start
string<date>

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

​
payment_method
string

Filter by payment method

​
search
string

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

​
status
string

Filter by payment status

​
vendor_id
string

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

Response

​
count
integer
required

Total number of items

Example:

123

​
page_info
object
required
Example:
{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}
​
results
object[]
required