Get financial overview
Retrieves a high-level overview of financial data including balances, trends, and key metrics
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
entityId
The ID of the entity to get the overview for
startDate
Start date for the report period
endDate
End date for the report period (defaults to current date)
interval
Time interval for aggregating data
Allowed values:
statusFilter
Filter transactions by their status
Allowed values:
Response
Financial overview retrieved successfully
monthlyRevenue
Monthly revenue data points [month, amount]
monthlyExpenses
Monthly expenses data points [month, amount]
monthlyProfit
Monthly profit data points [month, amount]
monthlyCashBalance
Monthly cash balance data points [month, amount]
totalRevenue
Total revenue for the period
totalExpenses
Total expenses for the period
totalProfit
Total profit for the period
currentCashBalance
Current cash balance across all accounts
chartData
Data formatted for charts
latestMonthStats
plaidAccounts
Connected Plaid accounts
filterInfo