API OverviewAPI EndpointsReports

Get financial overview

Retrieves a high-level overview of financial data including balances, trends, and key metrics

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
The ID of the entity to get the overview for
startDatedatetimeOptional
Start date for the report period
endDatedatetimeOptional

End date for the report period (defaults to current date)

intervalenumOptionalDefaults to monthly
Time interval for aggregating data
Allowed values:
statusFilterenumOptionalDefaults to posted
Filter transactions by their status
Allowed values:

Response

Financial overview retrieved successfully
monthlyRevenuelist of lists of strings or doubles or null

Monthly revenue data points [month, amount]

monthlyExpenseslist of lists of strings or doubles or null

Monthly expenses data points [month, amount]

monthlyProfitlist of lists of strings or doubles or null

Monthly profit data points [month, amount]

monthlyCashBalancelist of lists of strings or doubles or null

Monthly cash balance data points [month, amount]

totalRevenuedouble or null
Total revenue for the period
totalExpensesdouble or null
Total expenses for the period
totalProfitdouble or null
Total profit for the period
currentCashBalancedouble or null
Current cash balance across all accounts
chartDatalist of objects or null
Data formatted for charts
latestMonthStatsobject or null
plaidAccountslist of objects or null
Connected Plaid accounts
filterInfoobject or null

Errors