Summarize Billing Activity

Returns the total debits, total credits and balance across all billing activity matching the supplied filter criteria. Accepts the same filters as Search Billing Activity; paging and sorting do not apply. The balance is omitted when transactionType or q is supplied.

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

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

date

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

transactionType
array of strings

Include 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

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

string
enum

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

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