This view provides an out of the box ready dashboard with an overview of the health, activity, and accounting status of the business.
We recommend this layout as the entrypoint to the accounting experience for users who do not have bookkeeping services.
Those with bookkeeping services should see the Bookkeeping Overview page.
The overview page consists of the interactive P&L chart, the monthly revenue & expense breakdowns, and summary cards with a CTA for uncategorized transactions.
Properties Controls whether the page title/header is displayed.
onTransactionsToReviewClick A function which navigates to the bank transactions to review page of your app. This will be triggered when clicking on the transactions-to-review CTA.
Custom content rendered between the P&L chart and the detailed charts. Use this to insert banners, CTAs, or other content into the layout.
List of colors to use for the P&L detail wheels. Specified in hex strings, i.e. ['#FF0000', '#00FF00', '#0000FF'].
slotProps AccountingOverviewSlotProps
Configuration passed through to components within the page layout. Show AccountingOverviewSlotProps properties
Show profitAndLoss properties
summaries ProfitAndLossSummariesSlotProps
Configuration for the P&L summary cards. Show ProfitAndLossSummariesSlotProps properties
reportingVariant ProfitAndLossSummariesReportingVariant
Controls which reporting mode the summary cards display. Defaults to profit and loss. Show ProfitAndLossSummariesReportingVariant properties
type 'profitAndLoss' | 'cashflow'
default: "profitAndLoss"
With 'profitAndLoss' (the default), the cards show revenue, expenses, and net profit.
With 'cashflow', the cards show money in, money out, and net cash flow.
showProfitAndLossBreakdown Only applies when type is 'cashflow'. Controls whether the money in and money out
cards include a categorized vs. uncategorized breakdown footer.
Filters P&L data by a specific tag (project/category). Show TagOption properties
Display label for the tag filter.
The tag key to filter by.
stringOverrides AccountingOverviewStringOverrides
Customize text and labels throughout the page. Show AccountingOverviewStringOverrides properties
Override the page title. Defaults to 'Accounting overview'.
Override the P&L section header text. Defaults to 'Profit & Loss'.
profitAndLoss AccountingOverviewProfitAndLossStringOverrides
Show AccountingOverviewProfitAndLossStringOverrides properties
detailedCharts ProfitAndLossDetailedChartsStringOverrides
Show ProfitAndLossDetailedChartsStringOverrides properties
detailedChartStringOverrides DetailedChartStringOverrides
Show DetailedChartStringOverrides properties
Override the header for the expenses chart. Defaults to 'Expenses'.
Override the header for the revenue chart. Defaults to 'Revenue'.
summaries ProfitAndLossSummariesStringOverrides
Show ProfitAndLossSummariesStringOverrides properties
Label for the revenue summary card.
Label for the expenses summary card.
Label for the net profit summary card.
Label for the money in summary card when using the cashflow reporting variant. Defaults to 'Money in'.
Label for the money out summary card when using the cashflow reporting variant. Defaults to 'Money out'.
Label for the net cash flow summary card when using the cashflow reporting variant. Defaults to 'Net cash flow'.
