Skip to main content
GET
Get all invoices

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://dev.flextell.ai/oauth/authorize
Token URL
https://dev.flextell.ai/oauth/token

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

search
string | null

The search query.

Maximum string length: 255
status
enum<string> | null

Filter by status.

Available options:
draft,
success,
sent,
waiting,
error,
cancelled
is_archived
boolean | null

Filter by archived status.

is_draft
boolean | null

Filter by draft status.

is_cancelled
boolean | null

Filter by cancelled status.

date_from
string<date-time> | null

Filter records from this date (inclusive, YYYY-MM-DD).

date_to
string<date-time> | null

Filter records up to this date (inclusive, YYYY-MM-DD).

sort_by
enum<string> | null

The field to sort by.

Available options:
created_at,
issue_date,
document_number,
amount_payable
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100

Response

Paginated set of InvoiceResource

data
InvoiceResource · object[]
required
meta
object
required