Skip to main content
GET
List client invoices

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Query Parameters

filter[status]
enum<string>[]

Invoices can be filtered by their status:

  • draft: the invoice was created but not validated. The invoice still needs to be validated to be paid.
  • unpaid: the invoice was created and validated. The invoice is ready to be paid.
  • canceled: the invoice was created but canceled by the initiator. The invoice it is not ready to be paid.
  • paid: the invoice was created, forwarded to the client, and successfully paid.

To filter by multiple statuses, use a comma-separated list.

Available options:
draft,
unpaid,
paid,
canceled
filter[created_at_from]
string<date-time>

Invoices can be filtered by their created_at property. This filter can be used in combination with the created_at_to query parameter to get invoices created within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-02-01T12:01:02Z"

filter[created_at_to]
string<date-time>

Invoices can be filtered by their created_at property. This filter can be used in combination with the created_at_from query parameter to get invoices created within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-04-23T16:23:00Z"

filter[updated_at_from]
string<date-time>

Invoices can be filtered by their updated_at property. This filter can be used in combination with the updated_at_to query parameter to get invoices updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-02-01T12:01:02Z"

filter[updated_at_to]
string<date-time>

Invoices can be filtered by their updated_at property. This filter can be used in combination with the updated_at_from query parameter to get invoices updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-04-23T16:23:00Z"

filter[due_date]
string<date>

Invoices can be filtered by their due_date property to get invoices with an exact due date. Please use the YYYY-MM-DD format.

Example:

"2022-03-15"

filter[due_date_from]
string<date>

Invoices can be filtered by their due_date property. This filter can be used in combination with the due_date_to query parameter to get invoices with a due date within a specific timeframe. The filter is inclusive. Please use the YYYY-MM-DD format.

Example:

"2022-02-01"

filter[due_date_to]
string<date>

Invoices can be filtered by their due_date property. This filter can be used in combination with the due_date_from query parameter to get invoices with a due date within a specific timeframe. The filter is inclusive. Please use the YYYY-MM-DD format.

Example:

"2022-04-23"

exclude_imported
boolean
default:true

Controls whether imported invoices should be excluded from the results.

  • true (default): Excludes invoices that have been imported.
  • false: Includes all invoices, including imported ones.

Note: By default, imported invoices are excluded. To retrieve imported invoices, explicitly set this parameter to false.

Example:

false

page
integer

Returned page (cf. Pagination).

Example:

1

per_page
integer
default:1

Number of invoices per page (cf. Pagination).

Required range: x >= 100
sort_by
enum<string>
default:created_at:desc

Invoices can be sorted by their created_at property in 2 possible orders: asc (Ascending) / desc (Descending).

Available options:
created_at:desc,
created_at:asc

Response

Returns the list of client invoices.

client_invoices
object[]
meta
object