Skip to main content
GET
List bills

Authorizations

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
required
Pattern: ^[0-9a-f-]+$

Query Parameters

due_at_end
string<date-time>

Bills due on/before this timestamp (ISO format)

due_at_start
string<date-time>

Bills due on/after this timestamp (ISO format)

max_amount
integer

Maximum total amount in cents

memo
string

Exact memo match

memo_contains
string

Memo contains substring (case-insensitive)

min_amount
integer

Minimum total amount in cents

page
integer

Page number (1-indexed, default: 1)

page_size
integer

Number of items per page (default: 20, max: 100)

received_at_end
string<date-time>

Bills received on/before this timestamp (ISO format)

received_at_start
string<date-time>

Bills received on/after this timestamp (ISO format)

reference_numbers
string

Filter by reference numbers (comma-separated). Searches bill_number, vendor_bill_number, purchase_order_number

sort
string
default:-created_at

Sort order. Values: created_at, -created_at, updated_at, -updated_at (prefix with - for descending)

status
string

Filter by bill status (comma-separated). Values: received, partially_paid, paid, voided

vendor_external_id
string

Filter by vendor external ID

vendor_id
string

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

Response

200 - application/json
count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required