Skip to main content
GET
Get Invoices

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
default:send_time
sort_direction
enum<string> | null
default:desc
Available options:
asc,
desc
location_id
string | null
search_term
string | null
rule_set_id
string | null
status
enum<string>[] | null

The status of an invoice set.

Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED,
PAID,
WILL_FAIL,
FAILED
amount
integer[] | null
created_date
string<date-time>[] | null
send_time
string<date-time>[] | null
tz
string | null

Response

Successful Response

data
InvoiceSetForTable · object[]
required
total
integer
required