Authorizations
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
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Query Parameters
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.
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).
"2022-02-01T12:01:02Z"
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).
"2022-04-23T16:23:00Z"
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).
"2022-02-01T12:01:02Z"
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).
"2022-04-23T16:23:00Z"
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.
false
Returned page (cf. Pagination).
1
Number of invoices per page (cf. Pagination).
x >= 100Invoices can be sorted by their created_at property in 2 possible orders: asc (Ascending) / desc (Descending).
created_at:desc, created_at:asc