Blocks

AssignSignatory

Lets a user either create a new signatory with full details or invite someone else to become the signatory.

Remarks

For more granular control, use CompanyOnboarding.CreateSignatory or CompanyOnboarding.InviteSignatory directly.

AssignSignatoryProps

Props for AssignSignatory.

Property	Type	Description
companyId	string	Identifier of the company the signatory is being assigned to.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	AssignSignatoryDefaultValues	Default values for the underlying create and invite forms. Provide a create object, an invite object, or both — see AssignSignatoryDefaultValues.
dictionary?	Record<"en", DeepPartial<CompanyAssignSignatory>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
signatoryId?	string	Identifier of an existing signatory. When set and matching the current signatory, the create form pre-populates with their information for editing.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/signatory/assignSignatory/modeUpdated	The user switched between create and invite modes	The selected mode string ('createSignatory' or 'inviteSignatory')
company/signatory/assignSignatory/done	The signatory assignment process completed	—
company/signatory/created	A new signatory was created (create mode)	Response from the create signatory API request
company/signatory/updated	An existing signatory was updated (create mode)	Response from the update signatory API request
company/signatory/invited	A signatory invitation was sent (invite mode)	Response from the invite signatory API request

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/signatories
POST	/v1/companies/:companyUuid/signatories
PUT	/v1/companies/:companyUuid/signatories/:signatoryUuid
DELETE	/v1/companies/:companyUuid/signatories/:signatoryUuid
POST	/v1/companies/:companyUuid/signatories/invite

---

BankAccount

Manages a company's bank account — adding, viewing, and verifying it.

Remarks

Currently supports a single default bank account per company. When no bank account exists, the component renders the add-account form; once one is on file it renders the list view with controls to change or verify the account via micro-deposits.

BankAccountProps

Props for the BankAccount component.

Property	Type	Description
companyId	string	Identifier of the company whose bank account is being managed.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyBankAccount>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/bankAccount/change	Fired when the user chooses to change an existing bank account	—
company/bankAccount/created	Fired when a new bank account is created	The created APIModels.CompanyBankAccount
company/bankAccount/verify	Fired when the user chooses to verify the bank account after micro-deposits are made	—
company/bankAccount/verified	Fired when the bank account has been successfully verified	The verified APIModels.CompanyBankAccount
company/bankAccount/done	Fired when the user chooses to proceed to the next step	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/bank_accounts
POST	/v1/companies/:companyId/bank_accounts
PUT	/v1/companies/:companyId/bank_accounts/:bankAccountUuid/verify

---

CreateSignatory

Standalone form for creating or editing a company signatory, including name, contact details, SSN, date of birth, and home address.

CreateSignatoryProps

Props for CreateSignatory.

Property	Type	Description
companyId	string	Identifier of the company the signatory belongs to.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	CreateSignatoryDefaultValues	Initial values for the form fields. Ignored for fields where a value is already available from the signatory record.
dictionary?	Record<"en", DeepPartial<CompanyAssignSignatory>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
signatoryId?	string	Identifier of an existing signatory. When provided and matching an existing signatory on the company, the form pre-populates with their information for editing.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/signatory/created	A new signatory was created successfully	The created signatory record
company/signatory/updated	An existing signatory was updated successfully	The updated signatory record
company/signatory/createSignatory/done	The create-signatory flow completed	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/signatories
POST	/v1/companies/:companyUuid/signatories
PUT	/v1/companies/:companyUuid/signatories/:signatoryUuid
DELETE	/v1/companies/:companyUuid/signatories/:signatoryUuid

---

DocumentList

Displays the list of company documents to be signed and lets the user manage signatories.

Remarks

Lower-level building block used internally by CompanyOnboarding.DocumentSigner for its list view. Use this component directly when you need full control over navigation between the document list and the signature form.

When signatoryId matches the currently saved signatory's id, the user is treated as the signatory and is allowed to sign documents.

Each form's description is rendered as returned by the API, unless the dictionary prop supplies a forms.<name>.description override for that form's name (e.g. forms.US_8655.description).

