Jump to Content

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
run_payroll	Run payrolls and manage historical payrolls	Onboarded company	n/a	n/a
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
payroll_receipt	View a payroll receipt	Processed payroll	Payroll	Payroll UUID
contractor_payments	Run and manage contractor payrolls	Onboarded company, onboarded contractors	n/a	n/a
run_off_cycle_payroll	Run off-cycle payrolls and manage historical off-cycle payrolls	Onboarded company	n/a	n/a
run_termination_payroll	Run and manage termination payrolls	Onboarded company, terminated employee	n/a	n/a
payroll_history	Manage historical off-cycle and regular payrolls	Onboarded company, processed payroll	n/a	n/a

Companies

flow_type	Description	Data Dependencies	entity_type	entity_uuid
company_onboarding	Full company onboarding flow	n/a	n/a	n/a
add_addresses	Manage company's work, mailing, and filing addresses	n/a	n/a	n/a
federal_tax_setup	Review and update company federal tax details	n/a	n/a	n/a
select_industry	Select the company industry	n/a	n/a	n/a
add_bank_info	Add bank info manually or via Plaid	n/a	n/a	n/a
verify_bank_info	Bank deposits verification	add_bank_info step	n/a	n/a
add_employees	Manage all employee onboarding	add_addresses	n/a	n/a
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
payroll_schedule	Set company's payroll schedule	n/a	n/a	n/a
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
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
benefits	Manage company and employee benefits	add_employees	n/a	n/a
eoy_company_review	Review company details and tax documents for end of year	Onboarded company	n/a	n/a

W2 Employee

flow_type	Description	Data Dependencies	entity_type	entity_uuid
add_employees	Manage all employee onboarding	Company add_address	n/a	n/a
employee_form_signing	For employee to review and sign documents	add_employees	Employee	Employee's UUID
employee_self_management	For employee to manage their own onboarding	add_employees	Employee	Employee's UUID
terminations	Create an employee termination	add_employees	Employee	Employee's UUID

Contractors

flow_type	Description	Data Dependencies	entity_type	entity_uuid
add_contractors	Manage all employee onboarding	Company add_address	n/a	n/a
contractor_documents	For contractors to review and sign documents	Contractor	Contractor	Contractor UUID
contractor_self_management	For a contractor to manage their own onboarding	add_contractors	Contractor	Contractor UUID
contractor_payments	Run and manage contractor payrolls	Onboarded company and onboarded contractors	n/a	n/a

Updated 28 days ago