journal · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: journal · React: <FinBazeJournal />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`create`	on
`delete`	off

Options#

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

Option	Type
`entryId`	`string`	Open this entry instead of the list.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`journal_entry.created`	`onJournalEntryCreated`
`journal_entry.deleted`	`onJournalEntryDeleted`
`journal_entry.selected`	`onJournalEntrySelected`

Use it#

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

<FinBazeJournal />

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