GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security

Flow Types

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

Payroll

flow_typeDescriptionData Dependenciesentity_typeentity_uuid
run_payrollRun payrolls and manage historical payrollsOnboarded companyn/an/a
run_payroll_read_onlyA read-only version of run payroll. This encompasses the review and submit steps of run_payrollOnboarded company, drafted payrollPayrollPayroll UUID
payroll_receiptView a payroll receiptProcessed payrollPayrollPayroll UUID
contractor_paymentsRun and manage contractor payrollsOnboarded company, onboarded contractorsn/an/a
run_off_cycle_payrollRun off-cycle payrolls and manage historical off-cycle payrollsOnboarded companyn/an/a
run_termination_payrollRun and manage termination payrollsOnboarded company, terminated employeen/an/a
payroll_historyManage historical off-cycle and regular payrollsOnboarded company, processed payrolln/an/a
manage_payroll_scheduleManage payroll schedules, including creating and assigning multiple pay schedulesOnboarded companyn/an/a

Companies

flow_typeDescriptionData Dependenciesentity_typeentity_uuid
company_onboardingFull company onboarding flown/an/an/a
add_addressesManage company's work, mailing, and filing addressesn/an/an/a
federal_tax_setupReview and update company federal tax detailsn/an/an/a
select_industrySelect the company industryn/an/an/a
add_bank_infoAdd bank info manually or via Plaidn/an/an/a
verify_bank_infoBank deposits verificationadd_bank_info stepn/an/a
add_employeesManage all employee onboardingadd_addressesn/an/a
state_setupReview and update company state taxes. At this time, this only works for pre-onboarded companiesadd_addresses, add_employeesn/an/a
payroll_scheduleSet company's payroll schedulen/an/an/a
sign_all_formsAdd signatory and sign company documentsadd_employees, federal_tax_setup, state_setup, add_bank_info, payroll_schedulen/an/a
external_payrollCreate external payrolls for companies transferring from another payroll provider after the start of the yearadd_employees, federal_tax_setup, state_setupn/an/a
benefitsManage company and employee benefitsadd_employeesn/an/a
eoy_company_reviewReview company details and tax documents for end of yearOnboarded companyn/an/a
company_information_requestsView all information requests for a company and respond to themOnboarded companyn/an/a
company_recovery_casesView all recovery cases for a company and initiate a redebit after the bank error is resolvedOnboarded companyn/an/a

W2 Employee

flow_typeDescriptionData Dependenciesentity_typeentity_uuid
add_employeesManage all employee onboardingCompany add_addressn/an/a
employee_form_signingFor employee to review and sign documentsadd_employeesEmployeeEmployee's UUID
employee_self_managementFor employee to manage their own onboardingadd_employeesEmployeeEmployee's UUID
employee_state_setupFor managing employee's state taxesadd_employeesEmployeeEmployee's UUID
terminationsCreate an employee terminationadd_employeesEmployeeEmployee's UUID
rehireCreate an employee rehireadd_employees, terminated employeeEmployeeEmployee's UUID
manage_employee_addressesUpdate employee home and work addressadd_employeesEmployeeEmployee's UUID

Contractors

flow_typeDescriptionData Dependenciesentity_typeentity_uuid
add_contractorsManage all contractor onboardingCompanyn/an/a
contractor_documentsFor contractors to review and sign documentsContractorContractorContractor UUID
contractor_self_managementFor a contractor to manage their own onboardingadd_contractorsContractorContractor UUID
contractor_paymentsRun and manage contractor payrollsOnboarded company and onboarded contractorsn/an/a

Product Partnerships

flow_typeDescriptionData DependenciesAdditional Dependencies
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.
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.
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.
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.