DocumentListProps

Props for DocumentList.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyDocumentList>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
signatoryId?	string	Identifier of the signatory viewing the documents. When it matches the company's saved signatory, the user is treated as that signatory and is allowed to sign documents.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/forms/view	Fired when a user selects a form to sign from the document list	The selected company form
company/forms/editSignatory	Fired when user requests to change the document signatory	The current signatory entity
company/forms/done	Fired when user completes the document signing process	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/forms
GET	/v1/companies/:companyUuid/signatories

---

DocumentSigner

Company onboarding step for reading and signing required company documents.

Remarks

Handles document listing, signatory management, and the signing workflow. If no signatory has been assigned for the company yet, the flow starts on the assign-signatory step before presenting the document list.

DocumentSignerProps

Props for DocumentSigner.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyDocumentList>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
signatoryId?	string	ID of the signatory. When set and matching the current signatory, the user is treated as the signatory and is allowed to sign documents — the signature form is pre-populated with their information.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/forms/view	Fired when a user selects a form to sign from the document list	APIModels.Form
company/forms/editSignatory	Fired when the user requests to change the document signatory	The current signatory entity
company/forms/done	Fired when the user completes the document signing process	—
company/forms/sign/signForm	Fired when a form is successfully signed	APIModels.Form
company/forms/sign/done	Fired when the form signing process is complete	—
company/forms/sign/back	Fired when the user navigates back from the signature form	—
company/signatory/assignSignatory/modeUpdated	Fired when the signatory assignment mode changes	'createSignatory' or 'inviteSignatory'
company/signatory/assignSignatory/done	Fired when the signatory assignment process is complete	—
company/signatory/created	Fired when a new signatory is created successfully	APIModels.Signatory
company/signatory/updated	Fired when an existing signatory is updated successfully	APIModels.Signatory
company/signatory/invited	Fired when a signatory is successfully invited to the company	APIModels.Signatory

Endpoints

Method	Path
GET	/v1/companies/:companyId/forms
GET	/v1/companies/:companyUuid/signatories
GET	/v1/forms/:formId
GET	/v1/forms/:formId/pdf
PUT	/v1/forms/:formId/sign

---

FederalTaxes

Collects company federal tax information including EIN, tax payer type, filing form, and legal name.

FederalTaxesProps

Props for the FederalTaxes component.

Property	Type	Description
companyId	string	Identifier of the company whose federal tax details are being collected.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	FederalTaxesDefaultValues	Pre-populated values for the federal tax form. At least one of taxPayerType, filingForm, or legalName must be provided — see FederalTaxesDefaultValues.
dictionary?	Record<"en", DeepPartial<CompanyFederalTaxes>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/federalTaxes/updated	Federal tax details were successfully updated	APIModels.FederalTaxDetails
company/federalTaxes/done	The federal tax update step is complete	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/federal_tax_details
PUT	/v1/companies/:companyId/federal_tax_details

---

Industry

Selects and saves the company's industry classification (NAICS code).

Presents a searchable list of industry options and persists the selection for the given company.

IndustryProps

Props for the Industry component.

Property	Type	Description
companyId	string	The UUID of the company whose industry classification is being set.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyIndustry>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/industry/selected	Fired when an industry is selected and saved	The updated industry returned by the industry selection endpoint

Endpoints

Method	Path
GET	/v1/companies/:companyId/industry_selection
PUT	/v1/companies/:companyId/industry_selection

---

InviteSignatory

Standalone form for inviting someone else to become the company signatory.

Remarks

The invited person receives an email to complete their signatory information. Use this when you want to provide only the invite flow without the create option.

InviteSignatoryProps

Props for the InviteSignatory component.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	InviteSignatoryDefaultValues	Default values to pre-populate the invite form fields.
dictionary?	Record<"en", DeepPartial<CompanyAssignSignatory>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/signatory/invited	A signatory was successfully invited.	The invited signatory entity.
company/signatory/inviteSignatory/done	The invite signatory process is complete.	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/signatories
DELETE	/v1/companies/:companyUuid/signatories/:signatoryUuid
POST	/v1/companies/:companyUuid/signatories/invite

