Skip to main content
GET
List invoices

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<uuid>
required

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

Query Parameters

customer_external_id
string

Filter by customer external ID

customer_id
string

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

due_at_end
string<date-time>

Filter invoices due before this date (ISO format)

due_at_start
string<date-time>

Filter invoices due after this date (ISO format)

max_amount
integer

Maximum amount in cents

memo
string

Filter by exact memo text

memo_contains
string

Filter by memo containing text

min_amount
integer

Minimum amount in cents

page
integer

Page number (default: 1)

page_size
integer

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

reference_numbers
string

Filter by reference numbers (comma-separated)

sent_at_end
string<date-time>

Filter invoices sent before this date (ISO format)

sent_at_start
string<date-time>

Filter invoices sent after this date (ISO format)

sort
string
default:-imported_at

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

status
string

Filter by invoice status (comma-separated). Values: sent, paid, partially_paid, voided, refunded

Response

200 - application/json
count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required