transactions · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: transactions · React: <FinBazeTransactions />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { transactions: { enabled: true } }
  }) { clientSecret }
}

Requirements#

The company must have these features effective: banking. A hidden feature makes createEmbedSession fail with FEATURE_DISABLED.

Component features#

Switch these off per session with components.transactions.features.

Feature	Default
`categorise`	on
`split`	on
`attachReceipt`	on
`matchInvoices`	on
`aiSuggestions`	on

Options#

Passed to instance.create("transactions", options) or as props.

Option	Type
`bankAccountId`	`string`	One bank account.
`filter`	`"all" \| "processed" \| "unprocessed"`	Initial filter.

Every component also takes appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`transaction.categorised`	`onTransactionCategorised`
`receipt.attached`	`onReceiptAttached`

Use it#

import { FinBazeTransactions } from "@finbaze/embed-react";

<FinBazeTransactions />

const component = instance.create("transactions");
component.mount("#finbaze");