GuidesAPI ReferenceChangelogAPI PolicyGusto Security
Guides
These docs are for v2024-03-01. Click to read the latest docs for v2025-06-15.

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

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

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

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_typeDescriptionData Dependenciesentity_typeentity_uuidFlow event triggerFlow event type
add_employeesManage all employee onboardingCompany add_addressn/an/aManualgusto:flow-finish
employee_form_signingFor employee to review and sign documentsadd_employeesEmployeeEmployee's UUIDManualgusto:flow-finish
employee_self_managementFor employee to manage their own onboardingadd_employeesEmployeeEmployee's UUIDManualgusto:flow-finish
employee_federal_setupFor managing employee's federal taxesadd_employeesEmployeeEmployee's UUIDAutomaticgusto:flow-finish
employee_state_setupFor managing employee's state taxesadd_employeesEmployeeEmployee's UUIDAutomaticgusto:flow-finish
manage_employee_addressesUpdate employee home and work addressadd_employeesEmployeeEmployee's UUIDManualgusto:flow-finish
terminationsCreate an employee terminationadd_employeesEmployeeEmployee's UUIDManualgusto:flow-finish
rehireCreate an employee rehireadd_employees, terminated employeeEmployeeEmployee's UUIDManualgusto:flow-finish
deductionsCreate and manage employee post-tax deductions/garnishmentsadd_employeesEmployeeEmployee's UUIDManualgusto:flow-finish
i9_verificationCreate an I-9 Verification FlowFully self-onboarded employeeEmployeeEmployee's UUIDManualgusto:flow-finish

Contractors

flow_typeDescriptionData Dependenciesentity_typeentity_uuidFlow event triggerFlow event type
add_contractorsManage all contractor onboardingCompanyn/an/aManualgusto:flow-finish
contractor_documentsFor contractors to review and sign documentsContractorContractorContractor UUIDManualgusto:flow-finish
contractor_self_managementFor a contractor to manage their own onboardingadd_contractorsContractorContractor UUIDManualgusto:flow-finish
contractor_paymentsRun and manage contractor payrollsOnboarded company and onboarded contractorsn/an/aManualgusto:flow-finish

Product Partnerships

flow_typeDescriptionData DependenciesAdditional DependenciesFlow event triggerFlow event type
company_workers_compensationEmployer requests workers compensation quote through Next InsuranceOnboarded companyRequires additional agreement with Next Insurance. If interested, please reach out to your Partner Success Manager.Nonen/a
company_health_insuranceEmployer requests health insurance quotes through SimplyInsuredOnboarded company, add_employeesRequires additional agreement with SimplyInsured. If interested, please reach out to your Partner Success Manager.Nonen/a
company_earned_wage_access_enrollmentEmployer opts-in to offer on-demand pay to their employees through Clairadd_employeesRequires additional agreement with Clair. If interested, please reach out to your Partner Success Manager.Nonen/a
employee_earned_wage_access_enrollmentEmployee accesses a Clair widget to sign up for a Clair accountadd_employees, Employer opts-in to offer on-demand payRequires additional agreement with Clair. If interested, please reach out to your Partner Success Manager.Nonen/a
company_retirement_benefitsEmployer connects their payroll account with their 401k offering through Guideline.Onboarded companyRequires additional agreement with Guideline. If interested, please reach out to your Partner Success Manager.Nonen/a