Skip to main content
GET
List Tenant Invoices

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenantUUID
string
required

UUID

Pattern: ^[a-zA-Z0-9]{8}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{12}$

Query Parameters

invoice_number
string

Filter By Invoice Number (ID)

invoice_number_bulk
any[]

Filter By Invoice Numbers Bulk

period_start
integer

Filter by Period Start Date Timestamp

period_end
integer

Filter by Period End Date Timestamp

statuses
enum<string>[]

Filter by Invoice Statuses

Available options:
paid,
unpaid,
cancelled,
refunded,
draft,
in_review
sort
string

Sort By Key

direction
enum<string>
default:desc

Sort Direction

Available options:
asc,
desc
per_page
integer
default:15

Items Per Page

Response

Invoices Collection

uuid
string
invoice_number
string
date
integer
date_due
integer
subtotal_with_taxes
number<float>
status
string
items_count
integer