Skip to main content
GET
List bills

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

startDate
string<date-time>

Inclusive start of bill-date range (required).

endDate
string<date-time>

Inclusive end of bill-date range (required).

searchFilter
string

Free-text search across common bill fields.

pageNumber
integer<int32>

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

invoiceStatus
string

Paid | Unpaid | Partially Paid | Overpaid | Cancelled.

billNowFilter
integer<int32>

0 = neither, 1 = upfront, 2 = on completion.

Response

OK

billingID
integer<int32>
engagementID
integer<int32>
engagementName
string | null
engagementStatusID
integer<int32> | null
isEngagementFinalised
boolean
clientName
string | null
billDate
string<date>
billNumber
string | null
billTotal
number<double>
billDetails
string | null
paymentTotal
number<double>
currencyID
integer<int32>
entityID
integer<int32> | null
invoiceStatus
string | null
externalID
string | null
externalNumber
string | null
externalURL
string | null
syncAttemptCount
integer<int32>
syncFailedReason
string | null