Reports (Deprecated)

This layout is deprecated. Use the new Reports layout instead.

The reports view combines the three most common reports into a single page, including the P&L, Balance Sheet, and Cash Flow Statement. These are the tabular forms of these reports rather than interactive charts.

import { Reports } from '@layerfi/components'

<Reports
  stringOverrides={{
    title: 'My reports title',
    downloadButton: {
      downloadButtonText: 'Export',
    },
  }}
  enabledReports={['profitAndLoss']}
  renderInAppLink={convertLinkingMetadataToLink}
/>

Properties

boolean

default:"true"

Controls whether the page title/header is displayed.

ReportType[]

Array of reports to enable. Defaults to all three reports. Available values: ['profitAndLoss', 'balanceSheet', 'statementOfCashFlow']. If more than one report is enabled, view will include a tabbed interface to switch between reports.

(source: LinkingMetadata) => ReactNode

Custom function for rendering in-app navigation links. See the In-App Linking guide for details.

TimeRangePickerConfig

Show TimeRangePickerConfig properties

'full' | 'month'

Controls the granularity of date selection for the P&L report.

'CENTS' | 'DOLLAR_STRING'

Money format for CSV export. 'CENTS' formats as an integer of cents. 'DOLLAR_STRING' formats as a dollar string.

TimeRangePickerConfig

Show TimeRangePickerConfig properties

'full' | 'month'

Controls the granularity of date selection for the cash flow statement.

'CENTS' | 'DOLLAR_STRING'

Money format for CSV export.

ReportsStringOverrides

Show ReportsStringOverrides properties

string

Page title to place in the header.

ProfitAndLossDownloadButtonStringOverrides

Show ProfitAndLossDownloadButtonStringOverrides properties

string

Button text on download/export button. Defaults to “Download”.

string

Button text on download/export button, only shows upon download failure. Defaults to “Retry”.

ReportsProfitAndLossStringOverrides

Show ReportsProfitAndLossStringOverrides properties

ProfitAndLossDetailedChartsStringOverrides

Show ProfitAndLossDetailedChartsStringOverrides properties

DetailedTableStringOverrides

Show DetailedTableStringOverrides properties

string

Table column header for the category column. Defaults to “Category”.

string

Table column header for the account type column, e.g. Revenue, Expense. Defaults to “Type”.

string

Value column header showing dollar amounts. Defaults to “Value”.

ProfitAndLossTableStringOverrides

Show ProfitAndLossTableStringOverrides properties

string

Label for the “Gross Profit” row. Defaults to “Gross Profit”.

string

Label for the “Profit before taxes” row. Defaults to “Profit before taxes”.

string

Label for the “Net Profit” row. Defaults to “Net Profit”.

BalanceSheetStringOverrides

Show BalanceSheetStringOverrides properties

BalanceSheetTableStringOverrides

Show BalanceSheetTableStringOverrides properties

string

Label for the “Type” column, indicating type of account on the balance sheet, e.g. Liability. Defaults to “Type”.

string

Label for the “Total” column, indicating the total value of the account. Defaults to “Total”.

StatementOfCashFlowStringOverrides

Show StatementOfCashFlowStringOverrides properties

StatementOfCashFlowTableStringOverrides

Show StatementOfCashFlowTableStringOverrides properties

string

Label for the “Type” column, indicating type of income line statement. Defaults to “Type”.

string

Label for the “Total” column, indicating the total value of the line item. Defaults to “Total”.

Overview

Components

Layouts

Reports (Deprecated)

Properties

​Properties

Properties