Transactions
Styled transactions table showing each transaction's date, description, account, amount — printed with its own currency's symbol and followed by the ISO code, muted — and a Categorize or match field. The field opens a picker with a Categorize | Match switch: the business's categories with Split below, or the open bills for money out and open invoices for money in. Picking stages the row; the tick (✓) records it and confirms the row, which then shows a green check and stays editable. A split is built in an expanded state under the row. The header carries status and account filter dropdowns, and a “load more” banner at the bottom fetches the next page. Do it yourself shows “For Review” / “Confirmed” with no Status column; Done for you shows “In Review” / “Needs Attention” / “Confirmed” and keeps the bookkeeper note (💬) beside the tick. Notes post to the journal entry, then set bookkeeper_pending, even if previously confirmed.
Built on the headless Transactions compound from @get-asset/sdk.
Preview
Loading preview…
Required scopes
The access token used by AssetProvider must include these scopes for this primitive to fetch data successfully:
transaction:readtransaction:updateledger:readbill:readinvoice:readvendor:readcustomer:readbill:createbill:deleteinvoice:createinvoice:deleteexternal_account:readbusiness:readtag:readjournal_entry:readjournal_entry:createchat:create
API reference
Root props
| Prop | Type | Default | Description |
|---|---|---|---|
dateFrom | CalendarDateString | — | Inclusive start (YYYY-MM-DD) of a fixed reporting range. Setting it detaches the table from the provider's shared range entirely; must be paired with dateTo (one without the other throws). Use periodDateRange to derive the pair from a month, quarter, or year. |
dateTo | CalendarDateString | — | Inclusive end (YYYY-MM-DD) of a fixed reporting range. Must be paired with dateFrom. Omit both to follow the provider's DatePicker-driven range. |
plan | "managed" | "diy" | "core" | — | Override the business plan — "managed" (Done for you), or "diy" / "core" (Do it yourself, identical behaviour). Drives status labels, filter options, and actions (see Plan behaviour). Defaults to the fetched plan, or "managed". |
accountIds | string[] | — | Only include transactions for these external account ids. |
hiddenColumns | TransactionsColumn[] | — | Columns to omit from the table. Options: "date", "transaction", "tag", "account", "amount", "status", and "category". All columns are shown by default. |
ledgerType | LedgerType | — | Only include transactions whose journal entry has a line in a ledger of this type (e.g. "expense"). Always applied to the fetch. Ignored when ledgerSubtype is also set — the subtype is more granular and already implies its type. |
ledgerSubtype | LedgerSubType | — | Only include transactions whose journal entry has a line in a ledger of this subtype (e.g. "operating_expense"). Always applied to the fetch. Takes precedence over ledgerType — when both are set only the subtype is sent to the API. |
pageSize | number | — | Page size passed to the API. |
entries | TransactionOverride[] | — | Override the rows shown. Skips the API call. |
tagFields | TransactionTagField[] | — | Override the fetched tag fields (name + values), skipping the fetch. Pass [] to hide the Tag column entirely (see Tags). |
allowCreateTag | boolean | true | Allow creating new tag values from the picker (see Tags). |
onTagsChanged | (transaction, field, values) => void | — | Notification fired once per edited field after a successful tag write. |
onAddRecord | (transaction, kind: "bill" | "invoice") => void | — | Shows Add bill / Add invoice in the Match tab and receives the transaction and the kind, so you can open your own Bills or Invoices component. The table writes nothing. Omit it to hide the action. |
onRecorded | (transaction, treatment) => void | — | Called after a row's category, split or match is recorded — by the tick, or by a pick on a confirmed row. |
onConfirmed | (transaction) => void | — | Called after the tick confirms a transaction. |
feedback | boolean | false | Bring back the agent feedback form (✕) on Do it yourself rows. Off by default; the picker and the tick replace it (see Plan behaviour). |
state | "loading" | "error" | "empty" | — | Force a specific state for testing. |
className | string | — | Forwarded to the outer container element. |
States
Loading preview…
Loading preview…
Loading preview…
Loading preview…
Loading preview…
Categorize or match
The field reads what the row is, or is staged to become: a category name, the split icon with N categories, the link icon with the bill or invoice's party and number, or Choose a category. The link icon follows --asset-primary; set --asset-match-icon to give it its own colour. The picker opens on Match when the row is matched, and on Categorize otherwise; a zero-amount transaction has no Match tab.
On a row that needs review, a pick only stages it — the tick records it. When exactly one open bill or invoice has an outstanding balance equal to the row's amount, it is staged on load so one tick records the payment. On a confirmed row a pick writes at once; a matched row's payment is detached first, so the record's balance is restored.
Split opens Split transaction under the row: a category and an amount per line, with the amount Left to split (or Over by). Save is enabled only when every line has a category and an amount and the lines add up. Removing lines down to one saves that category alone. See the SDK page's Categorize or match section for the write order.
Tags
Whenever the business defines at least one tag field, a Tag column appears between Transaction and Account (and is hidden entirely otherwise). It shares the Categorize or match field's height, radius, chevron and panel. The closed state shows a quiet + Tag when a row is untagged, its first value once tagged, and value +N when it carries more — hover to see the full set. On mobile the field and the tag split the control line evenly, with the tick at the end.
Clicking the trigger opens a searchable picker grouped by field; typing a value that doesn't exist yet on a field reveals an Add "…" to <Field> row that creates it (disable this with allowCreateTag={false}).
Edits write per field, and when a field ends up with more than one value the transaction's amount is split evenly across them in reports — see the SDK page's Tags section for the full write semantics.
Plan behaviour
Some components behave differently depending on whether a bookkeeper keeps the business's books. On Done for you (the managed plan) a bookkeeper reviews and categorises the books for them. On Do it yourself (the diy and core plans) there is no bookkeeper, so the business keeps its own books — core behaves exactly like diy everywhere below. The plan is resolved from the business automatically — override it with the plan prop.
The picker and the tick behave the same on either plan, but the status labels a customer sees, the Status column, the status filter options, and the other actions all depend on whether a bookkeeper is in the loop:
| Behaviour | Done for youmanaged | Do it yourselfdiy core |
|---|---|---|
| Status labels | In Review / Needs Attention / Confirmed. | For Review / Confirmed. DIY and core behave identically; a defensive business_pending override also reads For Review. |
| Status column | Shown. | Hidden — the tick and the green check carry the status. |
| Status filter | All statuses / Needs Attention / In Review / Confirmed. | All transactions / For Review / Confirmed. |
| Actions | ✓ the tick, and 💬 leave a note for the bookkeeper | ✓ the tick; ✕ agent feedback only with feedback |
| Row click | Opens the note form, with the category breakdown when the row is split. | Nothing; with feedback, opens the feedback form. |
| Submitting | Posts a journal-entry note and sets bookkeeper_pending (In Review), including previously confirmed rows. | Runs the agent chat, then sets bookkeeper_pending (For Review) for the business to re-confirm. |