Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The token request also needs the audience form field (the Account ID), which OAuth tooling does not always send; see POST /v1/oauth/token.

Query Parameters

page
integer<int32>
default:1

The page, from 1.

Required range: x >= 1
pageSize
integer<int32>
default:20

Invoices per page, 1 to 100.

Required range: 1 <= x <= 100
status
string

Only invoices with this status: draft, sent, viewed, paid, overdue, reminded, collection_warning, credited or bounced.

updatedSince
string<date-time>

Only invoices changed at or after this time (ISO 8601).

Response

A page of invoice summaries.

One page of a list.

items
object[]
required

The items on this page.

page
integer<int32>
required

This page's number, from 1.

pageSize
integer<int32>
required

The page size asked for.

totalCount
integer<int32>
required

How many items there are on all pages together.

hasMore
boolean
required

True when there is a next page.