employees · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: employees · React: <FinBazeEmployees />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`create`	on
`edit`	on

Options#

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

Option	Type
`employeeId`	`string`	Open this employee instead of the list.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`employee.created`	`onEmployeeCreated`
`employee.updated`	`onEmployeeUpdated`
`employee.selected`	`onEmployeeSelected`

Use it#

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

<FinBazeEmployees />

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