The transaction categorization component displays a list of transactions that have been imported into Layer. By default, the component has two tabs:
- To Review - Transactions that need to be reviewed/categorized before they will be journaled to the general ledger.
- Categorized - Transactions that have already been categorized and journaled to the general ledger.
Optional properties and useBankTransactionsContext give more control over the transactions list:
<BankTransactions
filters={{
amount: { min: 0, max: 100 },
}}
mobileComponent="mobileList"
mode='bookkeeping-client'
/>
const { setFilters } = useBankTransactionsContext()
setFilters({ amount: { min: 0, max: 10000 } })
<BankTransactions />
Properties
Component mode for different client types. Values are: self-serve or bookkeeping-client. Defaults to self-serve.
Indicates whether to use dedicated mobile-oriented layout for smaller screens. Possible values are mobileList or regularList. Defaults to regularList.
Overrides for default strings in the component.
Component header text. Defaults to “Bank Transactions”
Overrides for button CTAs in the component.
Override the “Approve” button text which saves transaction categorization. Defaults to “Approve”.
Override for the “Update” button text which updates a transaction categorization. Defaults to “Update”.
Overrides for the transactions table.
Override for the “Date” column header text. Defaults to “Date”.
transactionColumnHeaderText
Override for the “Transaction” column header text. Defaults to “Transaction”.
Override for the “Account” column header text representing the name of the source bank account. Defaults to “Account”.
Override for the “Amount” column header text. Defaults to “Amount”.
categorizeColumnHeaderText
Override for the “Categorize” column header text. Shows only for uncategorized transactions. Defaults to “Categorize”.
Override for the “Category” column header text. Shows only for categorized transactions. Defaults to “Category”.
filters
BankTransactionFilters object
Filters to apply to the transaction list.
amount
NumericRangeFilter object
Range of amounts to filter the transaction list to.
Minimum value of transactions to list.
Maximum value of transactions to list.
Id of Financial Account to filter to.
Direction of transactions to filter to. Possible values are CREDIT or DEBIT.
Show only unreviewed or categorized transactions. Possible values are TO_REVIEW or CATEGORIZED.
List of sales tax obligations on this line item.
Start date to filter transactions to.
End date to filter transactions to.
