oss-return · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: ossReturn · React: <FinBazeOssReturn />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`submit`	on
`inlineConsent`	on

Options#

Passed to instance.create("oss-return", options) or as props.

Option	Type
`period`	`"current" \| "previous" \| { year, quarter?, month? }`	Which period.
`filingId`	`string`	Open a specific filing instead.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`filing.submitted`	`onFilingSubmitted`
`tax_authorisation.granted`	`onTaxAuthorisationGranted`

Use it#

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

<FinBazeOssReturn />

const component = instance.create("oss-return");
component.mount("#finbaze");