Flow types

You can try all of these flows in the Try It Now section.

Payroll

flow_type	Description	Data Dependencies	entity_type	entity_uuid	Flow event trigger	Flow event type
run_payroll	Run payrolls and manage historical payrolls	Onboarded company	n/a	n/a	Manual - `gusto:flow-finish` triggered upon click of Exit payroll button Automatic - `gusto:payroll-submitted`	`gusto:flow-finish`, `gusto:payroll-submitted`
run_payroll_read_only	A read-only version of run payroll. This encompasses the review and submit steps of run_payroll	Onboarded company, drafted payroll	Payroll	Payroll UUID	None	n/a
payroll_receipt	View a payroll receipt	Processed payroll	Payroll	Payroll UUID	Manual	`gusto:flow-finish`
contractor_payments	Run and manage contractor payrolls	Onboarded company, onboarded contractors	n/a	n/a	Manual	`gusto:flow-finish`
run_off_cycle_payroll	Run off-cycle payrolls and manage historical off-cycle payrolls	Onboarded company	n/a	n/a	Automatic	`gusto:payroll-submitted`
run_termination_payroll	Run and manage termination payrolls	Onboarded company, terminated employee	n/a	n/a	Manual - triggered upon click of Exit payroll button	`gusto:flow-finish`
payroll_history	Manage historical off-cycle and regular payrolls	Onboarded company, processed payroll	n/a	n/a	Manual	`gusto:flow-finish`
manage_payroll_schedule	Manage payroll schedules, including creating and assigning multiple pay schedules	Onboarded company	n/a	n/a	Manual	`gusto:flow-finish`
run_selected_payroll	Run a specific payroll	Onboarded company	Payroll	Payroll UUID	Manual - triggered upon click of Exit payroll button	`gusto:flow-finish`

Companies

flow_type	Description	Data Dependencies	entity_type	entity_uuid	Flow event trigger	Flow event type
company_onboarding	Full company onboarding flow	n/a	n/a	n/a	None	n/a
add_addresses	Manage company's work, mailing, and filing addresses	n/a	n/a	n/a	Manual	`gusto:flow-finish`
employee_management	Manage active, onboarding, and dismissed employees	n/a	Company	Company UUID	n/a	n/a
federal_tax_setup	Review and update company federal tax details	n/a	n/a	n/a	Automatic	`gusto:flow-finish`
select_industry	Select the company industry	n/a	n/a	n/a	Automatic	`gusto:flow-finish`
add_bank_info	Add bank info manually or via Plaid	n/a	n/a	n/a	Manual	`gusto:flow-finish`
verify_bank_info	Bank deposits verification	add_bank_info step	n/a	n/a	Manual when deposits are pending Automatic after successful verification	`gusto:flow-finish`
add_employees	Manage all employee onboarding	add_addresses	n/a	n/a	Manual	`gusto:flow-finish`
state_setup	Review and update company state taxes. At this time, this only works for pre-onboarded companies	add_addresses, add_employees	n/a	n/a	Manual	`gusto:flow-finish`
payroll_schedule	Set company's payroll schedule	n/a	n/a	n/a	Manual	`gusto:flow-finish`
sign_all_forms	Add signatory and sign company documents	add_employees, federal_tax_setup, state_setup, add_bank_info, payroll_schedule	n/a	n/a	Manual	`gusto:flow-finish`
external_payroll	Create external payrolls for companies transferring from another payroll provider after the start of the year	add_employees, federal_tax_setup, state_setup	n/a	n/a	Manual	`gusto:flow-finish`
benefits	Manage company and employee benefits	add_employees	n/a	n/a	Manual	`gusto:flow-finish`
eoy_company_review	Review company details and tax documents for end of year	Onboarded company	n/a	n/a	Manual	`gusto:flow-finish`
company_information_requests	View all information requests for a company and respond to them	Onboarded company	n/a	n/a	Manual	`gusto:flow-finish`
company_information_submission	Respond to all information requests for a company	Onboarded company	n/a	n/a	None	n/a
company_recovery_cases	View all recovery cases for a company and initiate a redebit after the bank error is resolved	Onboarded company	n/a	n/a	Manual	`gusto:flow-finish`
reports	Create custom reports for a company using custom columns, groupings, and optional filters	n/a	n/a	n/a	Manual	`gusto:flow-finish`
reports_no_pii	Create custom reports for a company using custom columns, groupings, and optional filters while excluding sensitive PII (personally identifiable information)	n/a	n/a	n/a	Manual	`gusto:flow-finish`
reverse_wire_accounts	Set up reverse wire, which authorizes Gusto to pull funds for large payrolls	add_bank_info step	n/a	n/a	None	n/a
company_suspension	Suspend a company	Onboarded company	n/a	n/a	Manual	`gusto:flow-finish`
xero_accounting_integration	Complete end-to-end integration setup for Xero	Onboarded company	n/a	n/a	Automatic - Triggers on completion of all mappings	`gusto:flow-finish`
xero_mappings	Account mapping configuration only for custom navigation with Xero	Onboarded company	n/a	n/a	Automatic - Triggers on completion of all mappings	`gusto:flow-finish`
xero_settings	Integration settings management for custom navigation with Xero	Onboarded company	n/a	n/a	None	n/a
xero_payrolls_to_sync	Payroll synchronization interface for custom navigation with Xero	Onboarded company, processed payroll	n/a	n/a	None	n/a
quickbooks_accounting_integration	Complete end-to-end integration setup for QBO	Onboarded company	n/a	n/a	Automatic - Triggers on completion of all mappings	`gusto:flow-finish`

