Skip to main content

Types

ContractorOnboardingStatus

const ContractorOnboardingStatus: object

Map of contractor onboarding status values returned by the Gusto API.

Remarks

Use these keys to compare against the onboardingStatus field on a contractor record. The values mirror the strings returned by the API.

Type Declaration

NameTypeDefault value
ADMIN_ONBOARDING_INCOMPLETE"admin_onboarding_incomplete"ContractorOnboardingStatus1.AdminOnboardingIncomplete
ADMIN_ONBOARDING_REVIEW"admin_onboarding_review"ContractorOnboardingStatus1.AdminOnboardingReview
ONBOARDING_COMPLETED"onboarding_completed"ContractorOnboardingStatus1.OnboardingCompleted
SELF_ONBOARDING_INVITED"self_onboarding_invited"ContractorOnboardingStatus1.SelfOnboardingInvited
SELF_ONBOARDING_NOT_INVITED"self_onboarding_not_invited"ContractorOnboardingStatus1.SelfOnboardingNotInvited
SELF_ONBOARDING_REVIEW"self_onboarding_review"ContractorOnboardingStatus1.SelfOnboardingReview
SELF_ONBOARDING_STARTED"self_onboarding_started"ContractorOnboardingStatus1.SelfOnboardingStarted

ContractorSelfOnboardingStatuses

const ContractorSelfOnboardingStatuses: Set<OnboardingStatus>

Set of ContractorOnboardingStatus values that indicate the contractor is completing self-onboarding.

Remarks

Use this set to check whether a contractor is currently in a self-onboarding flow (not invited, invited, started, or under review) versus an admin-driven onboarding flow.