Components
Kind: view (fills its container) · Session key: yearEnd · React: <FinBazeYearEnd />
Create the session#
mutation {
createEmbedSession(input: {
companyId: "…"
user: { externalUserId: "…" }
components: { yearEnd: { enabled: true } }
}) { clientSecret }
}
Requirements#
No feature requirements.
Component features#
Switch these off per session with components.yearEnd.features.
| Feature | Default |
|---|---|
close | on |
Options#
Passed to instance.create("year-end", options) or as props.
| Option | Type | |
|---|---|---|
yearId | string | Open this financial year instead of the list. |
Every component also takes appearance and navigation ("internal" or "external").
Events#
| Event | React prop |
|---|---|
ready | onReady |
navigate | onNavigate |
error | onError |
financial_year.closed | onFinancialYearClosed |
Use it#
import { FinBazeYearEnd } from "@finbaze/embed-react";
<FinBazeYearEnd />
const component = instance.create("year-end");
component.mount("#finbaze");