---

LocationForm

Standalone form for creating a new company location or editing an existing one.

Remarks

Pass a locationId to edit an existing location; omit it to create a new one.

LocationFormProps

Props for the LocationForm component.

Property	Type	Description
companyId	string	Identifier of the company the location belongs to.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyLocations>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
locationId?	string	Identifier of an existing location. When provided, the form loads and edits that location; when omitted, the form creates a new location.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/location/add/done	Fired when a new location is created	The created location
company/location/edit/done	Fired when a location has been successfully edited	The updated location
CANCEL	Fired when the user cancels editing	—

Endpoints

Method	Path
POST	/v1/companies/:companyId/locations
GET	/v1/locations/:locationId
PUT	/v1/locations/:locationId

---

Locations

Orchestrated component for managing a company's mailing and filing addresses.

Remarks

Internally switches between a list view and a create/edit form. For more granular control, use the standalone LocationForm component directly.

LocationsProps

Props for the Locations component.

Property	Type	Description
companyId	string	Identifier of the company whose locations are being managed.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyLocations>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/location/add	A user chooses to add a new location	—
company/location/add/done	A new location is created	Response from the create company location API
company/location/edit	A user selects an existing location for editing	{ uuid: string }
company/location/edit/done	A location is successfully edited	Response from the update location API
company/location/done	A user chooses to proceed to the next step	—
cancel	A user cancels the create or edit form	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/locations
POST	/v1/companies/:companyId/locations
GET	/v1/locations/:locationId
PUT	/v1/locations/:locationId

---

LocationsList

Displays the list of work locations for a company.

Remarks

Standalone building block used internally by the orchestrated Locations component for its list view. Use this directly when you need full control over navigation between the list and form views.

LocationsListProps

Props for the LocationsList component.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyLocations>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/location/add	A user chose to add a new location	—
company/location/edit	A user chose to edit a specific location	{ uuid: string }
company/location/done	The user chose to proceed to the next step	—

Endpoints

Method	Path
GET	/v1/companies/:companyId/locations

---

OnboardingOverview

Displays the company's overall onboarding status, showing completed steps alongside any remaining requirements.

Remarks

Renders as the landing or summary screen of a company onboarding flow. When onboardingCompleted is true, a completion message and "done" action are shown; otherwise a checklist of outstanding steps is rendered with a continue action. Provide children to override the default layout while still consuming the onboarding status via context.

OnboardingOverviewProps

Props for the OnboardingOverview component.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyOnboardingOverview>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/overview/continue	Fired when the user chooses to continue to the next outstanding onboarding requirement	—
company/overview/done	Fired when the user signals they are done with the overview screen, typically after onboarding ends	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/onboarding_status

---

PaySchedule

Manages a company's pay schedules, including listing existing schedules and creating or editing one.

Remarks

Renders the schedule list when at least one pay schedule exists and the create form otherwise. Emits the following events through onEvent:

PayScheduleProps

Props for the PaySchedule component.

Property	Type	Description
companyId	string	Identifier of the company whose pay schedules are managed.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	PayScheduleDefaultValues	Default values used to pre-fill the create form. Ignored fields not listed in PayScheduleDefaultValues.
dictionary?	Record<"en", DeepPartial<CompanyPaySchedule>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
paySchedule/created	A new pay schedule was created	The created pay schedule entity
paySchedule/updated	An existing pay schedule was updated	The updated pay schedule entity

Endpoints

Method	Path
GET	/v1/companies/:companyId/employees
GET	/v1/companies/:companyId/pay_schedules
POST	/v1/companies/:companyId/pay_schedules
GET	/v1/companies/:companyId/pay_schedules/:payScheduleId
PUT	/v1/companies/:companyId/pay_schedules/:payScheduleId
POST	/v1/companies/:companyId/pay_schedules/assign
POST	/v1/companies/:companyId/pay_schedules/assignment_preview
GET	/v1/companies/:companyId/pay_schedules/assignments
GET	/v1/companies/:companyId/pay_schedules/preview
GET	/v1/companies/:companyUuid/departments
GET	/v1/companies/:companyUuid/payment_configs

