uk-itsa · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: ukItsa · React: <FinBazeUkItsa />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`prepare`	on
`submit`	on
`inlineConsent`	on
`hmrcConnect`	on

Options#

Passed to instance.create("uk-itsa", options) or as props.

Option	Type
`filingId`	`string`	Open this filing instead of the list of periods.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`filing.submitted`	`onFilingSubmitted`
`hmrc.connected`	`onHmrcConnected`

Use it#

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

<FinBazeUkItsa />

const component = instance.create("uk-itsa");
component.mount("#finbaze");