The Company Onboarding workflow provides components for managing company-related onboarding tasks. These components can be used individually or composed into a complete workflow.
Implementation
import { Company } from '@gusto/embedded-react-sdk'
function MyApp() {
return (
<Company.OnboardingFlow companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365" onEvent={() => {}} />
)
}
Props
Name
Type
Description
companyId Required
string
The associated company identifier.
defaultValues
object
Default values for individual flow step components
onEvent Required
See events table for each subcomponent to see available events.
Using Company Subcomponents
Employee onboarding components can be used to compose your own workflow, or can be rendered in isolation. For guidance on creating a custom workflow, see docs on composition.
Available Subcomponents
Company.IndustrySelect
Company.DocumentSigner
Company.FederalTaxes
Company.PaySchedule
Company.Locations
Company.BankAccount
Company.StateTaxes
Company.OnboardingOverview
Company.DocumentSigner
Provides an interface for company representatives to read and sign required company documents. The component handles document listing, signatory management, and document signing workflow.
import { Company } from '@gusto/embedded-react-sdk'
function MyComponent() {
return (
<Company.DocumentSigner companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365" onEvent={() => {}} />
)
}
Props
Name
Type
Description
companyId (Required)
string
The associated company identifier.
signatoryId
string
ID of the signatory. When this is set and it matches the signatory ID of the currently saved signatory it is assumed the user is the signatory. This means fields are pre populated in the signature form with their information and they are able to sign documents.
onEvent (Required)
See events table for available events.
Events
Event type
Description
Data
COMPANY_VIEW_FORM_TO_SIGN
Fired when a user selects a form to sign from the document list
Default values for the company federal taxes form fields. If company data for these fields is available via the API, defaultValues will be overwritten.
onEvent (Required)
See events table for available events.
Events
Event type
Description
Data
COMPANY_FEDERAL_TAXES_UPDATED
Fired when federal tax details are successfully updated
Fired when the federal tax update process is complete
None
Company.PaySchedule
A component for managing company pay schedules, including creating, editing, and viewing pay schedules with preview functionality.
import { Company } from '@gusto/embedded-react-sdk'
function MyComponent() {
return <Company.PaySchedule companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365" onEvent={() => {}} />
}
Props
Name
Type
Description
companyId (Required)
string
The associated company identifier.
defaultValues
{ frequency?: string (one of Every Week, Every other week, Twice per month, or Monthly), anchorPayDate?: string, anchorEndOfPayPeriod?: string, day1?: number, day2?: number, customName?: string }
Default values for the pay schedule form fields. If company data for these fields is available via the API, defaultValues will be overwritten.
onEvent (Required)
See events table for available events.
Events
Event type
Description
Data
PAY_SCHEDULE_CREATED
Fired when a new pay schedule is successfully created