Skip to main content
GET
List all Invoices

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Query Parameters

page
integer

Pagination: Page number

Required range: x >= 1
limit
integer

Pagination: Limit number of items per page.

Required range: 1 <= x <= 100
sort_by
enum<string>

Sorting by attribute. Default created_at

Available options:
created_at,
due_date,
updated_at
sort_direction
enum<string>

Sorting by ASC or DESC direction. Default DESC

Available options:
ASC,
DESC
contact_id
string[]

Filter by Contact IDs. Supports multiple values separated by a comma.

site_id
string[]

Filter by Site IDs. Supports multiple values separated by a comma.

subscription_id
string[]

Filter by Subscription IDs. Supports multiple values separated by a comma.

tenancy_id
string[]

Filter by Tenancy IDs. Supports multiple values separated by a comma.

expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

status
enum<string>[]

Filter by status. Supports multiple values separated by a comma.

Available options:
draft,
deleted,
open,
paid,
uncollectible,
void
type
enum<string>[]

Filter by type. Supports multiple values separated by a comma.

Available options:
subscription,
ad_hoc,
deposit
collection_status
enum<string>[]

Filter by collection status. Supports multiple values separated by a comma.

Available options:
pending,
overdue,
collected,
not_collected
created_after
string<date-time>

Filters results to created after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

created_before
string<date-time>

Filters results to created before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_after
string<date-time>

Filters results to updated after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_before
string<date-time>

Filters results to updated before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

due_after
string<date-time>

Filters results to due after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

due_before
string<date-time>

Filters results to due before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

Response

200 - application/json

list of invoices

List of Invoices

invoices
object[]
meta
object