W2 Employee

flow_type	Description	Data Dependencies	entity_type	entity_uuid	Flow event type	Flow event type
add_employees	Manage all employee onboarding	Company add_address	n/a	n/a	Manual	`gusto:flow-finish`
employee_form_signing	For employee to review and sign documents	add_employees	Employee	Employee's UUID	Manual	`gusto:flow-finish`
employee_self_management	For employee to manage their own onboarding	add_employees	Employee	Employee's UUID	Manual	`gusto:flow-finish`
employee_federal_setup	For managing employee's federal taxes	add_employees	Employee	Employee's UUID	Automatic	`gusto:flow-finish`
employee_state_setup	For managing employee's state taxes	add_employees	Employee	Employee's UUID	Automatic	`gusto:flow-finish`
manage_employee_addresses	Update employee home and work address	add_employees	Employee	Employee's UUID	Manual	`gusto:flow-finish`
terminations	Create an employee termination	add_employees	Employee	Employee's UUID	Manual	`gusto:flow-finish`
rehire	Create an employee rehire	add_employees, terminated employee	Employee	Employee's UUID	Manual	`gusto:flow-finish`
deductions	Create and manage employee post-tax deductions/garnishments	add_employees	Employee	Employee's UUID	Manual	`gusto:flow-finish`
i9_verification	Create an I-9 Verification Flow	Fully self-onboarded employee	Employee	Employee's UUID	Manual	`gusto:flow-finish`

Contractors

flow_type	Description	Data Dependencies	entity_type	entity_uuid	Flow event type
add_contractors	Manage all contractor onboarding	Company	n/a	n/a	Manual	`gusto:flow-finish`
contractor_documents	For contractors to review and sign documents	Contractor	Contractor	Contractor UUID	Manual	`gusto:flow-finish`
contractor_self_management	For a contractor to manage their own onboarding	add_contractors	Contractor	Contractor UUID	Manual	`gusto:flow-finish`
contractor_payments	Run and manage contractor payrolls	Onboarded company and onboarded contractors	n/a	n/a	Manual	`gusto:flow-finish`

Product Partnerships

flow_type	Description	Options	Data Dependencies	Additional Dependencies	Flow event trigger	Flow event type
company_workers_compensation	Employer requests workers compensation quote through Next Insurance	n/a	Onboarded company	Requires additional agreement with Next Insurance. If interested, please reach out to your Partner Success Manager.	None	n/a
company_health_insurance	Employer requests health insurance quotes through SimplyInsured	n/a	Onboarded company, add_employees	Requires additional agreement with SimplyInsured. If interested, please reach out to your Partner Success Manager.	None	n/a
company_earned_wage_access_enrollment	Employer opts-in to offer on-demand pay to their employees through Clair	n/a	add_employees	Requires additional agreement with Clair. If interested, please reach out to your Partner Success Manager.	None	n/a
employee_earned_wage_access_enrollment	Employee accesses a Clair widget to sign up for a Clair account	n/a	add_employees, Employer opts-in to offer on-demand pay	Requires additional agreement with Clair. If interested, please reach out to your Partner Success Manager.	None	n/a
company_retirement_benefits	Employer connects their payroll account with their 401k offering through Guideline or Vestwell.	Specify `provider` in the `options` object. Allowed values are `guideline` or `vestwell`.	Onboarded company	Requires additional agreement with the benefits provider. If interested, please reach out to your Partner Success Manager.	None	n/a