company-settings · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: companySettings · React: <FinBazeCompanySettings />

Create the session#

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

Requirements#

No feature requirements.

Component features#

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

Feature	Default
`editCompany`	on
`financialYears`	on

Options#

Passed to instance.create("company-settings", options) or as props.

Option	Type
`tab`	`'general' \| 'tax_questions' \| 'financial_years' \| 'taxes'`	The section to open first.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`company.updated`	`onCompanyUpdated`

Use it#

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

<FinBazeCompanySettings />

const component = instance.create("company-settings");
component.mount("#finbaze");