latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Invoices

Retrieve a list of Invoices

Retrieves a paginated list of Invoices, optionally filtered by date range.

get/v2/invoices

Query parameters

pageSizenumber

Example:10

Number of records to return per page.

pagenumber

Example:1

The page index.

dateProperty'updated' | 'created'

The invoice date field to apply the date filter to. Must be combined with dateOperator and date.

dateOperator'prev' | 'next' | 'between'

Comparison operator for the date filter. Must be combined with dateProperty and date.

datestring

Date value(s) for the filter. Format depends on dateOperator: prev / next accept a single date (YYYY-MM-DD); between accepts two dates separated by _ (YYYY-MM-DD_YYYY-MM-DD).

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

A paginated list of Invoices.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "IV-bK9r2XyZL54aWDR0",
      "uuid": "3YBIBO",
      "name": "Invoice 1",
      "notes": "This is a note for the invoice",
      "jobId": "JOB-BA5r7o4bqzR9MONa",
      "subTotal": 946,
      "taxableAmount": 946,
      "taxPercent": 10.111,
      "taxAmount": 10.51,
      "costing": 10.51,
      "techExpenses": 12.51,
      "tipAmount": 43.51,
      "totalPrice": 956.51,
      "amountDue": 956.51,
      "amountDueDate": "2026-01-01 10:00:00",
      "updated": "2026-01-01 00:00:00",
      "created": "2026-01-01 00:00:00"
    }
  ]
}