Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Invoices

List invoices

Endpoint for retrieving a list of invoices.

get/invoices/

Query parameters

branchstring

The unique identifier of the branch.

contactstring

The unique identifier of the contact.

created_ts_afterstring date-time

The timestamp in UTC when the invoice was created

created_ts_beforestring date-time

The timestamp in UTC when the invoice was created

external_idstring

External identifier

invoice_datestring date

The date of the document

modified_ts_afterstring date-time

The timestamp in UTC when the invoice was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the invoice was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectstring

The unique identifier of the project.

statusstring

The status of the invoice

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}