Search Billing Activity

Returns a paginated list of billing activity transactions (invoices, payments, credits, adjustments and similar account movements) matching the supplied filter criteria. Default page is 0 and default size is 10. The maximum page size is 100, and page * size + size must not exceed 10,000.

Each record carries a signed amount (positive for debits, negative for credits). A runningBalance is included only when it is meaningful: it is omitted when transactionType or q is supplied, and when scope=COMPANY is used without a companyId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date

Return only transactions on or after this date (UTC). Must be supplied together with dateTo

date

Return only transactions on or before this date (UTC); the whole day is included. Must be supplied together with dateFrom

transactionType
array of strings

Return only transactions of these types. Accepts a comma-delimited list (?transactionType=INVOICE,PAYMENT).

transactionType
string
length ≥ 2

Free-text query matched against the transaction description, company name, transaction number and referenced document numbers, or against the transaction amount. Must be at least 2 characters

uuid

Return only transactions for this company. Cannot be combined with scope=PARTNER

string
enum

Whose activity to return. PARTNER returns the activity on your own account with Pax8; COMPANY returns the activity on your companies' accounts. When omitted, PARTNER is used, unless companyId is supplied, in which case that company's activity is returned

Allowed:
integer
1 to 100
Defaults to 10

The maximum number of transactions to return per page

integer
≥ 0
Defaults to 0

The page number to request (zero-based)

string
enum
Defaults to transactionDate,desc

Return transactions sorted by this field and direction. Formatted as fieldName,direction - ex. sort=transactionDate,asc. Defaults to transactionDate,desc (newest first)

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json