---

SignatureForm

Standalone form for signing an individual company document.

Remarks

Lower-level building block used internally by the document signer for its signing view. Use this component directly when you need full control over navigation between the document list and the signature form (e.g. routing the user yourself after they select a form).

SignatureFormProps

Props for SignatureForm.

Property	Type	Description
companyId	string	The associated company identifier.
formId	string	The identifier of the form the user is signing.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
defaultValues?	undefined	Not applicable to this component — form fields are populated from the API using formId.
dictionary?	Record<"en", DeepPartial<CompanySignatureForm>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/forms/sign/signForm	Fired when a form is successfully signed	Response from the sign company form API request
company/forms/sign/back	Fired when the user navigates back from the signature form	—
company/forms/sign/done	Fired when the form signing process is complete	—

---

StateTaxes

Orchestrated flow for managing a company's state tax setup.

Remarks

Switches internally between a list of states with tax requirements and a per-state edit form. For finer-grained control over navigation, use the standalone StateTaxesList and StateTaxesForm building blocks directly.

StateTaxesProps

Props for the StateTaxes flow.

Property	Type	Default value	Description
companyId	string		UUID of the company whose state taxes are being managed.
onEvent	OnEventType<EventType, unknown>		Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyStateTaxes>>		Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
showContinueButton?	boolean	true	Controls visibility of the Continue button below the state tax list. When false, hides the Continue button. Use this when the flow is embedded as one step inside a larger flow that provides its own navigation.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/stateTaxes/edit	A state row was selected for editing	{ state: string }
company/stateTaxes/manageRates	A state row's tax rate history/scheduling view was opened	{ state: string }
company/stateTaxes/updated	State tax requirements were saved	—
company/stateTaxes/done	The list view was completed	—
CANCEL	Editing or rate management was cancelled and the list was shown again	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/tax_requirements
GET	/v1/companies/:companyUuid/tax_requirements/:state
PUT	/v1/companies/:companyUuid/tax_requirements/:state

---

StateTaxesForm

Standalone form for editing a company's state tax requirements for a single state.

Remarks

Lower-level building block used by StateTaxes for its edit view. Use directly when you need full control over navigation between the list and edit views.

Example

import { CompanyOnboarding } from '@gusto/embedded-react-sdk'

function MyComponent() {
  return (
    <CompanyOnboarding.StateTaxesForm
      companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
      state="CA"
      onEvent={() => {}}
    />
  )
}

StateTaxesFormProps

Props for StateTaxesForm.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
state	string	Two-letter code of the state whose tax requirements are edited.
dictionary?	Record<"en", DeepPartial<CompanyStateTaxes>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/stateTaxes/updated	State tax requirements were saved successfully	Response from the update state tax requirements API
CANCEL	The user cancelled editing	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/tax_requirements/:state
PUT	/v1/companies/:companyUuid/tax_requirements/:state

---

StateTaxesList

Displays the list of state tax requirements for a company with their setup status.

Remarks

Standalone building block used internally by the orchestrated StateTaxes component for its list view. Use this directly when you need full control over navigation between the list and form views.

StateTaxesListProps

Props for the StateTaxesList component.

Property	Type	Default value	Description
companyId	string		The associated company identifier.
onEvent	OnEventType<EventType, unknown>		Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
dictionary?	Record<"en", DeepPartial<CompanyStateTaxes>>		Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
showContinueButton?	boolean	true	Controls visibility of the Continue button below the state tax list. When false, hides the Continue button. Use this when the list is embedded as one step inside a larger flow that provides its own navigation.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
company/stateTaxes/edit	A user chose to edit requirements for a specific state	{ state: string }
company/stateTaxes/manageRates	A user chose to view rate history/scheduling for a specific state	{ state: string }
company/stateTaxes/done	The user chose to proceed to the next step	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/tax_requirements

