Skip to main content
GET
List outstanding invoices

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Query Parameters

asOfDate
string<date-time>

Report date. Default today (practice time zone).

entityKey
string

Only invoices for this client entity.

ageingBucket
string

current | 1-30 | 31-60 | 61-90 | 90+.

overdueOnly
boolean

Only invoices past their due date. Default false.

pageNumber
integer<int32>

1-based page index (1–10000). Default 1.

Response

OK

billingID
integer<int32>
billNumber
string | null
billDate
string<date>
dueDate
string<date> | null
billTotal
number<double>
paidTotal
number<double>
outstanding
number<double>
daysOverdue
integer<int32>
ageingBucket
string | null
entityID
integer<int32> | null
entityKey
string<uuid> | null
isOnboardingEntity
boolean
clientName
string | null
groupName
string | null
collectionStatus
string | null
promiseDate
string<date> | null
onPaymentPlan
boolean
hasScheduledPayment
boolean