Types

EmployeeOnboardingStatus

const EmployeeOnboardingStatus: object

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

Remarks

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

Type Declaration

Name	Type	Default value
ADMIN_ONBOARDING_INCOMPLETE	"admin_onboarding_incomplete"	OnboardingStatus.AdminOnboardingIncomplete
ONBOARDING_COMPLETED	"onboarding_completed"	OnboardingStatus.OnboardingCompleted
SELF_ONBOARDING_AWAITING_ADMIN_REVIEW	"self_onboarding_awaiting_admin_review"	OnboardingStatus.SelfOnboardingAwaitingAdminReview
SELF_ONBOARDING_COMPLETED_BY_EMPLOYEE	"self_onboarding_completed_by_employee"	OnboardingStatus.SelfOnboardingCompletedByEmployee
SELF_ONBOARDING_INVITED	"self_onboarding_invited"	OnboardingStatus.SelfOnboardingInvited
SELF_ONBOARDING_INVITED_OVERDUE	"self_onboarding_invited_overdue"	OnboardingStatus.SelfOnboardingInvitedOverdue
SELF_ONBOARDING_INVITED_STARTED	"self_onboarding_invited_started"	OnboardingStatus.SelfOnboardingInvitedStarted
SELF_ONBOARDING_PENDING_INVITE	"self_onboarding_pending_invite"	OnboardingStatus.SelfOnboardingPendingInvite

---

EmployeeSelfOnboardingStatuses

const EmployeeSelfOnboardingStatuses: Set<string>

Set of EmployeeOnboardingStatus values that indicate the employee is completing self-onboarding.

Remarks

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

---

I9_FORM_NAME

const I9_FORM_NAME: "US_I-9"

The form name identifying the federal I-9 (Employment Eligibility Verification) document.

Remarks

DocumentList emits employee/forms/view with { uuid, name }. Compare name against this constant to decide whether to route a form to I9SignatureForm (when it matches) or the standard SignatureForm.

---

PAY_PERIODS

const PAY_PERIODS: object

Pay period unit values for the paymentUnit field on a compensation, describing the unit a pay rate is expressed against.

Type Declaration

Name	Type
HOUR	"Hour"
MONTH	"Month"
PAYCHECK	"Paycheck"
WEEK	"Week"
YEAR	"Year"

---

StateAbbreviation

StateAbbreviation = typeof STATES_ABBR[number]

A two-letter US state abbreviation (including 'DC'). Derived from STATES_ABBR.

---

STATES_ABBR

const STATES_ABBR: readonly ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY"]

Two-letter US state abbreviations (including 'DC'), in the order presented in state selection controls.

---

WARiskClassCode

WARiskClassCode = object

A Washington state workers' compensation risk classification entry, as surfaced in the job form's stateWcClassCode field options.

Properties

Property	Type	Description
code	string	The workers' compensation risk class code.
description	string	Human-readable description of the risk class.