Aggregate income data for a given time period

Retrieve a summary of total income earned by a specific account using Account ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your system's unique identifier for the Account

Query Params
date-time

Only aggregate income transactions from this date-time and later (inclusive). This date cannot be earlier than Jan 1 of the previous year in UTC (e.g. 2023-01-01T00:00:00.000Z if it is currently any time in 2024). Use the ISO-8601 date-time format. Defaults to Jan 1 of the current year.

date-time

Only aggregate income transactions from before this date-time (exclusive). This date must be after start_date. Use the ISO-8601 date-time format. Defaults to the current time in UTC.

string
enum

If provided, provides income aggregations rolled up into either month or year intervals. Only intervals with income transactions will be returned. If not provided, no roll ups are returned.

Allowed:
Responses

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