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 doublesOptional

Monthly revenue data points [month, amount]

monthlyExpenseslist of lists of strings or doublesOptional

Monthly expenses data points [month, amount]

monthlyProfitlist of lists of strings or doublesOptional

Monthly profit data points [month, amount]

monthlyCashBalancelist of lists of strings or doublesOptional

Monthly cash balance data points [month, amount]

totalRevenuedoubleOptional

Total revenue for the period

totalExpensesdoubleOptional

Total expenses for the period

totalProfitdoubleOptional

Total profit for the period

currentCashBalancedoubleOptional

Current cash balance across all accounts

chartDatalist of objectsOptional

Data formatted for charts

latestMonthStatsobjectOptional
plaidAccountslist of objectsOptional

Connected Plaid accounts

filterInfoobjectOptional

Errors