---

TaxRateManagement

Standalone view of a company's effective-dated state tax rate history, with the ability to schedule a new future-dated rate.

Remarks

Lower-level building block used by StateTaxes for its "manage tax rates" view. Only effective-dated requirement keys (e.g. tax rates, deposit schedules) are shown — non-dated sections like registration numbers have no history/scheduling story and are edited via StateTaxesForm instead.

Example

import { CompanyOnboarding } from '@gusto/embedded-react-sdk'

function MyComponent() {
  return (
    <CompanyOnboarding.TaxRateManagement
      companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
      state="CA"
      onEvent={() => {}}
    />
  )
}

TaxRateManagementProps

Props for TaxRateManagement.

Property	Type	Description
companyId	string	The associated company identifier.
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
state	string	Two-letter code of the state whose tax rate history is managed.
dictionary?	Record<"en", DeepPartial<CompanyStateTaxes>>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

Inherits children, className, defaultValues, FallbackComponent, LoaderComponent from BaseComponentInterface.

Events

Event	Description	Data
CANCEL	The user navigated back to the state tax list	—

Endpoints

Method	Path
GET	/v1/companies/:companyUuid/tax_requirements/:state
PUT	/v1/companies/:companyUuid/tax_requirements/:state

---

Utility types

AssignSignatoryDefaultValues

AssignSignatoryDefaultValues = RequireAtLeastOne<{ create?: CreateSignatoryDefaultValues; invite?: InviteSignatoryDefaultValues; }>

Default values for the create and invite forms rendered by AssignSignatory.

Remarks

At least one of create or invite must be provided.

---

CreateSignatoryDefaultValues

CreateSignatoryDefaultValues = RequireAtLeastOne<Pick<Signatory, "firstName" | "lastName" | "email" | "title" | "phone" | "birthday"> & Pick<NonNullable<Signatory["homeAddress"]>, "street1" | "street2" | "city" | "state" | "zip"> & object>

Initial values for the CreateSignatory form fields. At least one field must be provided.

---

FederalTaxesDefaultValues

FederalTaxesDefaultValues = RequireAtLeastOne<{ filingForm?: FederalTaxFormInputs["filingForm"]; legalName?: FederalTaxFormInputs["legalName"]; taxPayerType?: FederalTaxFormInputs["taxPayerType"]; }>

Pre-populated values for the company federal tax form, supplied via FederalTaxesProps. At least one of taxPayerType, filingForm, or legalName must be provided.

---

InviteSignatoryDefaultValues

InviteSignatoryDefaultValues = RequireAtLeastOne<Pick<Signatory, "firstName" | "lastName" | "email" | "title"> & object>

Default values for the invite signatory form fields: firstName, lastName, email, confirmEmail, and title. At least one field is required.

---

OnboardingFlowDefaultValues

OnboardingFlowDefaultValues = RequireAtLeastOne<{ federalTaxes?: FederalTaxesDefaultValues; paySchedule?: PayScheduleDefaultValues; }>

Default values for the company onboarding flow's per-step form components.

Remarks

At least one of the step-level keys must be provided. Per-step values are forwarded to the matching step component. If company data is already available via the API, the corresponding values are overwritten.

---

PayScheduleDefaultFields

PayScheduleDefaultFields = { [K in keyof Pick<PayScheduleFormData, "anchorPayDate" | "anchorEndOfPayPeriod" | "day1" | "day2" | "customName" | "frequency" | "workweekStartDay">]: NonNullable<PayScheduleFormData[K]> }

The full set of fields that may be pre-filled on the PaySchedule create form.

---

PayScheduleDefaultValues

PayScheduleDefaultValues = RequireAtLeastOne<Partial<PayScheduleDefaultFields>>

Default values for the PaySchedule form fields. Server data for an existing pay schedule takes precedence over these defaults when editing.