APIModels

Entity types returned by the Gusto Embedded Payroll API.

AccountType

const AccountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:15

Bank account type

Type Declaration

Name	Type
Checking	"Checking"
Savings	"Savings"

---

AccountType

AccountType = ClosedEnum<typeof AccountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:15

Bank account type

---

AccrualMethod

const AccrualMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicyrequest.ts:26

Accrual method of the time off policy

Type Declaration

Name	Type
PerAnniversaryYear	"per_anniversary_year"
PerCalendarYear	"per_calendar_year"
PerHourPaid	"per_hour_paid"
PerHourPaidNoOvertime	"per_hour_paid_no_overtime"
PerHourWorked	"per_hour_worked"
PerHourWorkedNoOvertime	"per_hour_worked_no_overtime"
PerPayPeriod	"per_pay_period"
Unlimited	"unlimited"

---

AccrualMethod

AccrualMethod = ClosedEnum<typeof AccrualMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicyrequest.ts:26

Accrual method of the time off policy

---

Address

Address = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:39

The contractor’s home address.

Properties

Property	Type
city?	string
country?	string
state?	string
street1?	string
street2?	string | null
zip?	string

---

Agencies

Agencies = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/childsupportdata.ts:47

Agencies entity from the Gusto Embedded API.

Properties

Property	Type	Description
fipsCodes?	FipsCodes[]	FIPS codes for state or county child support orders
manualPaymentRequired?	boolean	Specifies if remitting payment to the agency is required outside of Gusto. If true, Gusto includes garnishment amounts for this agency in payroll calculation, but does not debit for or remit payment to the agency automatically. As of September 2024, only garnishments for South Carolina Integrated Child Support Services require manual payment.
name?	string	Name of state child support agency
requiredAttributes?	RequiredAttributes[]	Describes which child support case identifying attributes are required for this agency. While most agencies only require a single identifier, some (e.g. OH) require multiple identifiers.
state?	string	Two letter state abbreviation

---

AmountType

const AmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:259

The amount type of the deduction for the pay period. Only present for unprocessed payrolls.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

AmountType

AmountType = ClosedEnum<typeof AmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:259

The amount type of the deduction for the pay period. Only present for unprocessed payrolls.

---

Answers

Answers = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxesrequest.ts:10

Answers entity from the Gusto Embedded API.

Properties

Property	Type
validFrom	string
value	string | number | boolean | null
validUpTo?	string | null

---

ApplicableIf

ApplicableIf = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirement.ts:24

ApplicableIf entity from the Gusto Embedded API.

Properties

Property	Type	Description
key?	string	An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set.
value?	boolean | string | number | null	The required value of the requirement identified by key

---

AuthorizationStatus

const AuthorizationStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/i9authorization.ts:15

The employee's authorization status

Type Declaration

Name	Type
Alien	"alien"
Citizen	"citizen"
Noncitizen	"noncitizen"
PermanentResident	"permanent_resident"

---

AuthorizationStatus

AuthorizationStatus = ClosedEnum<typeof AuthorizationStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/i9authorization.ts:15

The employee's authorization status

---

Blockers

Blockers = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:59

Blockers entity from the Gusto Embedded API.

Properties

Property	Type	Description
category?	EmployeeOnboardingStatusCategory	Category of the blocker. See the array-level description for resolution guidance.
field?	Field	The employee field affected.
message?	string	Human-readable description of the blocker.

---

Breakdowns

Breakdowns = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:22

Breakdowns entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The dollar amount for this workweek.
endDate?	RFCDate	The end date of the workweek.
startDate?	RFCDate	The start date of the workweek.

---

ChildSupportDataKey

const ChildSupportDataKey: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/childsupportdata.ts:26

A required attribute when creating a garnishment for this state agency. The current values are listed as an enum; though unlikely, values could be added if state agency requirements change in the future.

Type Declaration

Name	Type
CaseNumber	"case_number"
OrderNumber	"order_number"
RemittanceNumber	"remittance_number"

---

ChildSupportDataKey

ChildSupportDataKey = ClosedEnum<typeof ChildSupportDataKey>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/childsupportdata.ts:26

A required attribute when creating a garnishment for this state agency. The current values are listed as an enum; though unlikely, values could be added if state agency requirements change in the future.

---

ChristmasDay

ChristmasDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:71

ChristmasDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

ColumbusDay

ColumbusDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:53

ColumbusDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

CompanyBankAccount

CompanyBankAccount = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:81

The company bank account

Properties

Property	Type	Description
uuid	string	UUID of the bank account
accountType?	AccountType	Bank account type
balanceFetchedDate?	string | null	The balance fetch date associated with the last_cached_balance. Only applies when verification type is Plaid.
companyUuid?	string	UUID of the company
hiddenAccountNumber?	string	Masked bank account number
lastCachedBalance?	string | null	The last fetch balance for the bank account. Please be aware that this amount does not reflect the most up-to-date balance and only applies when the verification type is Plaid.
name?	string	Name of bank account
plaidStatus?	PlaidStatus | null	The Plaid connection status of the bank account. Only applies when verification type is Plaid.
reverseWireEnabled?	boolean | null	Whether the company has at least one bank account with active reverse-wire Remarks funding. The same value is returned on every bank-account row in this response.
routingNumber?	string	The bank account's routing number
verificationStatus?	VerificationStatus	The verification status of the bank account. Remarks 'awaiting_deposits' means the bank account is just created and money is being transferred. 'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint. 'verified' means the bank account is verified.
verificationType?	VerificationType	The verification type of the bank account. Remarks 'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits. 'plaid' means the bank account is connected through Plaid.

---

CompanyOnboardingStatusRequirements

const CompanyOnboardingStatusRequirements: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companyonboardingstatus.ts:32

CompanyOnboardingStatusRequirements entity from the Gusto Embedded API.

Type Declaration

Name	Type
AddAddresses	"add_addresses"
AddBankInfo	"add_bank_info"
AddEmployees	"add_employees"
ExternalPayroll	"external_payroll"
FederalTaxSetup	"federal_tax_setup"
PayrollSchedule	"payroll_schedule"
SelectIndustry	"select_industry"
SignAllForms	"sign_all_forms"
StateSetup	"state_setup"
VerifyBankInfo	"verify_bank_info"

---

CompanyOnboardingStatusRequirements

CompanyOnboardingStatusRequirements = ClosedEnum<typeof CompanyOnboardingStatusRequirements>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companyonboardingstatus.ts:32

CompanyOnboardingStatusRequirements entity from the Gusto Embedded API.

---

Compensation

Compensation = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/compensation.ts:49

The representation of compensation in Gusto.

Properties

Property	Type	Description
uuid	string	The UUID of the compensation in Gusto.
adjustForMinimumWage?	boolean	Indicates if the compensation could be adjusted to minimum wage during payroll calculation.
effectiveDate?	string	The effective date for this compensation. For the first compensation, this defaults to the job's hire date.
employeeUuid?	string	The UUID of the employee to which the compensation belongs.
flsaStatus?	FlsaStatusType	The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company.
jobUuid?	string	The UUID of the job to which the compensation belongs.
minimumWages?	MinimumWages[]	The minimum wages associated with the compensation.
paymentUnit?	PaymentUnit	The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.
rate?	string	The dollar amount paid per payment unit.
title?	string	The job title for this compensation.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

Contractor

Contractor = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:127

The representation of a contractor (individual or business) in Gusto.

Properties

Property	Type	Description
isActive	boolean	The status of the contractor with the company.
uuid	string	The UUID of the contractor in Gusto.
address?	Address | null	The contractor’s home address.
businessName?	string | null	The name of the contractor business. This attribute is required for “Business” contractors and will be ignored for “Individual” contractors.
companyUuid?	string	The UUID of the company the contractor is employed by.
department?	string | null	The contractor's department in the company.
departmentTitle?	string | null	The title of the contractor's department.
departmentUuid?	string | null	The UUID of the department the contractor is under
dismissalCancellationEligible?	boolean	Whether the contractor's pending dismissal can be cancelled.
dismissalDate?	string | null	The contractor's dismissal date.
ein?	string | null	The Federal Employer Identification Number of the contractor business. This attribute is optional for “Business” contractors and will be ignored for “Individual” contractors.
email?	string | null	The contractor’s email address. This attribute is optional for “Individual” contractors and will be ignored for “Business” contractors.
fileNewHireReport?	boolean | null	The boolean flag indicating whether Gusto will file a new hire report for the contractor
firstName?	string | null	The contractor’s first name. This attribute is required for “Individual” contractors and will be ignored for “Business” contractors.
hasEin?	boolean | null	Whether company's Employer Identification Number (EIN) is present
hasSsn?	boolean	Indicates whether the contractor has an SSN in Gusto.
hourlyRate?	string	The contractor’s hourly rate. This attribute is required if the wage_type is “Hourly”.
lastName?	string | null	The contractor’s last name. This attribute is required for “Individual” contractors and will be ignored for “Business” contractors.
memberPortalInvitationStatus?	MemberPortalInvitationStatus | null	Member portal invitation status information. Only included when the include param has the portal_invitations value set.
middleInitial?	string | null	The contractor’s middle initial. This attribute is optional for “Individual” contractors and will be ignored for “Business” contractors.
onboarded?	boolean	The updated onboarding status for the contractor
onboardingStatus?	OnboardingStatus	One of the "onboarding_status" enum values.
partnerPortalInvitationSent?	boolean | null	Whether an external partner portal invitation webhook has been sent for this contractor. Only included when the include param has the portal_invitations value set.
paymentMethod?	ContractorPaymentMethod1 | null	The contractor's payment method.
rehireCancellationEligible?	boolean	Whether the contractor's pending rehire can be cancelled.
startDate?	string	The contractor's start date.
type?	ContractorType	The contractor's type, either "Individual" or "Business".
upcomingEmployment?	UpcomingEmployment | null	The contractor's upcoming employment details, if a rehire is scheduled.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.
wageType?	ContractorWageType	The contractor's wage type, either "Fixed" or "Hourly".
workEmail?	string | null	The work email address of the contractor. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).
workState?	string | null	State where the contractor will be conducting the majority of their work for the company. Remarks This value is used when generating the new hire report.

---

ContractorAddress

ContractorAddress = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractoraddress.ts:12

ContractorAddress entity from the Gusto Embedded API.

Properties

Property	Type	Description
country	string | null	-
active?	boolean	The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.
city?	string | null	-
contractorUuid?	string	The UUID of the contractor
state?	string | null	-
street1?	string | null	-
street2?	string | null	-
version?	string	The current version of the object. See the versioning guide for information on how to use this field.
warnings?	WarningObject[]	An array of warning objects that provide additional information about the address. Warnings do not prevent the address from being saved.
zip?	string | null	-

---

ContractorBankAccount

ContractorBankAccount = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorbankaccount.ts:26

ContractorBankAccount entity from the Gusto Embedded API.

Properties

Property	Type	Description
accountType	ContractorBankAccountAccountType	Bank account type
contractorUuid	string	UUID of the contractor
hiddenAccountNumber	string	Masked bank account number
name	string	Name for the bank account
routingNumber	string	The bank account's routing number
uuid	string	UUID of the bank account

---

ContractorBankAccountAccountType

const ContractorBankAccountAccountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorbankaccount.ts:15

Bank account type

Type Declaration

Name	Type
Checking	"Checking"
Savings	"Savings"

---

ContractorBankAccountAccountType

ContractorBankAccountAccountType = ClosedEnum<typeof ContractorBankAccountAccountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorbankaccount.ts:15

Bank account type

---

ContractorCreateRequestBody

ContractorCreateRequestBody = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorcreaterequestbody.ts:44

Request body for creating a contractor.

Properties

Property	Type	Description
startDate	string	The day when the contractor will start working for the company. Remarks
wageType	ContractorCreateRequestBodyWageType	The contractor’s wage type. Remarks
businessName?	string	The name of the contractor business. This attribute is required for Business contractors and will be ignored for Individual contractors.
ein?	string	The employer identification number of the contractor business. Remarks This attribute is optional for Business contractors and will be ignored for Individual contractors.
email?	string	The contractor’s email address.
fileNewHireReport?	boolean	The boolean flag indicating whether Gusto will file a new hire report for the contractor. Remarks This attribute is optional for Individual contractors and will be ignored for Business contractors.
firstName?	string	The contractor’s first name. Remarks This attribute is required for Individual contractors and will be ignored for Business contractors.
hourlyRate?	string	The contractor’s hourly rate. This attribute is required if the wage_type is Hourly.
isActive?	boolean	The status of the contractor. If the contractor's start date is in the future, updating this field to true means we are setting the start date to today. Attempting to deactivate a contractor while a dismissal is already scheduled, or reactivate while a rehire is already scheduled, will return a 422 error. Cancel the pending transition first using the appropriate cancel endpoint.
lastName?	string	The contractor’s last name. Remarks This attribute is required for Individual contractors and will be ignored for Business contractors.
middleInitial?	string	The contractor’s middle initial. Remarks This attribute is optional for Individual contractors and will be ignored for Business contractors.
selfOnboarding?	boolean	Whether the contractor or the payroll admin will complete onboarding in Gusto. Remarks Self-onboarding is recommended so that contractors receive Gusto accounts. If self_onboarding is true, then email is required.
ssn?	string	This attribute is optional for Individual contractors and will be ignored for Business contractors. Remarks Social security number is needed to file the annual 1099 tax form.
type?	ContractorCreateRequestBodyType	The contractor type.
workEmail?	string	The work email address of the contractor. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).
workState?	string | null	State where the contractor will be conducting the majority of their work for the company. Remarks This value is used when generating the new hire report. This attribute is required for Individual contractors if file_new_hire_report is true and will be ignored for Business contractors.

---

ContractorCreateRequestBodyType

const ContractorCreateRequestBodyType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorcreaterequestbody.ts:12

The contractor type.

Type Declaration

Name	Type
Business	"Business"
Individual	"Individual"

---

ContractorCreateRequestBodyType

ContractorCreateRequestBodyType = ClosedEnum<typeof ContractorCreateRequestBodyType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorcreaterequestbody.ts:12

The contractor type.

---

ContractorCreateRequestBodyWageType

const ContractorCreateRequestBodyWageType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorcreaterequestbody.ts:28

The contractor’s wage type.

Remarks

Type Declaration

Name	Type
Fixed	"Fixed"
Hourly	"Hourly"

---

ContractorCreateRequestBodyWageType

ContractorCreateRequestBodyWageType = ClosedEnum<typeof ContractorCreateRequestBodyWageType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorcreaterequestbody.ts:28

The contractor’s wage type.

Remarks

---

ContractorOnboardingStatus

ContractorOnboardingStatus = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractoronboardingstatus.ts:57

The representation of an contractor's onboarding status.

Properties

Property	Type	Description
uuid	string	Unique identifier for this contractor.
onboardingStatus?	ContractorOnboardingStatusOnboardingStatus	One of the "onboarding_status" enum values.
onboardingSteps?	ContractorOnboardingStatusOnboardingStep[]	List of steps required to onboard a contractor.

---

ContractorOnboardingStatusOnboardingStatus

const ContractorOnboardingStatusOnboardingStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractoronboardingstatus.ts:15

One of the "onboarding_status" enum values.

Type Declaration

Name	Type
AdminOnboardingIncomplete	"admin_onboarding_incomplete"
AdminOnboardingReview	"admin_onboarding_review"
OnboardingCompleted	"onboarding_completed"
SelfOnboardingInvited	"self_onboarding_invited"
SelfOnboardingNotInvited	"self_onboarding_not_invited"
SelfOnboardingReview	"self_onboarding_review"
SelfOnboardingStarted	"self_onboarding_started"

---

ContractorOnboardingStatusOnboardingStatus

ContractorOnboardingStatusOnboardingStatus = ClosedEnum<typeof ContractorOnboardingStatusOnboardingStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractoronboardingstatus.ts:15

One of the "onboarding_status" enum values.

---

ContractorOnboardingStatusOnboardingStep

ContractorOnboardingStatusOnboardingStep = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractoronboardingstatus.ts:31

ContractorOnboardingStatusOnboardingStep entity from the Gusto Embedded API.

Properties

Property	Type	Description
completed?	boolean	When true, this step has been completed.
id?	string	String identifier for the onboarding step.
required?	boolean	When true, this step is required.
requirements?	string[]	A list of onboarding steps required to begin this step.
title?	string	User-friendly description of the onboarding step.

---

ContractorPaymentForGroup

ContractorPaymentForGroup = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:59

The representation of a single contractor payment.

Properties

Property	Type	Description
bonus?	string	The bonus amount in the payment.
contractorUuid?	string	The UUID of the contractor.
hourlyRate?	string	The rate per hour worked for the payment.
hours?	string	The number of hours worked for the payment.
invoiceNumber?	string | null	An optional invoice number associated with this contractor payment. This will be visible to the contractor on their paystub. Maximum 25 characters.
mayCancel?	boolean	Determine if the contractor payment can be cancelled.
memo?	string | null	An optional note or memo for this contractor payment. This will be visible to the contractor on their paystub.
paymentMethod?	ContractorPaymentForGroupPaymentMethod	The payment method.
reimbursement?	string	The reimbursement amount in the payment.
status?	ContractorPaymentForGroupStatus	The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.
uuid?	string	The unique identifier of the contractor payment in Gusto.
wage?	string	The fixed wage of the payment, regardless of hours worked.
wageTotal?	string	(hours * hourly_rate) + wage + bonus
wageType?	ContractorPaymentForGroupWageType	The wage type for the payment.

---

ContractorPaymentForGroupPaymentMethod

const ContractorPaymentForGroupPaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:15

The payment method.

Type Declaration

Name	Type
Check	"Check"
CorrectionPayment	"Correction Payment"
DirectDeposit	"Direct Deposit"
HistoricalPayment	"Historical Payment"

---

ContractorPaymentForGroupPaymentMethod

ContractorPaymentForGroupPaymentMethod = ClosedEnum<typeof ContractorPaymentForGroupPaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:15

The payment method.

---

ContractorPaymentForGroupPreview

ContractorPaymentForGroupPreview = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:57

Preview representation of a single contractor payment with nullable uuid.

Properties

Property	Type	Description
bonus?	string	The bonus amount in the payment.
contractorUuid?	string	The UUID of the contractor.
hourlyRate?	string	The rate per hour worked for the payment.
hours?	string	The number of hours worked for the payment.
invoiceNumber?	string | null	An optional invoice number associated with this contractor payment. This will be visible to the contractor on their paystub. Maximum 25 characters.
mayCancel?	boolean	Determine if the contractor payment can be cancelled.
memo?	string | null	An optional note or memo for this contractor payment. This will be visible to the contractor on their paystub.
paymentMethod?	ContractorPaymentForGroupPreviewPaymentMethod	The payment method.
reimbursement?	string	The reimbursement amount in the payment.
status?	ContractorPaymentForGroupPreviewStatus	The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.
uuid?	string | null	The unique identifier of the contractor payment in Gusto.
wage?	string	The fixed wage of the payment, regardless of hours worked.
wageTotal?	string	(hours * hourly_rate) + wage + bonus
wageType?	WageType	The wage type for the payment.

---

ContractorPaymentForGroupPreviewPaymentMethod

const ContractorPaymentForGroupPreviewPaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:15

The payment method.

Type Declaration

Name	Type
Check	"Check"
CorrectionPayment	"Correction Payment"
DirectDeposit	"Direct Deposit"
HistoricalPayment	"Historical Payment"

---

ContractorPaymentForGroupPreviewPaymentMethod

ContractorPaymentForGroupPreviewPaymentMethod = ClosedEnum<typeof ContractorPaymentForGroupPreviewPaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:15

The payment method.

---

ContractorPaymentForGroupPreviewStatus

const ContractorPaymentForGroupPreviewStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:31

The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.

Type Declaration

Name	Type
Funded	"Funded"
Unfunded	"Unfunded"

---

ContractorPaymentForGroupPreviewStatus

ContractorPaymentForGroupPreviewStatus = ClosedEnum<typeof ContractorPaymentForGroupPreviewStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:31

The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.

---

ContractorPaymentForGroupStatus

const ContractorPaymentForGroupStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:31

The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.

Type Declaration

Name	Type
Funded	"Funded"
Unfunded	"Unfunded"

---

ContractorPaymentForGroupStatus

ContractorPaymentForGroupStatus = ClosedEnum<typeof ContractorPaymentForGroupStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:31

The status of the contractor payment. Will transition to Funded during payments processing if the payment should be funded, i.e. has Direct Deposit for payment method. Contractors payments with Check payment method will remain Unfunded.

---

ContractorPaymentForGroupWageType

const ContractorPaymentForGroupWageType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:45

The wage type for the payment.

Type Declaration

Name	Type
Fixed	"Fixed"
Hourly	"Hourly"

---

ContractorPaymentForGroupWageType

ContractorPaymentForGroupWageType = ClosedEnum<typeof ContractorPaymentForGroupWageType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgroup.ts:45

The wage type for the payment.

---

ContractorPaymentGroup

ContractorPaymentGroup = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroup.ts:64

The full contractor payment group, including associated contractor payments.

Properties

Property	Type	Description
checkDate?	string	The check date of the contractor payment group.
companyUuid?	string	The UUID of the company.
contractorPayments?	ContractorPaymentForGroup[]	-
creationToken?	string | null	Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.
creditBlockers?	PayrollCreditBlockerType[]	List of credit blockers for the contractor payment group.
debitDate?	string	The debit date of the contractor payment group.
partnerOwnedDisbursement?	boolean | null	Whether the disbursement is partner owned.
status?	ContractorPaymentGroupStatus	The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.
submissionBlockers?	PayrollSubmissionBlockerType[]	List of submission blockers for the contractor payment group.
totals?	ContractorPaymentGroupTotals	-
uuid?	string	The unique identifier of the contractor payment group.

---

ContractorPaymentGroupPreview

ContractorPaymentGroupPreview = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgrouppreview.ts:64

Preview of a contractor payment group

Properties

Property	Type	Description
checkDate?	string	The check date of the contractor payment group.
companyUuid?	string	The UUID of the company.
contractorPayments?	ContractorPaymentForGroupPreview[]	-
creationToken?	string | null	Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.
creditBlockers?	PayrollCreditBlockerType[]	List of credit blockers for the contractor payment group.
debitDate?	string	The debit date of the contractor payment group.
partnerOwnedDisbursement?	boolean | null	Whether the disbursement is partner owned.
status?	ContractorPaymentGroupPreviewStatus	The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.
submissionBlockers?	PayrollSubmissionBlockerType[]	List of submission blockers for the contractor payment group.
totals?	Totals	-
uuid?	string | null	The unique identifier of the contractor payment group.

---

ContractorPaymentGroupPreviewStatus

const ContractorPaymentGroupPreviewStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgrouppreview.ts:27

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

Type Declaration

Name	Type
Funded	"Funded"
Unfunded	"Unfunded"

---

ContractorPaymentGroupPreviewStatus

ContractorPaymentGroupPreviewStatus = ClosedEnum<typeof ContractorPaymentGroupPreviewStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgrouppreview.ts:27

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

---

ContractorPaymentGroupStatus

const ContractorPaymentGroupStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroup.ts:27

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

Type Declaration

Name	Type
Funded	"Funded"
Unfunded	"Unfunded"

---

ContractorPaymentGroupStatus

ContractorPaymentGroupStatus = ClosedEnum<typeof ContractorPaymentGroupStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroup.ts:27

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

---

ContractorPaymentGroupTotals

ContractorPaymentGroupTotals = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroup.ts:38

ContractorPaymentGroupTotals entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The total amount for the group of contractor payments.
checkAmount?	string	The total check amount for the group of contractor payments.
debitAmount?	string	The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount.
reimbursementAmount?	string	The total reimbursement amount for the group of contractor payments.
wageAmount?	string	The total wage amount for the group of contractor payments.

---

ContractorPaymentGroupWithBlockers

ContractorPaymentGroupWithBlockers = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroupwithblockers.ts:60

Contractor payment group with submission and credit blockers, but without individual contractor payments.

Properties

Property	Type	Description
checkDate?	string	The check date of the contractor payment group.
companyUuid?	string	The UUID of the company.
creationToken?	string | null	Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.
creditBlockers?	PayrollCreditBlockerType[]	List of credit blockers for the contractor payment group.
debitDate?	string	The debit date of the contractor payment group.
partnerOwnedDisbursement?	boolean | null	Whether the disbursement is partner owned.
status?	ContractorPaymentGroupWithBlockersStatus	The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.
submissionBlockers?	PayrollSubmissionBlockerType[]	List of submission blockers for the contractor payment group.
totals?	ContractorPaymentGroupWithBlockersTotals	-
uuid?	string	The unique identifier of the contractor payment group.

---

ContractorPaymentGroupWithBlockersStatus

const ContractorPaymentGroupWithBlockersStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroupwithblockers.ts:23

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

Type Declaration

Name	Type
Funded	"Funded"
Unfunded	"Unfunded"

---

ContractorPaymentGroupWithBlockersStatus

ContractorPaymentGroupWithBlockersStatus = ClosedEnum<typeof ContractorPaymentGroupWithBlockersStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroupwithblockers.ts:23

The status of the contractor payment group. Will be Funded if all payments that should be funded (i.e. have Direct Deposit for payment method) are funded. A group can have status Funded while having associated payments that have status Unfunded, i.e. payment with Check payment method.

---

ContractorPaymentGroupWithBlockersTotals

ContractorPaymentGroupWithBlockersTotals = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgroupwithblockers.ts:34

ContractorPaymentGroupWithBlockersTotals entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The total amount for the group of contractor payments.
checkAmount?	string	The total check amount for the group of contractor payments.
debitAmount?	string	The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount.
reimbursementAmount?	string	The total reimbursement amount for the group of contractor payments.
wageAmount?	string	The total wage amount for the group of contractor payments.

---

ContractorPaymentMethod

ContractorPaymentMethod = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentmethod.ts:32

ContractorPaymentMethod entity from the Gusto Embedded API.

Properties

Property	Type	Description
splitBy?	ContractorPaymentMethodSplitBy | null	Describes how the payment will be split. If split_by is Percentage, then the split amounts must add up to exactly 100. If split_by is Amount, then values are in cents and the last split amount must be null to capture the remainder.
splits?	PaymentMethodBankAccount[] | null	-
type?	ContractorPaymentMethodType | null	The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

ContractorPaymentMethod1

const ContractorPaymentMethod1: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:65

ContractorPaymentMethod1 entity from the Gusto Embedded API.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"

---

ContractorPaymentMethod1

ContractorPaymentMethod1 = ClosedEnum<typeof ContractorPaymentMethod1>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:65

ContractorPaymentMethod1 entity from the Gusto Embedded API.

---

ContractorPaymentMethodSplitBy

const ContractorPaymentMethodSplitBy: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentmethod.ts:24

ContractorPaymentMethodSplitBy entity from the Gusto Embedded API.

Type Declaration

Name	Type
Amount	"Amount"
Percentage	"Percentage"

---

ContractorPaymentMethodSplitBy

ContractorPaymentMethodSplitBy = ClosedEnum<typeof ContractorPaymentMethodSplitBy>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentmethod.ts:24

ContractorPaymentMethodSplitBy entity from the Gusto Embedded API.

---

ContractorPaymentMethodType

const ContractorPaymentMethodType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentmethod.ts:16

ContractorPaymentMethodType entity from the Gusto Embedded API.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"

---

ContractorPaymentMethodType

ContractorPaymentMethodType = ClosedEnum<typeof ContractorPaymentMethodType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentmethod.ts:16

ContractorPaymentMethodType entity from the Gusto Embedded API.

---

ContractorPaymentReceipt

ContractorPaymentReceipt = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentreceipt.ts:112

ContractorPaymentReceipt entity from the Gusto Embedded API.

Properties

Property	Type	Description
companyUuid?	string	A unique identifier of the company making the contractor payment.
contractorPayments?	ContractorPaymentReceiptContractorPayments[]	An array of contractor payments for this contractor payment.
contractorPaymentUuid?	string	A unique identifier of the contractor payment receipt.
debitDate?	RFCDate	The debit date for the contractor payment.
liabilityOfLicensee?	string	URL for information related to right to liability of licensee. Always the fixed string "https://gusto.com/about/licenses"
license?	string	Always the fixed string "Your payroll provider partners with Gusto Inc. for payments processing. Gusto Inc. is a licensed money transmitter. Learn more on our license page."
licensee?	Licensee	The licensed payroll processor
licenseUri?	string	URL for the license information for the licensed payroll processor. Always the fixed string "https://gusto.com/about/licenses"
nameOfRecipient?	string	The individual or company name of the contractor receiving payment.
nameOfSender?	string	The name of the company making the contractor payment.
rightToRefund?	string	URL for information related to right to refund. Always the fixed string "https://gusto.com/about/licenses"
totals?	ContractorPaymentReceiptTotals	The subtotals for the contractor payment.

---

ContractorPaymentReceiptContractorPayments

ContractorPaymentReceiptContractorPayments = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentreceipt.ts:39

ContractorPaymentReceiptContractorPayments entity from the Gusto Embedded API.

Properties

Property	Type	Description
bonus?	string	The bonus amount in the payment.
contractorBusinessName?	string	The business name of the contractor. Applies when contractor_type is Business.
contractorFirstName?	string	The first name of the contractor. Applies when contractor_type is Individual.
contractorLastName?	string	The last name of the contractor. Applies when contractor_type is Individual.
contractorType?	string	The type of contractor. Remarks Individual Business
contractorUuid?	string	The UUID of the contractor.
paymentMethod?	ContractorPaymentReceiptPaymentMethod	The payment method.
reimbursement?	string	The reimbursement amount in the payment.
wage?	string	The fixed wage of the payment, regardless of hours worked.

---

ContractorPaymentReceiptPaymentMethod

const ContractorPaymentReceiptPaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentreceipt.ts:26

The payment method.

Type Declaration

Name	Type
Check	"Check"
CorrectionPayment	"Correction Payment"
DirectDeposit	"Direct Deposit"
HistoricalPayment	"Historical Payment"

---

ContractorPaymentReceiptPaymentMethod

ContractorPaymentReceiptPaymentMethod = ClosedEnum<typeof ContractorPaymentReceiptPaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentreceipt.ts:26

The payment method.

---

ContractorPaymentReceiptTotals

ContractorPaymentReceiptTotals = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentreceipt.ts:16

The subtotals for the contractor payment.

Properties

Property	Type	Description
companyDebit?	string	The total company debit for the contractor payment.

---

ContractorStatus

const ContractorStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:90

The current status of the member portal invitation.

Type Declaration

Name	Type
Cancelled	"cancelled"
Complete	"complete"
Pending	"pending"
Sent	"sent"
Verified	"verified"

---

ContractorStatus

ContractorStatus = ClosedEnum<typeof ContractorStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:90

The current status of the member portal invitation.

---

ContractorType

const ContractorType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:27

The contractor's type, either "Individual" or "Business".

Type Declaration

Name	Type
Business	"Business"
Individual	"Individual"

---

ContractorType

ContractorType = ClosedEnum<typeof ContractorType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:27

The contractor's type, either "Individual" or "Business".

---

ContractorUpdateRequestBody

ContractorUpdateRequestBody = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorupdaterequestbody.ts:44

Request body for updating a contractor.

Properties

Property	Type	Description
version	string	The current version of the object. See the versioning guide for information on how to use this field.
businessName?	string	The name of the contractor business. This attribute is required for Business contractors and will be ignored for Individual contractors.
ein?	string	The employer identification number of the contractor business. Remarks This attribute is optional for Business contractors and will be ignored for Individual contractors.
email?	string	The contractor’s email address.
fileNewHireReport?	boolean	The boolean flag indicating whether Gusto will file a new hire report for the contractor. Remarks This attribute is optional for Individual contractors and will be ignored for Business contractors.
firstName?	string	The contractor’s first name. Remarks This attribute is required for Individual contractors and will be ignored for Business contractors.
hourlyRate?	string	The contractor’s hourly rate. This attribute is required if the wage_type is Hourly.
isActive?	boolean	The status of the contractor. If the contractor's start date is in the future, updating this field to true means we are setting the start date to today. Attempting to deactivate a contractor while a dismissal is already scheduled, or reactivate while a rehire is already scheduled, will return a 422 error. Cancel the pending transition first using the appropriate cancel endpoint.
lastName?	string	The contractor’s last name. Remarks This attribute is required for Individual contractors and will be ignored for Business contractors.
middleInitial?	string	The contractor’s middle initial. Remarks This attribute is optional for Individual contractors and will be ignored for Business contractors.
selfOnboarding?	boolean	Whether the contractor or the payroll admin will complete onboarding in Gusto. Remarks Self-onboarding is recommended so that contractors receive Gusto accounts. If self_onboarding is true, then email is required.
ssn?	string	This attribute is optional for Individual contractors and will be ignored for Business contractors. Remarks Social security number is needed to file the annual 1099 tax form.
startDate?	string	The day when the contractor will start working for the company. Remarks
type?	ContractorUpdateRequestBodyType	The contractor type.
wageType?	ContractorUpdateRequestBodyWageType	The contractor’s wage type. Remarks
workEmail?	string	The work email address of the contractor. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).
workState?	string | null	State where the contractor will be conducting the majority of their work for the company. Remarks This value is used when generating the new hire report. This attribute is required for Individual contractors if file_new_hire_report is true and will be ignored for Business contractors.

---

ContractorUpdateRequestBodyType

const ContractorUpdateRequestBodyType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorupdaterequestbody.ts:12

The contractor type.

Type Declaration

Name	Type
Business	"Business"
Individual	"Individual"

---

ContractorUpdateRequestBodyType

ContractorUpdateRequestBodyType = ClosedEnum<typeof ContractorUpdateRequestBodyType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorupdaterequestbody.ts:12

The contractor type.

---

ContractorUpdateRequestBodyWageType

const ContractorUpdateRequestBodyWageType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorupdaterequestbody.ts:28

The contractor’s wage type.

Remarks

Type Declaration

Name	Type
Fixed	"Fixed"
Hourly	"Hourly"

---

ContractorUpdateRequestBodyWageType

ContractorUpdateRequestBodyWageType = ClosedEnum<typeof ContractorUpdateRequestBodyWageType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorupdaterequestbody.ts:28

The contractor’s wage type.

Remarks

---

ContractorWageType

const ContractorWageType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:15

The contractor's wage type, either "Fixed" or "Hourly".

Type Declaration

Name	Type
Fixed	"Fixed"
Hourly	"Hourly"

---

ContractorWageType

ContractorWageType = ClosedEnum<typeof ContractorWageType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:15

The contractor's wage type, either "Fixed" or "Hourly".

---

CurrentEmploymentStatus

const CurrentEmploymentStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:65

CurrentEmploymentStatus entity from the Gusto Embedded API.

Type Declaration

Name	Type
FullTime	"full_time"
PartTimeTwentyPlusHours	"part_time_twenty_plus_hours"
PartTimeUnderTwentyHours	"part_time_under_twenty_hours"
Seasonal	"seasonal"
Variable	"variable"

---

CurrentEmploymentStatus

CurrentEmploymentStatus = ClosedEnum<typeof CurrentEmploymentStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:65

CurrentEmploymentStatus entity from the Gusto Embedded API.

---

CustomFieldType

const CustomFieldType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/customfieldtype.ts:11

Input type for the custom field.

Type Declaration

Name	Type
Currency	"currency"
Date	"date"
Number	"number"
Radio	"radio"
Text	"text"

---

CustomFieldType

CustomFieldType = ClosedEnum<typeof CustomFieldType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/customfieldtype.ts:11

Input type for the custom field.

---

CustomWithholdings

CustomWithholdings = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:245

The one-time custom withholding overrides applied to this payroll for this employee.

Remarks

federal is null when no federal one-time override is set; state is an empty array when no state one-time overrides are set.

Properties

Property	Type	Description
federal?	Federal | null	Federal one-time custom withholding override applied to this payroll.
state?	State[]	State one-time custom withholding overrides applied to this payroll, one entry per state field.

---

Deductions

Deductions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:268

Deductions entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	number	The amount of the deduction for the pay period.
amountType?	AmountType	The amount type of the deduction for the pay period. Only present for unprocessed payrolls.
name?	string	The name of the deduction.
updatableViaPayroll?	boolean	Whether the deduction can be updated via the payroll update endpoint. Only present for unprocessed payrolls.
uuid?	string	The UUID of the deduction. Only present for unprocessed payrolls.

---

Document

Document = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/document.ts:75

Document entity from the Gusto Embedded API.

Properties

Property	Type	Description
description?	string	The description of the document
draft?	boolean	If the document is in a draft state
fields?	Fields[]	List of the document's fields and associated data. Values are set for auto-filled fields. This is only returned for documents with required_signing = true, and can be used for signing preparation.
name?	string	The type identifier of the document
pages?	Pages[]	List of the document's pages and associated image URLs. This is only returned for documents with required_signing = true, and can be used for signing preparation.
quarter?	number | null	The quarter of this document. This value is nullable and will not be present on all documents.
recipientType?	DocumentRecipientType	The type of recipient associated with the document (will be Contractor for Contractor Documents)
recipientUuid?	string	Unique identifier for the recipient associated with the document
requiresSigning?	boolean	A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed.
signedAt?	string | null	When the document was signed (will be null if unsigned)
title?	string	The title of the document
uuid?	string	The UUID of the document
year?	number | null	The year of this document. This value is nullable and will not be present on all documents.

---

DocumentRecipientType

const DocumentRecipientType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/document.ts:15

The type of recipient associated with the document (will be Contractor for Contractor Documents)

Type Declaration

Name	Type
Company	"Company"
Contractor	"Contractor"
Employee	"Employee"

---

DocumentRecipientType

DocumentRecipientType = ClosedEnum<typeof DocumentRecipientType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/document.ts:15

The type of recipient associated with the document (will be Contractor for Contractor Documents)

---

DocumentSigned

DocumentSigned = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/documentsigned.ts:77

DocumentSigned entity from the Gusto Embedded API.

Properties

Property	Type	Description
description?	string	The description of the document
draft?	boolean	If the document is in a draft state
fields?	DocumentSignedFields[]	List of the document's fields and associated data. Values reflect the data provided at signing.
name?	string	The type identifier of the document
pages?	DocumentSignedPages[]	List of the document's pages and associated image URLs.
quarter?	number | null	The quarter of this document. This value is nullable and will not be present on all documents.
recipientType?	DocumentSignedRecipientType	The type of recipient associated with the document (will be Contractor for Contractor Documents)
recipientUuid?	string	Unique identifier for the recipient associated with the document
requiresSigning?	boolean	A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed.
signedAt?	string | null	When the document was signed (will be null if unsigned)
title?	string	The title of the document
uuid?	string	The UUID of the document
year?	number | null	The year of this document. This value is nullable and will not be present on all documents.

---

DocumentSignedFields

DocumentSignedFields = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/documentsigned.ts:38

DocumentSignedFields entity from the Gusto Embedded API.

Properties

Property	Type	Description
dataType?	string	The field's data type
height?	number | null	Height of the field. May be null when the field has no positioning information.
key?	string | null	Unique identifier of the field. May be null for custom fields that do not correspond to a known Gusto-managed key mapping.
pageNumber?	number | null	Page number of the field. May be null when the field has no positioning information.
required?	boolean	Whether the field is required
value?	string | null	Value of the field
width?	number | null	Width of the field. May be null when the field has no positioning information.
x?	number | null	X-coordinate location of the field on the page. May be null when the field has no positioning information.
y?	number | null	Y-coordinate location of the field on the page. May be null when the field has no positioning information.

---

DocumentSignedPages

DocumentSignedPages = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/documentsigned.ts:27

DocumentSignedPages entity from the Gusto Embedded API.

Properties

Property	Type	Description
imageUrl?	string	Image URL for the page
pageNumber?	number	Page number

---

DocumentSignedRecipientType

const DocumentSignedRecipientType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/documentsigned.ts:15

The type of recipient associated with the document (will be Contractor for Contractor Documents)

Type Declaration

Name	Type
Company	"Company"
Contractor	"Contractor"
Employee	"Employee"

---

DocumentSignedRecipientType

DocumentSignedRecipientType = ClosedEnum<typeof DocumentSignedRecipientType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/documentsigned.ts:15

The type of recipient associated with the document (will be Contractor for Contractor Documents)

---

DocumentType

const DocumentType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/i9authorization.ts:26

DocumentType entity from the Gusto Embedded API.

Type Declaration

Name	Type
ForeignPassport	"foreign_passport"
FormI94	"form_i94"
UscisAlienRegistrationNumber	"uscis_alien_registration_number"

---

DocumentType

DocumentType = ClosedEnum<typeof DocumentType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/i9authorization.ts:26

DocumentType entity from the Gusto Embedded API.

---

EarningType

EarningType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/earningtype.ts:48

The representation of an earning type in Gusto.

Properties

Property	Type	Description
uuid	string	The ID of the earning type.
active?	boolean	Whether the earning type is active.
category?	EarningTypeCategory	The earning type category. Only present when the company has access to Remarks categorized custom bonus earning types.
includedInOvertimePay?	boolean	Whether earnings of this type are included when calculating an employee's Remarks regular rate of pay for overtime purposes. Only settable when category is Other.
name?	string	The name of the earning type.

---

EarningTypeCategory

const EarningTypeCategory: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/earningtype.ts:18

The earning type category. Only present when the company has access to

Remarks

categorized custom bonus earning types.

Type Declaration

Name	Type
BenefitContributions	"BenefitContributions"
CashTips	"CashTips"
Commission	"Commission"
CorrectionPayment	"CorrectionPayment"
DiscretionaryBonus	"DiscretionaryBonus"
MinimumWageAdjustment	"MinimumWageAdjustment"
MinisterHousing	"MinisterHousing"
NonDiscretionaryBonus	"NonDiscretionaryBonus"
NonTaxableDisability	"NonTaxableDisability"
OnCallPay	"OnCallPay"
Other	"Other"
OtherNonTaxable	"OtherNonTaxable"
OtherRegularIncome	"OtherRegularIncome"
OwnersDraw	"OwnersDraw"
PaycheckTips	"PaycheckTips"
ServiceCharges	"ServiceCharges"
SeverancePay	"SeverancePay"

---

EarningTypeCategory

EarningTypeCategory = ClosedEnum<typeof EarningTypeCategory>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/earningtype.ts:18

The earning type category. Only present when the company has access to

Remarks

categorized custom bonus earning types.

---

EarningTypeList

EarningTypeList = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/earningtypelist.ts:14

Lists of default and custom earning types for a company.

Properties

Property	Type	Description
custom?	EarningType[]	The custom earning types for the company.
default?	EarningType[]	The default earning types for the company.

---

EinVerification

EinVerification = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:76

Information about the status of verifying the company's Employer Identification Number (EIN)

Properties

Property	Type	Description
status?	FederalTaxDetailsStatus	The status of EIN verification: Remarks - pending: The EIN verification process has not completed (or the company does not yet have an EIN). - verified: The EIN has been successfully verified as a valid EIN with the IRS. - failed: The company's EIN did not pass verification. Common issues are being entered incorrectly or not matching the company's legal name.

---

Employee

Employee = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:116

The representation of an employee in Gusto.

Extended by

• EmployeeWithActions

Properties

Property	Type	Description
firstName	string	-
lastName	string	-
paymentMethod	EmployeePaymentMethod1	The employee's payment method
uuid	string	The UUID of the employee in Gusto.
applicableTaxIds?	number[]	-
companyUuid?	string	The UUID of the company the employee is employed by.
currentEmploymentStatus?	CurrentEmploymentStatus | null	The current employment status of the employee. Full-time employees work 30+ hours per week. Part-time employees are split into two groups: those that work 20-29 hours a week, and those that work under 20 hours a week. Variable employees have hours that vary each week. Seasonal employees are hired for 6 months of the year or less.
customFields?	EmployeeCustomField[]	Custom fields are only included for the employee if the include param has the custom_fields value set
dateOfBirth?	string | null	-
department?	string | null	The employee's department in the company.
departmentUuid?	string | null	The UUID of the department the employee is under
eligiblePaidTimeOff?	PaidTimeOff[]	-
email?	string | null	The personal email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).
employeeCode?	string	The short format code of the employee
flsaStatus?	FlsaStatusType	The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company.
garnishments?	Garnishment[]	-
hasSsn?	boolean	Indicates whether the employee has an SSN in Gusto.
hiddenSsn?	string	-
hiredAt?	RFCDate	The date when the employee was hired to the company
historical?	boolean	-
jobs?	Job[]	-
managerUuid?	string | null	The UUID of the employee's manager.
memberPortalInvitationStatus?	EmployeeMemberPortalInvitationStatus | null	Member portal invitation status information. Only included when the include param has the portal_invitations value set.
middleInitial?	string | null	-
onboarded?	boolean	Whether the employee has completed onboarding.
onboardingDocumentsConfig?	OnboardingDocumentsConfig	Configuration for an employee onboarding documents during onboarding
onboardingStatus?	EmployeeOnboardingStatus1 | null	The current onboarding status of the employee
partnerPortalInvitationSent?	boolean | null	Whether an external partner portal invitation webhook has been sent for this employee. Only included when the include param has the portal_invitations value set.
phone?	string | null	-
preferredFirstName?	string | null	-
ssn?	string	Deprecated. This field always returns an empty string.
terminated?	boolean	Whether the employee is terminated.
terminations?	Termination[]	-
title?	string	-
twoPercentShareholder?	boolean | null	Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type.
version?	string	The current version of the employee. See the versioning guide for information on how to use this field.
workEmail?	string | null	The work email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).

---

EmployeeAddress

EmployeeAddress = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeaddress.ts:13

EmployeeAddress entity from the Gusto Embedded API.

Properties

Property	Type	Description
country	string	-
uuid	string	The UUID of the employee address
version	string	The current version of the object. See the versioning guide for information on how to use this field.
active?	boolean	The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.
city?	string	-
courtesyWithholding?	boolean	Determines if home taxes should be withheld and paid for employee.
effectiveDate?	RFCDate	The date the employee started living at the address.
employeeUuid?	string	The UUID of the employee
state?	string	-
street1?	string	-
street2?	string | null	-
warnings?	WarningObject[]	An array of warning objects that provide additional information about the address. Warnings do not prevent the address from being saved.
zip?	string	-

---

EmployeeBankAccount

EmployeeBankAccount = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeebankaccount.ts:26

EmployeeBankAccount entity from the Gusto Embedded API.

Properties

Property	Type	Description
uuid	string	UUID of the bank account
accountType?	EmployeeBankAccountAccountType	Bank account type
employeeUuid?	string	UUID of the employee
hiddenAccountNumber?	string	Masked bank account number
name?	string	Name for the bank account
routingNumber?	string	The bank account's routing number

---

EmployeeBankAccountAccountType

const EmployeeBankAccountAccountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeebankaccount.ts:15

Bank account type

Type Declaration

Name	Type
Checking	"Checking"
Savings	"Savings"

---

EmployeeBankAccountAccountType

EmployeeBankAccountAccountType = ClosedEnum<typeof EmployeeBankAccountAccountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeebankaccount.ts:15

Bank account type

---

EmployeeCompensations

EmployeeCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:396

EmployeeCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
additionalProperties?	object	-
benefits?	PayrollShowBenefits[]	An array of employee benefits for the pay period. Benefits are only included for processed payroll when the include parameter is present.
checkAmount?	string | null	The employee's check amount (as a string-formatted decimal, e.g. "1234.56"), equal to net_pay + reimbursements. This value is only available for processed payrolls.
customWithholdings?	PayrollShowCustomWithholdings	The one-time custom withholding overrides applied to this payroll for this employee. Remarks federal is null when no federal one-time override is set; state is an empty array when no state one-time overrides are set.
deductions?	PayrollShowDeductions[]	An array of employee deductions for the pay period. Only included when deductions is present in the include parameter.
employeeUuid?	string	The UUID of the employee.
excluded?	boolean	This employee will be excluded (skipped) from payroll calculation and will not be paid for the payroll. Cancelling a payroll would reset all employees' excluded back to false.
firstName?	string | null	The first name of the employee. Requires employees:read scope.
fixedCompensations?	PayrollShowFixedCompensations[]	An array of fixed compensations for the employee. Fixed compensations include tips and bonuses. On regular payrolls, reimbursements are sent via the dedicated reimbursements array instead. Off-cycle payrolls continue to include reimbursements in fixed_compensations. If this payroll has been processed, only fixed compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active fixed compensations are returned.
grossPay?	string | null	The employee's gross pay (as a string-formatted decimal, e.g. "1234.56"), equal to regular wages + cash tips + payroll tips + any other additional earnings, excluding imputed income.
hourlyCompensations?	PayrollShowHourlyCompensations[]	An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours. If this payroll has been processed, only hourly compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active hourly compensations are returned.
lastName?	string | null	The last name of the employee. Requires employees:read scope.
memo?	string | null	Custom text that will be printed as a personal note to the employee on a paystub.
netPay?	string | null	The employee's net pay (as a string-formatted decimal, e.g. "1234.56"), equal to gross_pay - employee taxes - employee deductions or garnishments - cash tips. This value is only available for processed payrolls.
paidTimeOff?	PayrollShowPaidTimeOff[]	An array of all paid time off the employee is eligible for this pay period.
payAdjustments?	PayAdjustments[]	Adjustments applied when calculating the employee's regular rate of pay for Remarks overtime purposes (e.g. a discretionary bonus allocated across workweeks), on calculated or processed payrolls.
paymentMethod?	PayrollShowPaymentMethod | null	The employee's compensation payment method. Is only Historical when retrieving external payrolls initially run outside of Gusto, then put into Gusto.
preferredFirstName?	string | null	The preferred first name of the employee. Requires employees:read scope.
reimbursements?	PayrollShowReimbursements[]	An array of reimbursements for the employee.
taxes?	PayrollShowTaxes[]	An array of employer and employee taxes for the pay period. Only included for processed or calculated payrolls when taxes is present in the include parameter.
version?	any	The current version of this employee compensation. This field is only available for prepared payrolls. See the versioning guide for information on how to use this field.

---

EmployeeCustomField

EmployeeCustomField = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeecustomfield.ts:18

A custom field of an employee

Properties

Property	Type	Description
companyCustomFieldId	string	This is the id of the response object from when you get the company custom fields
id	string	-
name	string	-
type	CustomFieldType	Input type for the custom field.
value	string	-
description?	string | null	-
selectionOptions?	string[] | null	An array of options for fields of type radio. Otherwise, null.

---

EmployeeFederalTax

EmployeeFederalTax = EmployeeFederalTaxPre2020 | EmployeeFederalTaxRev2020

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeefederaltax.ts:21

Federal tax information for an employee. The response structure varies based on the w4_data_type field.

---

EmployeeFederalTaxPre2020

EmployeeFederalTaxPre2020 = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeefederaltaxpre2020.ts:14

Federal tax information for employees using the pre-2020 W4 form.

Properties

Property	Type	Description
additionalWithholding	string	An additional withholding dollar amount.
version	string	The current version of the object. See the versioning guide for information on how to use this field.
w4DataType	"pre_2020_w4"	The version of w4 form.
companyId?	number	The internal ID of the company.
employeeId?	number	The internal ID of the employee.
employeeUuid?	string	The UUID of the employee.
federalWithholdingAllowance?	number | null	An exemption from paying a certain amount of income tax. May be null when filing_status is "Exempt from withholding".
filingStatus?	string | null	It determines which tax return form an individual will use and is an important factor in computing taxable income. One of: Remarks - Single - Married - Head of Household - Exempt from withholding - Married, but withhold as Single

---

EmployeeFederalTaxRev2020

EmployeeFederalTaxRev2020 = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeefederaltaxrev2020.ts:14

Federal tax information for employees using the revised 2020 W4 form.

Properties

Property	Type	Description
deductions	string | null	Deductions other than the standard deduction to reduce withholding.
dependentsAmount	string | null	A dependent is a person other than the taxpayer or spouse who entitles the taxpayer to claim a dependency exemption.
extraWithholding	string | null	An employee can request an additional amount to be withheld from each paycheck.
filingStatus	string | null	It determines which tax return form an individual will use and is an important factor in computing taxable income. One of: Remarks - Single - Married - Head of Household - Exempt from withholding
otherIncome	string | null	Other income amount.
twoJobs	boolean | null	If there are only two jobs (i.e., you and your spouse each have a job, or you have two), you can set it to true.
version	string	The current version of the object. See the versioning guide for information on how to use this field.
w4DataType	"rev_2020_w4"	The version of w4 form.
companyId?	number	The internal ID of the company.
employeeId?	number	The internal ID of the employee.
employeeUuid?	string	The UUID of the employee.

---

EmployeeMemberPortalInvitationStatus

EmployeeMemberPortalInvitationStatus = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:94

Member portal invitation status information. Only included when the include param has the portal_invitations value set.

Properties

Property	Type	Description
lastPasswordResentAt?	Date | null	The date and time when the password reset was last resent.
status?	EmployeeStatus	The current status of the member portal invitation.
tokenExpired?	boolean | null	Whether the invitation token has expired.
welcomeEmailSentAt?	Date | null	The date and time when the welcome email was sent.

---

EmployeeOnboardingStatus

EmployeeOnboardingStatus = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:77

The representation of an employee's onboarding status.

Properties

Property	Type	Description
uuid	string	Unique identifier for this employee.
blockers?	Blockers[]	Validation issues that should be resolved before this employee's onboarding is complete. Each entry identifies an affected field, a category describing the type of problem, and a human-readable message. Remarks Supported categories: - duplicate_value: Another employee in the same company already has this value. To resolve, cancel this onboarding and initiate a rehire if it's a returning employee, or contact support to investigate the conflict. This list may grow over time as new validation rules are added.
onboardingStatus?	string	One of the "onboarding_status" enum values.
onboardingSteps?	EmployeeOnboardingStatusOnboardingStep[]	List of steps required to onboard an employee.

---

EmployeeOnboardingStatus1

const EmployeeOnboardingStatus1: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:25

EmployeeOnboardingStatus1 entity from the Gusto Embedded API.

Type Declaration

Name	Type
AdminOnboardingIncomplete	"admin_onboarding_incomplete"
OnboardingCompleted	"onboarding_completed"
SelfOnboardingAwaitingAdminReview	"self_onboarding_awaiting_admin_review"
SelfOnboardingCompletedByEmployee	"self_onboarding_completed_by_employee"
SelfOnboardingInvited	"self_onboarding_invited"
SelfOnboardingInvitedOverdue	"self_onboarding_invited_overdue"
SelfOnboardingInvitedStarted	"self_onboarding_invited_started"
SelfOnboardingPendingInvite	"self_onboarding_pending_invite"

---

EmployeeOnboardingStatus1

EmployeeOnboardingStatus1 = ClosedEnum<typeof EmployeeOnboardingStatus1>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:25

EmployeeOnboardingStatus1 entity from the Gusto Embedded API.

---

EmployeeOnboardingStatusCategory

const EmployeeOnboardingStatusCategory: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:49

Category of the blocker. See the array-level description for resolution guidance.

Type Declaration

Name	Type
DuplicateValue	"duplicate_value"

---

EmployeeOnboardingStatusCategory

EmployeeOnboardingStatusCategory = ClosedEnum<typeof EmployeeOnboardingStatusCategory>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:49

Category of the blocker. See the array-level description for resolution guidance.

---

EmployeeOnboardingStatusOnboardingStep

EmployeeOnboardingStatusOnboardingStep = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:12

EmployeeOnboardingStatusOnboardingStep entity from the Gusto Embedded API.

Properties

Property	Type	Description
completed?	boolean	When true, this step has been completed.
id?	string	String identifier for the onboarding step.
required?	boolean	When true, this step is required.
requirements?	string[]	A list of onboarding steps required to begin this step.
title?	string	User-friendly description of the onboarding step.

---

EmployeePaymentMethod

EmployeePaymentMethod = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeepaymentmethod.ts:38

EmployeePaymentMethod entity from the Gusto Embedded API.

Properties

Property	Type	Description
splitBy?	EmployeePaymentMethodSplitBy | null	Describes how the payment will be split. If split_by is Percentage, then the split amounts must add up to exactly 100. If split_by is Amount, then the last split amount must be null to capture the remainder.
splits?	PaymentMethodBankAccount[] | null	-
type?	EmployeePaymentMethodType	The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

EmployeePaymentMethod1

const EmployeePaymentMethod1: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:56

The employee's payment method

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"

---

EmployeePaymentMethod1

EmployeePaymentMethod1 = ClosedEnum<typeof EmployeePaymentMethod1>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:56

The employee's payment method

---

EmployeePaymentMethodSplitBy

const EmployeePaymentMethodSplitBy: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeepaymentmethod.ts:30

EmployeePaymentMethodSplitBy entity from the Gusto Embedded API.

Type Declaration

Name	Type
Amount	"Amount"
Percentage	"Percentage"

---

EmployeePaymentMethodSplitBy

EmployeePaymentMethodSplitBy = ClosedEnum<typeof EmployeePaymentMethodSplitBy>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeepaymentmethod.ts:30

EmployeePaymentMethodSplitBy entity from the Gusto Embedded API.

---

EmployeePaymentMethodType

const EmployeePaymentMethodType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeepaymentmethod.ts:19

The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"

---

EmployeePaymentMethodType

EmployeePaymentMethodType = ClosedEnum<typeof EmployeePaymentMethodType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeepaymentmethod.ts:19

The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.

---

EmployeeStateTaxAnswer

EmployeeStateTaxAnswer = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxanswer.ts:16

EmployeeStateTaxAnswer entity from the Gusto Embedded API.

Properties

Property	Type	Description
validFrom?	string	The effective date of the answer - currently always “2010-01-01”.
validUpTo?	string | null	The effective end date of the answer - currently always null.
value?	string | number | boolean | null	The answer to the corresponding question - this may be a string, number, boolean, or null.

---

EmployeeStateTaxesList

EmployeeStateTaxesList = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxeslist.ts:15

EmployeeStateTaxesList entity from the Gusto Embedded API.

Properties

Property	Type	Description
employeeUuid?	string	The employee's uuid
fileNewHireReport?	boolean | null	-
isWorkState?	boolean	-
questions?	EmployeeStateTaxQuestion[]	-
state?	string	Two letter US state abbreviation
uuid?	string	The uuid of the employee state field.

---

EmployeeStateTaxesRequest

EmployeeStateTaxesRequest = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxesrequest.ts:26

EmployeeStateTaxesRequest entity from the Gusto Embedded API.

Properties

Property	Type
states	States[]

---

EmployeeStateTaxInputQuestionFormat

EmployeeStateTaxInputQuestionFormat = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxinputquestionformat.ts:29

EmployeeStateTaxInputQuestionFormat entity from the Gusto Embedded API.

Properties

Property	Type	Description
type	string	Describes the type of question - Text, Number, Select, Currency, Date
options?	EmployeeStateTaxInputQuestionFormatOptions[]	For "Select" type questions, the allowed values and display labels.

---

EmployeeStateTaxInputQuestionFormatOptions

EmployeeStateTaxInputQuestionFormatOptions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxinputquestionformat.ts:18

EmployeeStateTaxInputQuestionFormatOptions entity from the Gusto Embedded API.

Properties

Property	Type	Description
label	string	A display label that corresponds to the answer value
value?	string | boolean | number	An allowed value to answer the question

---

EmployeeStateTaxQuestion

EmployeeStateTaxQuestion = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxquestion.ts:19

EmployeeStateTaxQuestion entity from the Gusto Embedded API.

Properties

Property	Type	Description
answers	EmployeeStateTaxAnswer[]	-
description	string | null	An explaination of the question - this may contain inline html formatted links.
inputQuestionFormat	EmployeeStateTaxInputQuestionFormat	-
isQuestionForAdminOnly	boolean	-
key	string	A unique identifier of the question (for the given state) - used for updating the answer.
label	string	A short title for the question

---

EmployeeStatus

const EmployeeStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:79

The current status of the member portal invitation.

Type Declaration

Name	Type
Cancelled	"cancelled"
Complete	"complete"
Pending	"pending"
Sent	"sent"
Verified	"verified"

---

EmployeeStatus

EmployeeStatus = ClosedEnum<typeof EmployeeStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:79

The current status of the member portal invitation.

---

EmployeeWorkAddress

EmployeeWorkAddress = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeworkaddress.ts:11

EmployeeWorkAddress entity from the Gusto Embedded API.

Properties

Property	Type	Description
country	string	-
uuid	string	The unique identifier of this work address.
version	string	The current version of the object. See the versioning guide for information on how to use this field.
active?	boolean	Signifies if this address is the active work address for the current date
city?	string	-
effectiveDate?	string	The date the employee began working at this location.
employeeUuid?	string	UUID reference to the employee for this work address.
locationUuid?	string	UUID reference to the company location for this work address.
state?	string	-
street1?	string	-
street2?	string | null	-
zip?	string	-

---

EntityErrorObject

EntityErrorObject = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/entityerrorobject.ts:24

EntityErrorObject entity from the Gusto Embedded API.

Properties

Property	Type	Description
category	string	Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration. If category is nested_errors, the object will contain a nested errors property with entity errors.
errorKey	string	Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error.
errors?	EntityErrorObject[]	Will only exist if category is nested_errors. It is possible to have multiple levels of nested errors.
message?	string	Provides details about the error - generally this message can be surfaced to an end user.
metadata?	MetadataWithMultipleEntities | MetadataWithOneEntity	Contains relevant data to identify the resource in question when applicable. For example, to identify an entity entity_type and entity_uuid will be provided.

---

Federal

Federal = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:174

Federal one-time custom withholding override applied to this payroll.

Properties

Property	Type	Description
amount?	string	The amount that was withheld for this payroll.
amountType?	PayrollEmployeeCompensationsTypeAmountType	How to interpret the amount.
overrideType?	OverrideType	Override mode. Only one_time is currently exposed.

---

FederalHolidays

FederalHolidays = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:80

List of the eleven supported federal holidays and their details

Properties

Property	Type
christmasDay?	ChristmasDay
columbusDay?	ColumbusDay
independenceDay?	IndependenceDay
juneteenth?	Juneteenth
laborDay?	LaborDay
memorialDay?	MemorialDay
mlkDay?	MlkDay
newYearsDay?	NewYearsDay
presidentsDay?	PresidentsDay
thanksgiving?	Thanksgiving
veteransDay?	VeteransDay

---

FederalTaxDetails

FederalTaxDetails = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:88

FederalTaxDetails entity from the Gusto Embedded API.

Properties

Property	Type	Description
depositSchedule?	string	How often the company sends money to the IRS. One of: Remarks - Semiweekly - Monthly
effectiveDate?	string	The date that these details took effect.
einVerification?	EinVerification	Information about the status of verifying the company's Employer Identification Number (EIN)
einVerified?	boolean	Whether the EIN has been successfully verified as a valid EIN with the IRS.
filingForm?	FilingForm	The form used by the company for federal tax filing. One of: Remarks - 941 (Quarterly federal tax return form) - 944 (Annual federal tax return form)
hasEin?	boolean	Whether company's Employer Identification Number (EIN) is present
legalName?	string	The legal name of the company
taxableAsScorp?	boolean	Whether the company is taxed as an S-Corporation. Tax payer types that may be taxed as an S-Corporation include: Remarks - S-Corporation - C-Corporation - LLC
taxPayerType?	TaxPayerType | null	What type of tax entity the company is. One of: Remarks - C-Corporation - S-Corporation - Sole proprietor - LLC - LLP - Limited partnership - Co-ownership - Association - Trusteeship - General partnership - Joint venture - Non-Profit
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

FederalTaxDetailsStatus

const FederalTaxDetailsStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:56

The status of EIN verification:

Remarks

• pending: The EIN verification process has not completed (or the company does not yet have an EIN).
• verified: The EIN has been successfully verified as a valid EIN with the IRS.
• failed: The company's EIN did not pass verification. Common issues are being entered incorrectly or not matching the company's legal name.

Type Declaration

Name	Type
Failed	"failed"
Pending	"pending"
Verified	"verified"

---

FederalTaxDetailsStatus

FederalTaxDetailsStatus = ClosedEnum<typeof FederalTaxDetailsStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:56

The status of EIN verification:

Remarks

• pending: The EIN verification process has not completed (or the company does not yet have an EIN).
• verified: The EIN has been successfully verified as a valid EIN with the IRS.
• failed: The company's EIN did not pass verification. Common issues are being entered incorrectly or not matching the company's legal name.

---

Field

const Field: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:38

The employee field affected.

Type Declaration

Name	Type
Ssn	"ssn"

---

Field

Field = ClosedEnum<typeof Field>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeeonboardingstatus.ts:38

The employee field affected.

---

Fields

Fields = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/document.ts:36

Fields entity from the Gusto Embedded API.

Properties

Property	Type	Description
dataType?	string	The field's data type
height?	number | null	Height of the field. May be null when the field has no positioning information.
key?	string | null	Unique identifier of the field. May be null for custom fields that do not correspond to a known Gusto-managed key mapping.
pageNumber?	number | null	Page number of the field. May be null when the field has no positioning information.
required?	boolean	Whether the field is required
value?	string | null	Auto-filled value of the field
width?	number | null	Width of the field. May be null when the field has no positioning information.
x?	number | null	X-coordinate location of the field on the page. May be null when the field has no positioning information.
y?	number | null	Y-coordinate location of the field on the page. May be null when the field has no positioning information.

---

FilingForm

const FilingForm: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:35

The form used by the company for federal tax filing. One of:

Remarks

• 941 (Quarterly federal tax return form)
• 944 (Annual federal tax return form)

Type Declaration

Name	Type
NineHundredAndFortyFour	"944"
NineHundredAndFortyOne	"941"

---

FilingForm

FilingForm = ClosedEnum<typeof FilingForm>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:35

The form used by the company for federal tax filing. One of:

Remarks

• 941 (Quarterly federal tax return form)
• 944 (Annual federal tax return form)

---

FipsCodes

FipsCodes = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/childsupportdata.ts:12

FipsCodes entity from the Gusto Embedded API.

Properties

Property	Type	Description
code?	string	FIPS code for state or county
county?	string | null	Name of county in the state for the corresponding FIPS code. When null the FIPS code applies state wide.

---

FixedCompensations

FixedCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:37

FixedCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount of the compensation for the pay period.
breakdowns?	Breakdowns[]	Per-workweek amounts for this compensation, one entry per workweek Remarks overlapping the pay period.
jobUuid?	string	The UUID of the job for the compensation.
name?	string	The name of the compensation. This also serves as the unique, immutable identifier for this compensation.

---

FlsaStatusType

const FlsaStatusType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/flsastatustype.ts:11

The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company.

Type Declaration

Name	Type
CommissionOnlyExempt	"Commission Only Exempt"
CommissionOnlyNonexempt	"Commission Only Nonexempt"
Exempt	"Exempt"
Nonexempt	"Nonexempt"
Owner	"Owner"
SalariedNonexempt	"Salaried Nonexempt"

---

FlsaStatusType

FlsaStatusType = ClosedEnum<typeof FlsaStatusType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/flsastatustype.ts:11

The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company.

---

Form

Form = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/form.ts:11

Form entity from the Gusto Embedded API.

Properties

Property	Type	Description
uuid	string	The UUID of the form
description?	string	The description of the form
documentContentType?	string | null	The content type of the associated document. Most forms are PDFs with a content type of application/pdf. Some tax file packages will be zip files (containing PDFs) with a content type of application/zip. This attribute will be null when the document has not been prepared.
draft?	boolean	If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.
employeeUuid?	string	The UUID of the employee to which the form belongs, if applicable.
name?	string	The type identifier of the form
quarter?	number | null	The quarter of this form. For some forms, e.g. tax forms, this is the calendar quarter which this form represents. An Employer's Quarterly Federal Tax Return (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year value of 2022). This value is nullable and will not be present on all forms.
requiresSigning?	boolean	A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.
title?	string	The title of the form
year?	number | null	The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A W2 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.

---

Garnishment

Garnishment = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/garnishment.ts:30

Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments.

Properties

Property	Type	Description
active	boolean	Whether or not this garnishment is currently active.
annualMaximum	string | null	The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00".
deductAsPercentage	boolean	Whether the amount should be treated as a percentage to be deducted per pay period.
payPeriodMaximum	string | null	The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. "16.00".
recurring	boolean	Whether the garnishment should recur indefinitely.
times	number | null	The number of times to apply the garnishment. Ignored if recurring is true.
totalAmount	string | null	A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
uuid	string	The UUID of the garnishment in Gusto.
amount?	string	The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. "8.00".
childSupport?	GarnishmentChildSupport | null	Additional child support order details
courtOrdered?	boolean	Whether the garnishment is court ordered.
description?	string	The description of the garnishment.
employeeUuid?	string	The UUID of the employee to which this garnishment belongs.
garnishmentType?	GarnishmentType | null	The specific type of garnishment for court ordered garnishments.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

GarnishmentChildSupport

GarnishmentChildSupport = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/garnishmentchildsupport.ts:29

Additional child support order details

Properties

Property	Type	Description
caseNumber?	string | null	Child Support Enforcement Case Number associated with this child support obligation - required for most states. Agency specific requirements are available in the GET /v1/garnishments/child_support API.
fipsCode?	string	The FIPS code associated with the state or county agency issuing the child support order. Agency data is available in the GET /v1/garnishments/child_support API.
orderNumber?	string | null	Order Identifier or Order ID associated with this child support obligation - required for some states. Agency specific requirements are available in the GET /v1/garnishments/child_support API.
paymentPeriod?	PaymentPeriod	How often the agency collects the withholding amount. e.g. $500 monthly -> Monthly.
remittanceNumber?	string | null	Child Support Enforcement Remittance ID associated with this child support obligation - required for some states. Agency specific requirements are available in the GET /v1/garnishments/child_support API.
state?	string	The two letter state abbreviation for the state issuing the child support order. Agency data is available in the GET /v1/garnishments/child_support API.

---

GarnishmentType

const GarnishmentType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/garnishment.ts:16

GarnishmentType entity from the Gusto Embedded API.

Type Declaration

Name	Type
ChildSupport	"child_support"
CreditorGarnishment	"creditor_garnishment"
FederalLoan	"federal_loan"
FederalTaxLien	"federal_tax_lien"
OtherGarnishment	"other_garnishment"
StateTaxLien	"state_tax_lien"
StudentLoan	"student_loan"

---

GarnishmentType

GarnishmentType = ClosedEnum<typeof GarnishmentType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/garnishment.ts:16

GarnishmentType entity from the Gusto Embedded API.

---

GeneratedDocumentStatus

const GeneratedDocumentStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/generateddocument.ts:15

Current status of the Generated Document

Type Declaration

Name	Type
Failed	"failed"
Pending	"pending"
Started	"started"
Succeeded	"succeeded"

---

GeneratedDocumentStatus

GeneratedDocumentStatus = ClosedEnum<typeof GeneratedDocumentStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/generateddocument.ts:15

Current status of the Generated Document

---

HolidayPayPolicy

HolidayPayPolicy = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:101

Representation of a Holiday Pay Policy

Properties

Property	Type	Description
companyUuid	string	A unique identifier for the company owning the holiday pay policy
employees	HolidayPayPolicyEmployees[]	List of employee uuids under a holiday pay policy
federalHolidays	FederalHolidays	List of the eleven supported federal holidays and their details
version	string	The current version of the object. See the versioning guide for information on how to use this field.

---

HolidayPayPolicyEmployees

HolidayPayPolicyEmployees = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:94

HolidayPayPolicyEmployees entity from the Gusto Embedded API.

Properties

Property	Type
uuid?	string

---

HourlyCompensations

HourlyCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:74

HourlyCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount of the compensation. This field is only available after the payroll is calculated and cannot be used for updating hourly compensations.
breakdowns?	PayrollEmployeeCompensationsTypeBreakdowns[]	Per-workweek hours for this compensation, one entry per workweek Remarks overlapping the pay period.
compensationMultiplier?	number	The amount multiplied by the base rate to calculate total compensation per hour worked.
flsaStatus?	string	The FLSA Status of the employee's primary job compensation
hours?	string	The number of hours to be compensated for this pay period.
jobUuid?	string	The UUID of the job for the compensation.
name?	string	The name of the compensation. This also serves as the unique, immutable identifier for this compensation.

---

Id

const Id: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companyonboardingstatus.ts:15

The string identifier for each onboarding step

Type Declaration

Name	Type
AddAddresses	"add_addresses"
AddBankInfo	"add_bank_info"
AddEmployees	"add_employees"
ExternalPayroll	"external_payroll"
FederalTaxSetup	"federal_tax_setup"
PayrollSchedule	"payroll_schedule"
SelectIndustry	"select_industry"
SignAllForms	"sign_all_forms"
StateSetup	"state_setup"
VerifyBankInfo	"verify_bank_info"

---

Id

Id = ClosedEnum<typeof Id>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companyonboardingstatus.ts:15

The string identifier for each onboarding step

---

IdentityVerificationStatus

const IdentityVerificationStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/signatory.ts:12

IdentityVerificationStatus entity from the Gusto Embedded API.

Type Declaration

Name	Type
Fail	"Fail"
Pass	"Pass"
Skipped	"Skipped"

---

IdentityVerificationStatus

IdentityVerificationStatus = ClosedEnum<typeof IdentityVerificationStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/signatory.ts:12

IdentityVerificationStatus entity from the Gusto Embedded API.

---

IndependenceDay

IndependenceDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:41

IndependenceDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

InformationRequest

InformationRequest = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:67

Representation of an information request

Properties

Property	Type	Description
blockingPayroll?	boolean	If true, this information request is blocking payroll, and may require response or requires review from our Risk Ops team.
companyUuid?	string	Unique identifier of the company to which the information requests belongs
requiredQuestions?	RequiredQuestions[]	The list of required questions for the information request
status?	InformationRequestStatus	The status of the information request
type?	InformationRequestType | null	The type of information request
uuid?	string	Unique identifier of an information request

---

InformationRequestStatus

const InformationRequestStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:23

The status of the information request

Type Declaration

Name	Type
Approved	"approved"
PendingResponse	"pending_response"
PendingReview	"pending_review"

---

InformationRequestStatus

InformationRequestStatus = ClosedEnum<typeof InformationRequestStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:23

The status of the information request

---

InformationRequestType

const InformationRequestType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:12

InformationRequestType entity from the Gusto Embedded API.

Type Declaration

Name	Type
AccountProtection	"account_protection"
CompanyOnboarding	"company_onboarding"
PaymentError	"payment_error"
PaymentRequest	"payment_request"

---

InformationRequestType

InformationRequestType = ClosedEnum<typeof InformationRequestType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:12

InformationRequestType entity from the Gusto Embedded API.

---

Job

Job = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/job.ts:16

The representation of a job in Gusto.

Properties

Property	Type	Description
title	string | null	The title for the job.
uuid	string	The UUID of the job.
compensations?	Compensation[]	The compensation history for this job, including pay rate, payment unit, FLSA status, and effective dates. This is sensitive pay information and requires the compensations:read scope.
currentCompensationUuid?	string	The UUID of the current active compensation record for this job. Requires the compensations:read scope.
employeeUuid?	string	The UUID of the employee to which the job belongs.
hireDate?	string	The date when the employee was hired or rehired for the job.
location?	Location	The representation of an address in Gusto.
locationUuid?	string	The uuid of the employee's work location.
paymentUnit?	string | null	How the employee is paid for this job (e.g., Hour, Week, Month, Year, Paycheck). This is sensitive compensation data and requires the compensations:read scope.
primary?	boolean	Whether this is the employee's primary job. The value will be set to true unless an existing job exists for the employee.
rate?	string	The employee's pay rate for this job (e.g., hourly wage or annual salary). This is sensitive compensation data and requires the compensations:read scope.
stateWcClassCode?	string | null	The risk class code for workers' compensation in Washington state. Please visit Washington state's Risk Class page to learn more.
stateWcCovered?	boolean | null	Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).
twoPercentShareholder?	boolean	Whether the employee owns at least 2% of the company.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

Juneteenth

Juneteenth = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:35

Juneteenth entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

LaborDay

LaborDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:47

LaborDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

Licensee

Licensee = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentreceipt.ts:85

The licensed payroll processor

Properties

Property	Type	Description
address?	string	Always the fixed string "525 20th St"
city?	string	Always the fixed string "San Francisco"
name?	string	Always the fixed string "Gusto, Zenpayroll Inc."
phoneNumber?	string	Always the fixed string "4157778888"
postalCode?	string	Always the fixed string "94107"
state?	string	Always the fixed string "CA"

---

Location

Location = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/location.ts:15

The representation of an address in Gusto.

Properties

Property	Type	Description
country	string	-
uuid	string	The UUID of the location object.
active?	boolean	The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.
city?	string	-
companyUuid?	string	The UUID for the company to which the location belongs. Only included if the location belongs to a company.
createdAt?	string	Datetime for when location is created
filingAddress?	boolean	Specifies if the location is the company's filing address. Only included if the location belongs to a company.
inactive?	boolean	The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.
mailingAddress?	boolean	Specifies if the location is the company's mailing address. Only included if the location belongs to a company.
phoneNumber?	string	The phone number for the location. Required for company locations. Optional for employee locations.
state?	string	-
street1?	string	-
street2?	string | null	-
updatedAt?	string	Datetime for when location is updated
version?	string	The current version of the object. See the versioning guide for information on how to use this field.
warnings?	WarningObject[]	An array of warning objects that provide additional information about the address. Warnings do not prevent the address from being saved.
zip?	string	-

---

MemberPortalInvitationStatus

MemberPortalInvitationStatus = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:105

Member portal invitation status information. Only included when the include param has the portal_invitations value set.

Properties

Property	Type	Description
lastPasswordResentAt?	Date | null	The date and time when the password reset was last resent.
status?	ContractorStatus	The current status of the member portal invitation.
tokenExpired?	boolean | null	Whether the invitation token has expired.
welcomeEmailSentAt?	Date | null	The date and time when the welcome email was sent.

---

MemorialDay

MemorialDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:29

MemorialDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

MetadataWithMultipleEntities

MetadataWithMultipleEntities = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/metadatawithmultipleentities.ts:17

multiple entities

Properties

Property	Type
entities	MetadataWithOneEntity[]

---

MetadataWithOneEntity

MetadataWithOneEntity = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/metadatawithoneentity.ts:17

single entity

Properties

Property	Type	Description
additionalProperties?	object	-
entityType?	string	Name of the entity that the error corresponds to.
entityUuid?	string	Unique identifier for the entity.
key?	string | null	-
state?	string | null	-
validFrom?	string | null	-
validUpTo?	string | null	-

---

MinimumWage

MinimumWage = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/minimumwage.ts:15

Representation of a Minimum Wage

Properties

Property	Type	Description
authority	string	The governing authority that created the minimum wage, e.g. "City", "State", or "Federal".
effectiveDate	RFCDate	The date the minimum wage rule is effective on.
uuid	string	unique identifier of a minimum wage
wage	string	The wage rate for a minimum wage record. Represented as a float, e.g. "15.0".
wageType	string	The type of wage the minimum wage applies to, e.g. "Regular", "Regular-Industry-Specific".
notes?	string	Description of parties the minimum wage applies to.

---

MinimumWages

MinimumWages = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/compensation.ts:31

MinimumWages entity from the Gusto Embedded API.

Properties

Property	Type	Description
effectiveDate?	string	The effective date of the minimum wage.
uuid?	string	The UUID of the minimum wage.
wage?	string	The wage amount.

---

MlkDay

MlkDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:17

MlkDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

Name

const Name: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/paidtimeoff.ts:12

Name entity from the Gusto Embedded API.

Type Declaration

Name	Type
HolidayHours	"Holiday Hours"
SickHours	"Sick Hours"
VacationHours	"Vacation Hours"

---

Name

Name = ClosedEnum<typeof Name>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/paidtimeoff.ts:12

Name entity from the Gusto Embedded API.

---

NewYearsDay

NewYearsDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:11

NewYearsDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

OffCycleReasonType

const OffCycleReasonType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:64

OffCycleReasonType entity from the Gusto Embedded API.

Type Declaration

Name	Type
Adhoc	"Adhoc"
BenefitReversal	"Benefit reversal"
Bonus	"Bonus"
Correction	"Correction"
DisabilityInsuranceDistribution	"Disability insurance distribution"
DismissedEmployee	"Dismissed employee"
HiredEmployee	"Hired employee"
Reversal	"Reversal"
TaxReconciliation	"Tax reconciliation"
TransitionFromOldPaySchedule	"Transition from old pay schedule"
WageCorrection	"Wage correction"

---

OffCycleReasonType

OffCycleReasonType = ClosedEnum<typeof OffCycleReasonType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:64

OffCycleReasonType entity from the Gusto Embedded API.

---

OnboardingDocumentsConfig

OnboardingDocumentsConfig = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employee.ts:42

Configuration for an employee onboarding documents during onboarding

Properties

Property	Type	Description
i9Document?	boolean	Whether to include Form I-9 for an employee during onboarding
uuid?	string | null	The UUID of the onboarding documents config

---

OnboardingStatus

const OnboardingStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:51

One of the "onboarding_status" enum values.

Type Declaration

Name	Type
AdminOnboardingIncomplete	"admin_onboarding_incomplete"
AdminOnboardingReview	"admin_onboarding_review"
OnboardingCompleted	"onboarding_completed"
SelfOnboardingInvited	"self_onboarding_invited"
SelfOnboardingNotInvited	"self_onboarding_not_invited"
SelfOnboardingReview	"self_onboarding_review"
SelfOnboardingStarted	"self_onboarding_started"

---

OnboardingStatus

OnboardingStatus = ClosedEnum<typeof OnboardingStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:51

One of the "onboarding_status" enum values.

---

OnboardingStep

OnboardingStep = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companyonboardingstatus.ts:48

OnboardingStep entity from the Gusto Embedded API.

Properties

Property	Type	Description
completed?	boolean	The boolean flag indicating whether the step is completed or not.
completedAt?	string | null	The ISO 8601 timestamp indicating when the onboarding step was completed.
id?	Id	The string identifier for each onboarding step
required?	boolean	The boolean flag indicating whether the step is required or optional
requirements?	CompanyOnboardingStatusRequirements[]	A list of onboarding steps that are required to be completed in order to proceed with the current onboarding step.
skippable?	boolean	The boolean flag indicating whether the step can be skipped or not.
title?	string	The display name of the onboarding step

---

Options

Options = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:57

Options entity from the Gusto Embedded API.

Properties

Property	Type	Description
label	string	A customer facing label for the answer
value	string | boolean	The actual value to be submitted
shortLabel?	string | null	A less verbose label that may sometimes be available

---

OverrideType

const OverrideType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:149

Override mode. Only one_time is currently exposed.

Type Declaration

Name	Type
OneTime	"one_time"

---

OverrideType

OverrideType = ClosedEnum<typeof OverrideType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:149

Override mode. Only one_time is currently exposed.

---

Pages

Pages = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/document.ts:25

Pages entity from the Gusto Embedded API.

Properties

Property	Type	Description
imageUrl?	string	Image URL for the page
pageNumber?	number	Page number

---

PaidTimeOff

PaidTimeOff = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/paidtimeoff.ts:22

The representation of paid time off in Gusto.

Properties

Property	Type	Description
accrualBalance?	string | null	The number of accrual units accrued.
accrualMethod?	string | null	The accrual method of the time off policy
accrualPeriod?	string | null	The frequency at which the PTO type is accrued.
accrualRate?	string | null	The number of accrual units accrued per accrual period.
accrualUnit?	string | null	The unit the PTO type is accrued in.
maximumAccrualBalance?	string | null	The maximum number of accrual units allowed. A null value signifies no maximum.
name?	Name | null	The name of the paid time off type.
paidAtTermination?	boolean	Whether the accrual balance is paid to the employee upon termination.
policyName?	string | null	The name of the time off policy.
policyUuid?	string | null	The UUID of the time off policy.

---

PayAdjustments

PayAdjustments = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:385

PayAdjustments entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The dollar amount of the adjustment.
name?	string	The name of the pay adjustment.

---

PaymentMethodBankAccount

PaymentMethodBankAccount = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/paymentmethodbankaccount.ts:14

Representation of a bank account item

Properties

Property	Type	Description
uuid	string	The bank account ID
hiddenAccountNumber?	string	Masked bank account number
name?	string	The bank account name
priority?	number	The order of priority for each payment split, with priority 1 being the first bank account paid. Priority must be unique and sequential.
splitAmount?	number | null	If split_by is 'Amount', this is in cents (e.g., 500 for $5.00) and exactly one account must have a split_amount of null to capture the remainder. If split_by is 'Percentage', this is the percentage value (e.g., 60 for 60%).

---

PaymentPeriod

const PaymentPeriod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/garnishmentchildsupport.ts:15

How often the agency collects the withholding amount. e.g. $500 monthly -> Monthly.

Type Declaration

Name	Type
EveryOtherWeek	"Every other week"
EveryWeek	"Every week"
Monthly	"Monthly"
TwicePerMonth	"Twice per month"

---

PaymentPeriod

PaymentPeriod = ClosedEnum<typeof PaymentPeriod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/garnishmentchildsupport.ts:15

How often the agency collects the withholding amount. e.g. $500 monthly -> Monthly.

---

PaymentSpeed

const PaymentSpeed: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/paymentconfigs.ts:20

Payment speed. READ-ONLY.

Remarks

• 1-day: Next-day ACH (only for partners that opt in).
• 2-day: Two-day ACH.
• 4-day: Standard ACH.

Type Declaration

Name	Type
FourMinusDay	"4-day"
OneMinusDay	"1-day"
TwoMinusDay	"2-day"

---

PaymentSpeed

PaymentSpeed = ClosedEnum<typeof PaymentSpeed>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/paymentconfigs.ts:20

Payment speed. READ-ONLY.

Remarks

• 1-day: Next-day ACH (only for partners that opt in).
• 2-day: Two-day ACH.
• 4-day: Standard ACH.

---

PaymentType

const PaymentType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/wireinrequest.ts:29

Type of payment for the wire in

Type Declaration

Name	Type
ContractorPaymentGroup	"ContractorPaymentGroup"
Payroll	"Payroll"

---

PaymentType

PaymentType = ClosedEnum<typeof PaymentType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/wireinrequest.ts:29

Type of payment for the wire in

---

PaymentUnit

const PaymentUnit: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/compensation.ts:19

The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.

Type Declaration

Name	Type
Hour	"Hour"
Month	"Month"
Paycheck	"Paycheck"
Week	"Week"
Year	"Year"

---

PaymentUnit

PaymentUnit = ClosedEnum<typeof PaymentUnit>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/compensation.ts:19

The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.

---

PayPeriod

PayPeriod = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payperiod.ts:53

The representation of a pay period.

Properties

Property	Type	Description
endDate?	string	The end date, inclusive, of the pay period.
payroll?	PayPeriodPayroll	Information about the payroll for the pay period.
payScheduleUuid?	string	A unique identifier of the pay schedule to which the pay period belongs.
startDate?	string	The start date, inclusive, of the pay period.

---

PayPeriodPayroll

PayPeriodPayroll = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payperiod.ts:27

Information about the payroll for the pay period.

Properties

Property	Type	Description
checkDate?	string	The date on which employees will be paid for the payroll if the payroll is submitted on time.
payrollDeadline?	Date	The date by which payroll should be run for employees to be paid on time. Payroll data, such as time and attendance data, should be submitted on or before this date.
payrollType?	PayrollType	Whether it is regular pay period or transition pay period.
payrollUuid?	string	The UUID of the payroll for this pay period.
processed?	boolean	Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.

---

Payroll

Payroll = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:703

Payroll entity from the Gusto Embedded API.

Properties

Property	Type	Description
autoPayroll?	boolean	Indicates whether the payroll has automatic payroll enabled
calculatedAt?	Date | null	A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.
checkDate?	string	The date on which employees will be paid for the payroll.
companyTaxes?	PayrollCompanyTaxesType[]	An array of taxes applicable to this payroll in addition to taxes included in employee_compensations. Only included for processed or calculated payrolls when taxes is present in the include parameter.
companyUuid?	string	The UUID of the company for the payroll.
createdAt?	Date	Datetime for when the resource was created.
creditBlockers?	PayrollCreditBlockerType[]	Only included for processed payrolls
external?	boolean	Indicates whether the payroll is an external payroll
finalTerminationPayroll?	boolean	Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
fixedWithholdingRate?	boolean | null	Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.
offCycle?	boolean	Indicates whether the payroll is an off-cycle payroll
offCycleReason?	OffCycleReasonType | null	The off-cycle reason. Only included for off-cycle payrolls.
partnerOwnedDisbursement?	boolean | null	Will money movement for the payroll be performed by the partner rather than by Gusto?
paymentSpeedChanged?	PayrollPaymentSpeedChangedType	Only applicable when a payroll is moved to four day processing instead of fast ach.
payPeriod?	PayrollPayPeriodType	-
payrollDeadline?	Date	A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.
payrollStatusMeta?	PayrollPayrollStatusMetaType	Information about the payroll's status and expected dates
payrollTaxes?	PayrollTaxesType[]	An array of tax totals applicable to this payroll. Only included for processed or calculated payrolls when payroll_taxes is present in the include parameter.
payrollUuid?	string	The UUID of the payroll.
processed?	boolean	Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.
processedDate?	string | null	The date at which the payroll was processed. Null if the payroll isn't processed yet.
processingRequest?	PayrollProcessingRequest | null	-
skipRegularDeductions?	boolean | null	Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.
submissionBlockers?	PayrollSubmissionBlockerType[]	Only included for processed or calculated payrolls
totals?	PayrollTotalsType	The subtotals for the payroll.
uuid?	string	The UUID of the payroll.
withholdingPayPeriod?	PayrollWithholdingPayPeriodType | null	The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.

---

PayrollCompanyTaxesType

PayrollCompanyTaxesType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcompanytaxestype.ts:10

PayrollCompanyTaxesType entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount of this tax for the payroll
employer?	boolean	Whether this tax is an employer or employee tax
name?	string	The tax name

---

PayrollCreditBlockerType

PayrollCreditBlockerType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockertype.ts:53

A blocker that prevents payment crediting.

Properties

Property	Type	Description
blockerName?	string	The name of the credit blocker.
blockerType?	string	The type of blocker that's blocking the payment from being credited.
selectedOption?	string | null	The unblock option that's been selected to resolve the credit blocker.
status?	PayrollCreditBlockerTypeStatus	The status of the credit blocker
unblockOptions?	(PayrollCreditBlockerUnblockOptionSubmitWire | PayrollCreditBlockerUnblockOptionSubmitBankScreenshot | PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi | PayrollCreditBlockerUnblockOptionWaitForReverseWire)[]	The available options to unblock a credit blocker.

---

PayrollCreditBlockerTypeStatus

const PayrollCreditBlockerTypeStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockertype.ts:37

The status of the credit blocker

Type Declaration

Name	Type
Failed	"failed"
PendingReview	"pending_review"
Resolved	"resolved"
Unresolved	"unresolved"

---

PayrollCreditBlockerTypeStatus

PayrollCreditBlockerTypeStatus = ClosedEnum<typeof PayrollCreditBlockerTypeStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockertype.ts:37

The status of the credit blocker

---

PayrollCreditBlockerTypeUnblockOptions

PayrollCreditBlockerTypeUnblockOptions = PayrollCreditBlockerUnblockOptionSubmitWire | PayrollCreditBlockerUnblockOptionSubmitBankScreenshot | PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi | PayrollCreditBlockerUnblockOptionWaitForReverseWire

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockertype.ts:28

PayrollCreditBlockerTypeUnblockOptions entity from the Gusto Embedded API.

---

PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi

PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionrespondtohighriskfraudrfi.ts:22

Unblock option to resolve a credit blocker by responding to high risk fraud RFI

Properties

Property	Type	Description
checkDate	string	The payment check date associated with the unblock option
metadata	PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfiMetadata	-
unblockType	"respond_to_high_risk_fraud_rfi"	The type of unblock option for the credit blocker

---

PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfiMetadata

PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfiMetadata = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionrespondtohighriskfraudrfi.ts:11

PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfiMetadata entity from the Gusto Embedded API.

Properties

Property	Type	Description
informationRequestUuid	string	UUID of the information request

---

PayrollCreditBlockerUnblockOptionSubmitBankScreenshot

PayrollCreditBlockerUnblockOptionSubmitBankScreenshot = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionsubmitbankscreenshot.ts:25

Unblock option to resolve a credit blocker by submitting a bank screenshot

Properties

Property	Type	Description
checkDate	string	The payment check date associated with the unblock option
metadata	PayrollCreditBlockerUnblockOptionSubmitBankScreenshotMetadata	-
unblockType	"submit_bank_screenshot"	The type of unblock option for the credit blocker

---

PayrollCreditBlockerUnblockOptionSubmitBankScreenshotMetadata

PayrollCreditBlockerUnblockOptionSubmitBankScreenshotMetadata = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionsubmitbankscreenshot.ts:11

PayrollCreditBlockerUnblockOptionSubmitBankScreenshotMetadata entity from the Gusto Embedded API.

Properties

Property	Type	Description
informationRequestUuid	string	UUID of the information request
bankAccountLastFourDigits?	string | null	Last 4 digits of the bank account number for the bank screenshot RFI

---

PayrollCreditBlockerUnblockOptionSubmitWire

PayrollCreditBlockerUnblockOptionSubmitWire = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionsubmitwire.ts:29

Unblock option to resolve a credit blocker by submitting a wire transfer

Properties

Property	Type	Description
checkDate	string	The payment check date associated with the unblock option
metadata	PayrollCreditBlockerUnblockOptionSubmitWireMetadata	-
unblockType	"submit_wire"	The type of unblock option for the credit blocker

---

PayrollCreditBlockerUnblockOptionSubmitWireMetadata

PayrollCreditBlockerUnblockOptionSubmitWireMetadata = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionsubmitwire.ts:11

PayrollCreditBlockerUnblockOptionSubmitWireMetadata entity from the Gusto Embedded API.

Properties

Property	Type	Description
wireInAmount	string	The amount to be wired in (decimal string)
wireInDeadline	Date	Deadline for the wire transfer to be received
wireInRequestUuid	string	UUID of the wire in request

---

PayrollCreditBlockerUnblockOptionWaitForReverseWire

PayrollCreditBlockerUnblockOptionWaitForReverseWire = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionwaitforreversewire.ts:16

Unblock option to resolve a credit blocker by waiting for reverse wire

Properties

Property	Type	Description
checkDate	string	The payment check date associated with the unblock option
metadata	PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadata	-
unblockType	"wait_for_reverse_wire"	The type of unblock option for the credit blocker

---

PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadata

PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadata = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollcreditblockerunblockoptionwaitforreversewire.ts:11

PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadata entity from the Gusto Embedded API.

---

PayrollEmployeeCompensationsType

PayrollEmployeeCompensationsType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:291

PayrollEmployeeCompensationsType entity from the Gusto Embedded API.

Properties

Property	Type	Description
checkAmount?	string | null	The employee's check amount (as a string-formatted decimal, e.g. "1234.56"), equal to net_pay + reimbursements. This value is only available for processed payrolls.
customWithholdings?	CustomWithholdings	The one-time custom withholding overrides applied to this payroll for this employee. Remarks federal is null when no federal one-time override is set; state is an empty array when no state one-time overrides are set.
deductions?	Deductions[]	An array of deductions for the employee. This field is included by default for regular payrolls in version v2025-06-15 and later.
employeeUuid?	string	The UUID of the employee.
excluded?	boolean	This employee will be excluded (skipped) from payroll calculation and will not be paid for the payroll. Cancelling a payroll would reset all employees' excluded back to false.
firstName?	string | null	The first name of the employee. Requires employees:read scope.
fixedCompensations?	FixedCompensations[]	An array of fixed compensations for the employee. Fixed compensations include tips and bonuses. On regular payrolls, reimbursements are sent via the dedicated reimbursements array instead. Off-cycle payrolls continue to include reimbursements in fixed_compensations. If this payroll has been processed, only fixed compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active fixed compensations are returned.
grossPay?	string | null	The employee's gross pay (as a string-formatted decimal, e.g. "1234.56"), equal to regular wages + cash tips + payroll tips + any other additional earnings, excluding imputed income.
hourlyCompensations?	HourlyCompensations[]	An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours. If this payroll has been processed, only hourly compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active hourly compensations are returned.
lastName?	string | null	The last name of the employee. Requires employees:read scope.
memo?	string | null	Custom text that will be printed as a personal note to the employee on a paystub.
netPay?	string | null	The employee's net pay (as a string-formatted decimal, e.g. "1234.56"), equal to gross_pay - employee taxes - employee deductions or garnishments - cash tips. This value is only available for processed payrolls.
paidTimeOff?	PayrollEmployeeCompensationsTypePaidTimeOff[]	An array of all paid time off the employee is eligible for this pay period.
paymentMethod?	PayrollEmployeeCompensationsTypePaymentMethod | null	The employee's compensation payment method. Is only Historical when retrieving external payrolls initially run outside of Gusto, then put into Gusto.
preferredFirstName?	string | null	The preferred first name of the employee. Requires employees:read scope.
reimbursements?	Reimbursements[]	An array of reimbursements for the employee.
version?	any	The current version of this employee compensation. This field is only available for prepared payrolls. See the versioning guide for information on how to use this field.

---

PayrollEmployeeCompensationsTypeAmountType

const PayrollEmployeeCompensationsTypeAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:160

How to interpret the amount.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollEmployeeCompensationsTypeAmountType

PayrollEmployeeCompensationsTypeAmountType = ClosedEnum<typeof PayrollEmployeeCompensationsTypeAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:160

How to interpret the amount.

---

PayrollEmployeeCompensationsTypeBreakdowns

PayrollEmployeeCompensationsTypeBreakdowns = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:59

PayrollEmployeeCompensationsTypeBreakdowns entity from the Gusto Embedded API.

Properties

Property	Type	Description
endDate?	RFCDate	The end date of the workweek.
hours?	string	The number of hours worked during this workweek.
startDate?	RFCDate	The start date of the workweek.

---

PayrollEmployeeCompensationsTypeCustomWithholdingsAmountType

const PayrollEmployeeCompensationsTypeCustomWithholdingsAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:205

How to interpret the amount.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollEmployeeCompensationsTypeCustomWithholdingsAmountType

PayrollEmployeeCompensationsTypeCustomWithholdingsAmountType = ClosedEnum<typeof PayrollEmployeeCompensationsTypeCustomWithholdingsAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:205

How to interpret the amount.

---

PayrollEmployeeCompensationsTypeOverrideType

const PayrollEmployeeCompensationsTypeOverrideType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:192

Override mode. Only one_time is currently exposed.

Type Declaration

Name	Type
OneTime	"one_time"

---

PayrollEmployeeCompensationsTypeOverrideType

PayrollEmployeeCompensationsTypeOverrideType = ClosedEnum<typeof PayrollEmployeeCompensationsTypeOverrideType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:192

Override mode. Only one_time is currently exposed.

---

PayrollEmployeeCompensationsTypePaidTimeOff

PayrollEmployeeCompensationsTypePaidTimeOff = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:108

PayrollEmployeeCompensationsTypePaidTimeOff entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string | null	The dollar amount paid for this PTO entry during the pay period (as a string-formatted decimal, e.g. "1234.56"). Only available for processed payrolls.
finalPayoutUnusedHoursInput?	string | null	The outstanding hours paid upon termination. This field is only applicable for termination payrolls.
hours?	string	The hours of this PTO taken during the pay period.
name?	string	The name of the PTO. This also serves as the unique, immutable identifier for the PTO.

---

PayrollEmployeeCompensationsTypePaymentMethod

const PayrollEmployeeCompensationsTypePaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:13

PayrollEmployeeCompensationsTypePaymentMethod entity from the Gusto Embedded API.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"
Historical	"Historical"

---

PayrollEmployeeCompensationsTypePaymentMethod

PayrollEmployeeCompensationsTypePaymentMethod = ClosedEnum<typeof PayrollEmployeeCompensationsTypePaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:13

PayrollEmployeeCompensationsTypePaymentMethod entity from the Gusto Embedded API.

---

PayrollFixedCompensationTypesType

PayrollFixedCompensationTypesType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollfixedcompensationtypestype.ts:10

PayrollFixedCompensationTypesType entity from the Gusto Embedded API.

Properties

Property	Type	Description
name?	string	The name of an available type of fixed compensation.

---

PayrollPaymentSpeedChangedType

PayrollPaymentSpeedChangedType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollpaymentspeedchangedtype.ts:14

Only applicable when a payroll is moved to four day processing instead of fast ach.

Properties

Property	Type	Description
currentCheckDate?	string	Current check date.
currentDebitDate?	string	Current debit date.
originalCheckDate?	string	Original check date when fast ach applies.
originalDebitDate?	string	Original debit date when fast ach applies.
reason?	string	The reason why the payroll is moved to four day.

---

PayrollPayPeriodType

PayrollPayPeriodType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollpayperiodtype.ts:11

PayrollPayPeriodType entity from the Gusto Embedded API.

Properties

Property	Type	Description
endDate?	string	The start date, inclusive, of the pay period.
payScheduleUuid?	string | null	The UUID of the pay schedule for the payroll.
startDate?	string	The start date, inclusive, of the pay period.

---

PayrollPayrollStatusMetaType

PayrollPayrollStatusMetaType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollpayrollstatusmetatype.ts:14

Information about the payroll's status and expected dates

Properties

Property	Type	Description
cancellable?	boolean	true if the payroll may be cancelled.
expectedCheckDate?	string	The date an employee will be paid if the payroll is submitted now.
expectedDebitTime?	string	The time the employer's account will be debited if the payroll is submitted now.
initialCheckDate?	string | null	The normal check date for the associated pay period. Returns null for off-cycle payrolls (not meaningful for off-cycle).
initialDebitCutoffTime?	string	Payroll must be submitted at or before this time to avoid late payroll.
payrollLate?	boolean | null	expected_check_date > initial_check_date. Returns null for off-cycle payrolls (not meaningful for off-cycle).

---

PayrollPrepared

PayrollPrepared = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:608

The response from preparing a payroll for update. Contains refreshed employee compensations, updated payroll dates, and version information needed for subsequent payroll updates.

Properties

Property	Type	Description
autoPayroll?	boolean	Indicates whether the payroll has automatic payroll enabled
calculatedAt?	Date | null	A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.
checkDate?	string	The date on which employees will be paid for the payroll.
companyUuid?	string	The UUID of the company for the payroll.
createdAt?	Date	Datetime for when the resource was created.
employeeCompensations?	PayrollEmployeeCompensationsType[]	-
external?	boolean	Indicates whether the payroll is an external payroll
finalTerminationPayroll?	boolean	Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
fixedCompensationTypes?	PayrollFixedCompensationTypesType[]	-
fixedWithholdingRate?	boolean | null	Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.
offCycle?	boolean	Indicates whether the payroll is an off-cycle payroll
offCycleReason?	OffCycleReasonType | null	The off-cycle reason. Only included for off-cycle payrolls.
partnerOwnedDisbursement?	boolean | null	Will money movement for the payroll be performed by the partner rather than by Gusto?
paymentSpeedChanged?	PayrollPaymentSpeedChangedType	Only applicable when a payroll is moved to four day processing instead of fast ach.
payPeriod?	PayrollPayPeriodType	-
payrollDeadline?	Date	A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.
payrollStatusMeta?	PayrollPayrollStatusMetaType	Information about the payroll's status and expected dates
payrollUuid?	string	The UUID of the payroll.
processed?	boolean	Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.
processedDate?	string | null	The date at which the payroll was processed. Null if the payroll isn't processed yet.
processingRequest?	PayrollProcessingRequest | null	-
skipRegularDeductions?	boolean | null	Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.
uuid?	string	The UUID of the payroll.
withholdingPayPeriod?	PayrollWithholdingPayPeriodType | null	The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.
workweeks?	Workweeks[] | null	The workweeks overlapping this payroll's pay period, one entry per workweek. Remarks Null when workweek boundaries can't be determined for this payroll (e.g. some off-cycle payrolls without a defined payment period).

---

PayrollProcessingRequest

PayrollProcessingRequest = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollprocessingrequest.ts:32

PayrollProcessingRequest entity from the Gusto Embedded API.

Properties

Property	Type	Description
errors?	EntityErrorObject[]	Errors that occurred during async payroll processing
status?	PayrollProcessingRequestStatus	The status of the payroll processing request

---

PayrollProcessingRequestStatus

const PayrollProcessingRequestStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollprocessingrequest.ts:18

The status of the payroll processing request

Type Declaration

Name	Type
CalculateSuccess	"calculate_success"
Calculating	"calculating"
ProcessingFailed	"processing_failed"
SubmitSuccess	"submit_success"
Submitting	"submitting"

---

PayrollProcessingRequestStatus

PayrollProcessingRequestStatus = ClosedEnum<typeof PayrollProcessingRequestStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollprocessingrequest.ts:18

The status of the payroll processing request

---

PayrollReceipt

PayrollReceipt = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:132

PayrollReceipt entity from the Gusto Embedded API.

Properties

Property	Type	Description
companyUuid?	string	A unique identifier of the company for the payroll.
debitDate?	string	The debit or funding date for the payroll
employeeCompensations?	PayrollReceiptEmployeeCompensations[]	An array of employee compensations and withholdings for this payroll
liabilityOfLicensee?	string	-
license?	string	Always the fixed string "ZenPayroll, Inc., dba Gusto is a licensed money transmitter. For more about Gusto’s licenses and your state-specific rights to request information, submit complaints, dispute errors, or cancel transactions, visit our license page."
licensee?	PayrollReceiptLicensee	The licensed payroll processor
licenseUri?	string	URL for the license information for the licensed payroll processor. Always the fixed string "https://gusto.com/about/licenses"
nameOfRecipient?	string	Always the fixed string "Payroll Recipients"
nameOfSender?	string	The name of the company by whom the payroll was paid
payrollUuid?	string	A unique identifier of the payroll receipt.
recipientNotice?	string	Always the fixed string "Payroll recipients include the employees listed below plus the tax agencies for the taxes listed below."
rightToRefund?	string	-
taxes?	Taxes[]	An array of totaled employer and employee taxes for the pay period.
totals?	PayrollReceiptTotals	The subtotals for the payroll.

---

PayrollReceiptEmployeeCompensations

PayrollReceiptEmployeeCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:63

PayrollReceiptEmployeeCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
childSupportGarnishment?	string	The total child support garnishment for the pay period.
employeeFirstName?	string	The first name of the employee.
employeeLastName?	string	The last name of the employee.
employeeUuid?	string	The UUID of the employee.
netPay?	string	The employee's net pay. Net pay paid by check is available for reference but is not included in the ["totals"]["net_pay_debit"] amount.
paymentMethod?	PayrollReceiptPaymentMethod	The employee's compensation payment method.
totalGarnishments?	string	The total garnishments for the pay period.
totalReimbursement?	string	The total reimbursement for the pay period.
totalTax?	string	The total of employer and employee taxes for the pay period.

---

PayrollReceiptLicensee

PayrollReceiptLicensee = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:105

The licensed payroll processor

Properties

Property	Type	Description
address?	string	Always the fixed string "525 20th St"
city?	string	Always the fixed string "San Francisco"
name?	string	Always the fixed string "Gusto, Zenpayroll Inc."
phoneNumber?	string	Always the fixed string "4157778888"
postalCode?	string	Always the fixed string "94107"
state?	string	Always the fixed string "CA"

---

PayrollReceiptPaymentMethod

const PayrollReceiptPaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:52

The employee's compensation payment method.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"

---

PayrollReceiptPaymentMethod

PayrollReceiptPaymentMethod = ClosedEnum<typeof PayrollReceiptPaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:52

The employee's compensation payment method.

---

PayrollReceiptTotals

PayrollReceiptTotals = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:15

The subtotals for the payroll.

Properties

Property	Type	Description
childSupportDebit?	string	The total child support debit for the payroll.
companyDebit?	string	The total company debit for the payroll.
netPayDebit?	string	The total company net pay for the payroll.
reimbursementDebit?	string	The total reimbursements for the payroll.
taxDebit?	string	The total tax debit for the payroll.

---

PayrollShow

PayrollShow = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:488

PayrollShow entity from the Gusto Embedded API.

Properties

Property	Type	Description
autoPayroll?	boolean	Indicates whether the payroll has automatic payroll enabled
calculatedAt?	Date | null	A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.
checkDate?	string	The date on which employees will be paid for the payroll.
companyTaxes?	PayrollCompanyTaxesType[]	An array of taxes applicable to this payroll in addition to taxes included in employee_compensations. Only included for processed or calculated payrolls when taxes is present in the include parameter.
companyUuid?	string	The UUID of the company for the payroll.
createdAt?	Date	Datetime for when the resource was created.
creditBlockers?	PayrollCreditBlockerType[]	Only included for processed payrolls
employeeCompensations?	EmployeeCompensations[]	-
external?	boolean	Indicates whether the payroll is an external payroll
finalTerminationPayroll?	boolean	Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
fixedWithholdingRate?	boolean | null	Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.
offCycle?	boolean	Indicates whether the payroll is an off-cycle payroll
offCycleReason?	OffCycleReasonType | null	The off-cycle reason. Only included for off-cycle payrolls.
partnerOwnedDisbursement?	boolean | null	Will money movement for the payroll be performed by the partner rather than by Gusto?
paymentSpeedChanged?	PayrollPaymentSpeedChangedType	Only applicable when a payroll is moved to four day processing instead of fast ach.
payPeriod?	PayrollPayPeriodType	-
payrollDeadline?	Date	A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.
payrollStatusMeta?	PayrollPayrollStatusMetaType	Information about the payroll's status and expected dates
payrollTaxes?	PayrollTaxesType[]	An array of tax totals applicable to this payroll. Only included for processed or calculated payrolls when payroll_taxes is present in the include parameter.
payrollUuid?	string	The UUID of the payroll.
processed?	boolean	Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.
processedDate?	string | null	The date at which the payroll was processed. Null if the payroll isn't processed yet.
processingRequest?	PayrollProcessingRequest | null	-
skipRegularDeductions?	boolean | null	Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.
submissionBlockers?	PayrollSubmissionBlockerType[]	Only included for processed or calculated payrolls
totals?	PayrollTotalsType	The subtotals for the payroll.
uuid?	string	The UUID of the payroll.
withholdingPayPeriod?	PayrollWithholdingPayPeriodType | null	The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.

---

PayrollShowAmountType

const PayrollShowAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:340

The amount type of the deduction for the pay period. Only present for unprocessed payrolls.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollShowAmountType

PayrollShowAmountType = ClosedEnum<typeof PayrollShowAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:340

The amount type of the deduction for the pay period. Only present for unprocessed payrolls.

---

PayrollShowBenefits

PayrollShowBenefits = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:378

PayrollShowBenefits entity from the Gusto Embedded API.

Properties

Property	Type
companyContribution?	string
employeeDeduction?	string
imputed?	boolean
name?	string

---

PayrollShowBreakdowns

PayrollShowBreakdowns = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:138

PayrollShowBreakdowns entity from the Gusto Embedded API.

Properties

Property	Type	Description
endDate?	RFCDate	The end date of the workweek.
hours?	string	The number of hours worked during this workweek.
startDate?	RFCDate	The start date of the workweek.

---

PayrollShowCustomWithholdings

PayrollShowCustomWithholdings = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:326

The one-time custom withholding overrides applied to this payroll for this employee.

Remarks

federal is null when no federal one-time override is set; state is an empty array when no state one-time overrides are set.

Properties

Property	Type	Description
federal?	PayrollShowFederal | null	Federal one-time custom withholding override applied to this payroll.
state?	PayrollShowState[]	State one-time custom withholding overrides applied to this payroll, one entry per state field.

---

PayrollShowDeductions

PayrollShowDeductions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:349

PayrollShowDeductions entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount of the deduction for the pay period.
amountType?	PayrollShowAmountType	The amount type of the deduction for the pay period. Only present for unprocessed payrolls.
name?	string	The name of the deduction.
updatableViaPayroll?	boolean	Whether the deduction can be updated via the payroll update endpoint. Only present for unprocessed payrolls.
uuid?	string	The UUID of the deduction. Only present for unprocessed payrolls.

---

PayrollShowEmployeeCompensationsAmountType

const PayrollShowEmployeeCompensationsAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:241

How to interpret the amount.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollShowEmployeeCompensationsAmountType

PayrollShowEmployeeCompensationsAmountType = ClosedEnum<typeof PayrollShowEmployeeCompensationsAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:241

How to interpret the amount.

---

PayrollShowEmployeeCompensationsBreakdowns

PayrollShowEmployeeCompensationsBreakdowns = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:101

PayrollShowEmployeeCompensationsBreakdowns entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The dollar amount for this workweek.
endDate?	RFCDate	The end date of the workweek.
startDate?	RFCDate	The start date of the workweek.

---

PayrollShowEmployeeCompensationsCustomWithholdingsAmountType

const PayrollShowEmployeeCompensationsCustomWithholdingsAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:286

How to interpret the amount.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollShowEmployeeCompensationsCustomWithholdingsAmountType

PayrollShowEmployeeCompensationsCustomWithholdingsAmountType = ClosedEnum<typeof PayrollShowEmployeeCompensationsCustomWithholdingsAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:286

How to interpret the amount.

---

PayrollShowEmployeeCompensationsOverrideType

const PayrollShowEmployeeCompensationsOverrideType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:228

Override mode. Only one_time is currently exposed.

Type Declaration

Name	Type
OneTime	"one_time"

---

PayrollShowEmployeeCompensationsOverrideType

PayrollShowEmployeeCompensationsOverrideType = ClosedEnum<typeof PayrollShowEmployeeCompensationsOverrideType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:228

Override mode. Only one_time is currently exposed.

---

PayrollShowFederal

PayrollShowFederal = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:255

Federal one-time custom withholding override applied to this payroll.

Properties

Property	Type	Description
amount?	string	The amount that was withheld for this payroll.
amountType?	PayrollShowEmployeeCompensationsAmountType	How to interpret the amount.
overrideType?	PayrollShowEmployeeCompensationsOverrideType	Override mode. Only one_time is currently exposed.

---

PayrollShowFixedCompensations

PayrollShowFixedCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:116

PayrollShowFixedCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount of the compensation for the pay period.
breakdowns?	PayrollShowEmployeeCompensationsBreakdowns[]	Per-workweek amounts for this compensation, one entry per workweek Remarks overlapping the pay period.
jobUuid?	string	The UUID of the job for the compensation.
name?	string	The name of the compensation. This also serves as the unique, immutable identifier for this compensation.

---

PayrollShowHourlyCompensations

PayrollShowHourlyCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:153

PayrollShowHourlyCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount of the compensation. This field is only available after the payroll is calculated and cannot be used for updating hourly compensations.
breakdowns?	PayrollShowBreakdowns[]	Per-workweek hours for this compensation, one entry per workweek Remarks overlapping the pay period.
compensationMultiplier?	number	The amount multiplied by the base rate to calculate total compensation per hour worked.
flsaStatus?	string	The FLSA Status of the employee's primary job compensation
hours?	string	The number of hours to be compensated for this pay period.
jobUuid?	string	The UUID of the job for the compensation.
name?	string	The name of the compensation. This also serves as the unique, immutable identifier for this compensation.

---

PayrollShowOverrideType

const PayrollShowOverrideType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:273

Override mode. Only one_time is currently exposed.

Type Declaration

Name	Type
OneTime	"one_time"

---

PayrollShowOverrideType

PayrollShowOverrideType = ClosedEnum<typeof PayrollShowOverrideType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:273

Override mode. Only one_time is currently exposed.

---

PayrollShowPaidTimeOff

PayrollShowPaidTimeOff = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:187

PayrollShowPaidTimeOff entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string | null	The dollar amount paid for this PTO entry during the pay period (as a string-formatted decimal, e.g. "1234.56"). Only available for processed payrolls.
finalPayoutUnusedHoursInput?	string | null	The outstanding hours paid upon termination. This field is only applicable for termination payrolls.
hours?	string	The hours of this PTO taken during the pay period.
name?	string	The name of the PTO. This also serves as the unique, immutable identifier for the PTO.

---

PayrollShowPaymentMethod

const PayrollShowPaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:92

PayrollShowPaymentMethod entity from the Gusto Embedded API.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"
Historical	"Historical"

---

PayrollShowPaymentMethod

PayrollShowPaymentMethod = ClosedEnum<typeof PayrollShowPaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:92

PayrollShowPaymentMethod entity from the Gusto Embedded API.

---

PayrollShowReimbursements

PayrollShowReimbursements = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:206

PayrollShowReimbursements entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount	string	The dollar amount of the reimbursement for the pay period.
description	string | null	The description of the reimbursement. Null for unnamed reimbursements.
recurring?	boolean	Whether the reimbursement is recurring. This field is only available for unprocessed payrolls.
uuid?	string | null	The UUID of the reimbursement. Null for unnamed reimbursements. This field is only available for unprocessed payrolls.

---

PayrollShowState

PayrollShowState = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:298

PayrollShowState entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount that was withheld for this payroll.
amountType?	PayrollShowEmployeeCompensationsCustomWithholdingsAmountType	How to interpret the amount.
employeeStateFieldUuid?	string	The UUID of the EmployeeStateField this withholding applies to.
overrideType?	PayrollShowOverrideType	Override mode. Only one_time is currently exposed.

---

PayrollShowTaxes

PayrollShowTaxes = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:372

PayrollShowTaxes entity from the Gusto Embedded API.

Properties

Property	Type
amount	string
employer	boolean
name	string

---

PayrollSubmissionBlockerType

PayrollSubmissionBlockerType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollsubmissionblockertype.ts:44

A blocker that prevents payment submission.

Properties

Property	Type	Description
blockerName?	string	The name of the submission blocker.
blockerType?	string	The type of blocker that's blocking the payment submission.
selectedOption?	string | null	The unblock option that's been selected to resolve the submission blocker.
status?	PayrollSubmissionBlockerTypeStatus	The status of the submission blocker.
unblockOptions?	UnblockOptions[]	The available options to unblock a submission blocker.

---

PayrollSubmissionBlockerTypeStatus

const PayrollSubmissionBlockerTypeStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollsubmissionblockertype.ts:30

The status of the submission blocker.

Type Declaration

Name	Type
Resolved	"resolved"
Unresolved	"unresolved"

---

PayrollSubmissionBlockerTypeStatus

PayrollSubmissionBlockerTypeStatus = ClosedEnum<typeof PayrollSubmissionBlockerTypeStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollsubmissionblockertype.ts:30

The status of the submission blocker.

---

PayrollTaxesType

PayrollTaxesType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrolltaxestype.ts:10

PayrollTaxesType entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	number	The total tax for the payroll
employer?	boolean	Whether this tax is an employer or employee tax
name?	string	The tax name

---

PayrollTotalsType

PayrollTotalsType = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrolltotalstype.ts:14

The subtotals for the payroll.

Properties

Property	Type	Description
additionalEarnings?	string	The total additional earnings amount for the payroll.
benefits?	string	The total amount of company contributed benefits for the payroll.
checkAmount?	string	The total check amount for the payroll.
childSupportDebit?	string	The total child support debit for the payroll.
companyDebit?	string	The total company debit for the payroll.
deferredPayrollTaxes?	string	The total amount of payroll taxes deferred for the payroll, such as allowed by the CARES act.
employeeBenefitsDeductions?	string	The total amount of employee deducted benefits for the payroll.
employeeBonuses?	string	The total employee bonuses amount for the payroll.
employeeCashTips?	string	The total employee cash tips amount for the payroll.
employeeCommissions?	string	The total employee commissions amount for the payroll.
employeePaycheckTips?	string	The total employee paycheck tips amount for the payroll.
employeeTaxes?	string	The total amount of employee paid taxes for the payroll.
employerTaxes?	string	The total amount of employer paid taxes for the payroll.
grossPay?	string	The gross pay amount for the payroll.
imputedPay?	string	The total amount of imputed pay for the payroll.
netPay?	string	The net pay amount for the payroll.
netPayDebit?	string	The total company net pay for the payroll.
otherDeductions?	string	The total amount of deductions for the payroll.
ownersDraw?	string	The total owner's draw for the payroll.
reimbursementDebit?	string	The total reimbursement debit for the payroll.
reimbursements?	string	The total reimbursements for the payroll.
taxDebit?	string	The total tax debit for the payroll.

---

PayrollType

const PayrollType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payperiod.ts:15

Whether it is regular pay period or transition pay period.

Type Declaration

Name	Type
Regular	"regular"
Transition	"transition"

---

PayrollType

PayrollType = ClosedEnum<typeof PayrollType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payperiod.ts:15

Whether it is regular pay period or transition pay period.

---

PayrollUpdateAmountType

const PayrollUpdateAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:112

The amount type of the deduction for the pay period.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollUpdateAmountType

PayrollUpdateAmountType = ClosedEnum<typeof PayrollUpdateAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:112

The amount type of the deduction for the pay period.

---

PayrollUpdateBreakdowns

PayrollUpdateBreakdowns = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:24

PayrollUpdateBreakdowns entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The dollar amount for this workweek.
endDate?	RFCDate	The end date of the workweek.
startDate?	RFCDate	The start date of the workweek.

---

PayrollUpdateCustomWithholdings

PayrollUpdateCustomWithholdings = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:246

Optional per-payroll one-time custom withholdings for federal and/or state income tax.

Remarks

When provided, the supplied override takes precedence over any persistent withholding schedule for this run. This field is in limited release; if your application does not have access, requests including it are silently ignored.

Properties

Property	Type	Description
federal?	PayrollUpdateFederal	Federal one-time custom withholding override.
state?	PayrollUpdateState[]	State one-time custom withholding overrides, one entry per state field.

---

PayrollUpdateDeductions

PayrollUpdateDeductions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:126

An array of deductions for the employee.

Properties

Property	Type	Description
amount?	number	The amount of the deduction for the pay period.
amountType?	PayrollUpdateAmountType	The amount type of the deduction for the pay period.
name?	string	The name of the deduction.
uuid?	string	The UUID of the deduction. This parameter is optional and can be provided in order to update an existing deduction.

---

PayrollUpdateEmployeeCompensations

PayrollUpdateEmployeeCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:291

PayrollUpdateEmployeeCompensations entity from the Gusto Embedded API.

Properties

Property	Type	Description
customWithholdings?	PayrollUpdateCustomWithholdings	Optional per-payroll one-time custom withholdings for federal and/or state income tax. Remarks When provided, the supplied override takes precedence over any persistent withholding schedule for this run. This field is in limited release; if your application does not have access, requests including it are silently ignored.
deductions?	PayrollUpdateDeductions[]	-
employeeUuid?	string	The UUID of the employee.
excluded?	boolean	This employee will be excluded from payroll calculation and will not be paid for the payroll.
fixedCompensations?	PayrollUpdateFixedCompensations[]	-
hourlyCompensations?	PayrollUpdateHourlyCompensations[]	-
memo?	string	Custom text that will be printed as a personal note to the employee on a paystub.
paidTimeOff?	PayrollUpdatePaidTimeOff[]	An array of all paid time off the employee is eligible for this pay period. Each paid time off object can be the name or the specific policy_uuid.
paymentMethod?	PayrollUpdatePaymentMethod	The employee's compensation payment method. Invalid values will be ignored.
reimbursements?	PayrollUpdateReimbursements[]	An array of reimbursements for the employee.
version?	string	The current version of this employee compensation from the prepared payroll. See the versioning guide for information on how to use this field.

---

PayrollUpdateEmployeeCompensationsAmountType

const PayrollUpdateEmployeeCompensationsAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:161

How to interpret the amount.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollUpdateEmployeeCompensationsAmountType

PayrollUpdateEmployeeCompensationsAmountType = ClosedEnum<typeof PayrollUpdateEmployeeCompensationsAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:161

How to interpret the amount.

---

PayrollUpdateEmployeeCompensationsBreakdowns

PayrollUpdateEmployeeCompensationsBreakdowns = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:66

PayrollUpdateEmployeeCompensationsBreakdowns entity from the Gusto Embedded API.

Properties

Property	Type	Description
endDate?	RFCDate	The end date of the workweek.
hours?	string	The number of hours worked during this workweek.
startDate?	RFCDate	The start date of the workweek.

---

PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType

const PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:206

How to interpret the amount.

Type Declaration

Name	Type
Fixed	"fixed"
Percent	"percent"

---

PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType

PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType = ClosedEnum<typeof PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:206

How to interpret the amount.

---

PayrollUpdateEmployeeCompensationsOverrideType

const PayrollUpdateEmployeeCompensationsOverrideType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:193

Override mode. Only one_time is currently supported.

Type Declaration

Name	Type
OneTime	"one_time"

---

PayrollUpdateEmployeeCompensationsOverrideType

PayrollUpdateEmployeeCompensationsOverrideType = ClosedEnum<typeof PayrollUpdateEmployeeCompensationsOverrideType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:193

Override mode. Only one_time is currently supported.

---

PayrollUpdateFederal

PayrollUpdateFederal = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:175

Federal one-time custom withholding override.

Properties

Property	Type	Description
amount?	string	The amount to be withheld for this payroll.
amountType?	PayrollUpdateEmployeeCompensationsAmountType	How to interpret the amount.
overrideType?	PayrollUpdateOverrideType	Override mode. Only one_time is currently supported.

---

PayrollUpdateFixedCompensations

PayrollUpdateFixedCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:42

An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements.

Properties

Property	Type	Description
amount?	string	The amount of the compensation for the pay period.
breakdowns?	PayrollUpdateBreakdowns[]	Per-workweek amounts to record for this compensation. Not Remarks applicable to reimbursements. Submitted breakdowns must tile the pay period's workweeks exactly (no gaps or overlaps), and their amounts must sum to the compensation's total amount.
jobUuid?	string	The UUID of the job for the compensation.
name?	string	The name of the compensation. This also serves as the unique, immutable identifier for this compensation.

---

PayrollUpdateHourlyCompensations

PayrollUpdateHourlyCompensations = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:84

An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours.

Properties

Property	Type	Description
breakdowns?	PayrollUpdateEmployeeCompensationsBreakdowns[]	Per-workweek hours to record for this compensation. Submitted Remarks breakdowns must tile the pay period's workweeks exactly (no gaps or overlaps). Either every hourly compensation for a job must include breakdowns, or none of them may. Hours must sum to the compensation's total hours.
hours?	string	The number of hours to be compensated for this pay period.
jobUuid?	string	The UUIDs of the job for the compensation.
name?	string	The name of the compensation. This also serves as the unique, immutable identifier for this compensation.

---

PayrollUpdateOverrideType

const PayrollUpdateOverrideType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:148

Override mode. Only one_time is currently supported.

Type Declaration

Name	Type
OneTime	"one_time"

---

PayrollUpdateOverrideType

PayrollUpdateOverrideType = ClosedEnum<typeof PayrollUpdateOverrideType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:148

Override mode. Only one_time is currently supported.

---

PayrollUpdatePaidTimeOff

PayrollUpdatePaidTimeOff = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:257

PayrollUpdatePaidTimeOff entity from the Gusto Embedded API.

Properties

Property	Type	Description
finalPayoutUnusedHoursInput?	string | null	The outstanding hours paid upon termination. This field is only applicable for termination payrolls.
hours?	string	The hours of this PTO taken during the pay period.
name?	string	The name of the PTO. This also serves as the unique, immutable identifier for the PTO. Must pass in name or policy_uuid but not both.
policyUuid?	string	The uuid of the PTO policy. Must pass in name or policy_uuid but not both.

---

PayrollUpdatePaymentMethod

const PayrollUpdatePaymentMethod: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:13

The employee's compensation payment method. Invalid values will be ignored.

Type Declaration

Name	Type
Check	"Check"
DirectDeposit	"Direct Deposit"

---

PayrollUpdatePaymentMethod

PayrollUpdatePaymentMethod = ClosedEnum<typeof PayrollUpdatePaymentMethod>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:13

The employee's compensation payment method. Invalid values will be ignored.

---

PayrollUpdateReimbursements

PayrollUpdateReimbursements = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:276

PayrollUpdateReimbursements entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The dollar amount of the reimbursement for the pay period.
description?	string	The description of the reimbursement. If not provided, the reimbursement will be unnamed.
uuid?	string	The UUID of an existing reimbursement. This parameter is optional and can be provided in order to update an existing reimbursement.

---

PayrollUpdateState

PayrollUpdateState = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollupdate.ts:218

PayrollUpdateState entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount to be withheld for this payroll.
amountType?	PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType	How to interpret the amount.
employeeStateFieldUuid?	string	The UUID of the EmployeeStateField this withholding applies to.
overrideType?	PayrollUpdateEmployeeCompensationsOverrideType	Override mode. Only one_time is currently supported.

---

PayrollWithholdingPayPeriodType

const PayrollWithholdingPayPeriodType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:79

PayrollWithholdingPayPeriodType entity from the Gusto Embedded API.

Type Declaration

Name	Type
Annually	"Annually"
EveryOtherWeek	"Every other week"
EveryWeek	"Every week"
Monthly	"Monthly"
Quarterly	"Quarterly"
Semiannually	"Semiannually"
TwicePerMonth	"Twice per month"

---

PayrollWithholdingPayPeriodType

PayrollWithholdingPayPeriodType = ClosedEnum<typeof PayrollWithholdingPayPeriodType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:79

PayrollWithholdingPayPeriodType entity from the Gusto Embedded API.

---

PayScheduleAutoPayrollEnablementBlocker

PayScheduleAutoPayrollEnablementBlocker = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payscheduleautopayrollenablementblocker.ts:18

A single blocker preventing Autopayroll enablement.

Properties

Property	Type	Description
key?	string	The blocker type. Possible values: employees_not_on_direct_deposit, employees_not_salaried, missing_state_tax_requirements, missing_funding_method, one_day_ach_speed_not_supported, company_suspended, earned_fast_ach_not_met, hourly_employees_missing_default_hours.
metadata?	PayScheduleAutoPayrollEnablementBlockerMetadata	Blocker-specific metadata (e.g. employee_uuids, states).

---

PayScheduleAutoPayrollEnablementBlockerMetadata

PayScheduleAutoPayrollEnablementBlockerMetadata = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payscheduleautopayrollenablementblocker.ts:13

Blocker-specific metadata (e.g. employee_uuids, states).

---

PayScheduleFrequency

const PayScheduleFrequency: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payschedulefrequency.ts:22

The frequency that employees on this pay schedule are paid with Gusto.

Remarks

READ-ONLY in responses. Possible values:

• Every week: Employees are paid weekly.
• Every other week: Employees are paid bi-weekly (every two weeks).
• Twice per month: Employees are paid on two fixed days each month (e.g. 1st and 15th); use day_1 and day_2.
• Monthly: Employees are paid once per month; use day_1 for the pay day.
• Quarterly: Employees are paid every three months.
• Annually: Employees are paid once per year.

Type Declaration

Name	Type
Annually	"Annually"
EveryOtherWeek	"Every other week"
EveryWeek	"Every week"
Monthly	"Monthly"
Quarterly	"Quarterly"
TwicePerMonth	"Twice per month"

---

PayScheduleFrequency

PayScheduleFrequency = ClosedEnum<typeof PayScheduleFrequency>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payschedulefrequency.ts:22

The frequency that employees on this pay schedule are paid with Gusto.

Remarks

READ-ONLY in responses. Possible values:

• Every week: Employees are paid weekly.
• Every other week: Employees are paid bi-weekly (every two weeks).
• Twice per month: Employees are paid on two fixed days each month (e.g. 1st and 15th); use day_1 and day_2.
• Monthly: Employees are paid once per month; use day_1 for the pay day.
• Quarterly: Employees are paid every three months.
• Annually: Employees are paid once per year.

---

PaySchedulePreviewPayPeriod

PaySchedulePreviewPayPeriod = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payschedulepreviewpayperiod.ts:15

A single pay period in a pay schedule preview, with check date, period boundaries, and payroll deadline.

Properties

Property	Type	Description
checkDate	RFCDate	The payment date, "Check date", for the pay period.
endDate	RFCDate	The last day of the pay period.
runPayrollBy	RFCDate	The deadline to run payroll for direct deposit on the check date.
startDate	RFCDate	The first day of the pay period.

---

PayScheduleShow

PayScheduleShow = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payscheduleshow.ts:41

Pay schedule returned from pay schedule endpoints (GET by ID, POST create, PUT update). Same fields as Pay-Schedule with a required version for optimistic concurrency.

Remarks

For API version 2025-11-15 and later, responses use auto_payroll; earlier versions use auto_pilot for the same semantic.

Properties

Property	Type	Description
uuid	string	The unique identifier of the pay schedule in Gusto.
version	string	The current version of the pay schedule. See the versioning guide for information on how to use this field for optimistic concurrency.
active?	boolean	Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned.
anchorEndOfPayPeriod?	RFCDate	The last date of the first pay period. This can be the same date as the anchor pay date (ISO 8601 YYYY-MM-DD).
anchorPayDate?	RFCDate	The first date that employees on this pay schedule are paid with Gusto (ISO 8601 YYYY-MM-DD).
autoPayroll?	boolean	With automatic payroll enabled, payroll runs automatically one day before payroll deadlines. When false, payroll does not run automatically. Remarks Returned for API version 2025-11-15 and later; for earlier versions the response uses auto_pilot instead.
autoPayrollEnablementBlockers?	PayScheduleAutoPayrollEnablementBlocker[] | null	List of blockers preventing automatic payroll from being enabled. If automatic payroll is already enabled, this field is null.
customName?	string	A custom name for a pay schedule; defaults to the pay frequency description when none was set by the partner. Remarks When the partner never set a custom name (or cleared it), this field contains the auto-generated description derived from frequency and pay days (e.g. "every 1st and 15th of the month", "every Friday"). When the partner set a custom name on create or update, this field contains that value.
day1?	number | null	An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the "Twice per month" and "Monthly" frequencies. It will be null for pay schedules with other frequencies. Remarks
day2?	number | null	An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the "Twice per month" frequency. For semi-monthly pay schedules, this field should be set to 31. For months shorter than 31 days, the second pay date is set to the last day of the month. It will be null for pay schedules with other frequencies. Remarks
frequency?	PayScheduleFrequency	The frequency that employees on this pay schedule are paid with Gusto. Remarks READ-ONLY in responses. Possible values: - Every week: Employees are paid weekly. - Every other week: Employees are paid bi-weekly (every two weeks). - Twice per month: Employees are paid on two fixed days each month (e.g. 1st and 15th); use day_1 and day_2. - Monthly: Employees are paid once per month; use day_1 for the pay day. - Quarterly: Employees are paid every three months. - Annually: Employees are paid once per year.
name?	string | null	This field will be hourly when the pay schedule is for hourly employees, salaried when the pay schedule is for salaried employees, the department name if pay schedule is by department, and null when the pay schedule is for all employees.
workweekStartDay?	PayScheduleWorkweekStartDay | null	The day of the week that this pay schedule's workweeks start on, used for regular rate of pay overtime calculations. Null when no workweek start day has been configured (e.g. legacy pay schedules). Remarks

---

PayScheduleWorkweekStartDay

const PayScheduleWorkweekStartDay: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payscheduleshow.ts:21

PayScheduleWorkweekStartDay entity from the Gusto Embedded API.

Type Declaration

Name	Type
Friday	"Friday"
Monday	"Monday"
Saturday	"Saturday"
Sunday	"Sunday"
Thursday	"Thursday"
Tuesday	"Tuesday"
Wednesday	"Wednesday"

---

PayScheduleWorkweekStartDay

PayScheduleWorkweekStartDay = ClosedEnum<typeof PayScheduleWorkweekStartDay>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payscheduleshow.ts:21

PayScheduleWorkweekStartDay entity from the Gusto Embedded API.

---

PlaidStatus

const PlaidStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:72

PlaidStatus entity from the Gusto Embedded API.

Type Declaration

Name	Type
Connected	"connected"
Disconnected	"disconnected"

---

PlaidStatus

PlaidStatus = ClosedEnum<typeof PlaidStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:72

PlaidStatus entity from the Gusto Embedded API.

---

PolicyType

const PolicyType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicy.ts:15

Type of the time off policy. Only "vacation" and "sick" can be created through the API, but other types may be present if the company was previously a Gusto.com customer.

Type Declaration

Name	Type
Bereavement	"bereavement"
Custom	"custom"
FloatingHoliday	"floating_holiday"
JuryDuty	"jury_duty"
LearningAndDevelopment	"learning_and_development"
ParentalLeave	"parental_leave"
PersonalDay	"personal_day"
Sick	"sick"
Vacation	"vacation"
Volunteer	"volunteer"
Weather	"weather"

---

PolicyType

PolicyType = ClosedEnum<typeof PolicyType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicy.ts:15

Type of the time off policy. Only "vacation" and "sick" can be created through the API, but other types may be present if the company was previously a Gusto.com customer.

---

PresidentsDay

PresidentsDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:23

PresidentsDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

PrintablePayrollChecksBody

PrintablePayrollChecksBody = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/printablepayrollchecksbody.ts:24

Request body for generating printable payroll checks.

Properties

Property	Type	Description
printingFormat	PrintingFormat	The type of check stock being printed. Check the "Types of check stock" section in this link for more info on check types
startingCheckNumber?	number	The starting check number we will start generating checks from. Use to override the sequence that will be used to generate check numbers.

---

PrintingFormat

const PrintingFormat: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/printablepayrollchecksbody.ts:12

The type of check stock being printed. Check the "Types of check stock" section in this link for more info on check types

Type Declaration

Name	Type
Bottom	"bottom"
Top	"top"

---

PrintingFormat

PrintingFormat = ClosedEnum<typeof PrintingFormat>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/printablepayrollchecksbody.ts:12

The type of check stock being printed. Check the "Types of check stock" section in this link for more info on check types

---

Questions

Questions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxesrequest.ts:16

Questions entity from the Gusto Embedded API.

Properties

Property	Type
key	string
answers?	Answers[]

---

RateType

const RateType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:79

[for workers_compensation_rate] The type of rate being collected. Either:

Remarks

• percent: A percentage formatted as a decimal, e.g. 0.01 for 1%
  • currency_per_hour: A dollar amount per hour, e.g. 3.24 for $3.24/hr

Type Declaration

Name	Type
CurrencyPerHour	"currency_per_hour"
Percent	"percent"

---

RateType

RateType = ClosedEnum<typeof RateType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:79

[for workers_compensation_rate] The type of rate being collected. Either:

Remarks

• percent: A percentage formatted as a decimal, e.g. 0.01 for 1%
  • currency_per_hour: A dollar amount per hour, e.g. 3.24 for $3.24/hr

---

RecoveryCase

RecoveryCase = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/recoverycase.ts:30

Representation of a recovery case

Properties

Property	Type	Description
uuid	string	Unique identifier of an recovery case
amountOutstanding?	string	Amount outstanding for the recovery case
checkDate?	string	Check date for the associated payroll or contractor payments
companyUuid?	string	Unique identifier of the company to which the recovery case belongs
contractorPaymentUuids?	string[] | null	The uuids of the associated contractor payments for which the recovery case was created. If the recovery case was created for a payroll, this field will be null.
eventTotalAmount?	string	Total amount to be debited from the payroll or contractor payments
latestErrorCode?	string | null	The latest bank error code for the recovery case. See this doc for a list of common ACH return codes.
originalDebitDate?	string | null	Date when funds were originally debited from the company's bank account
payrollUuid?	string | null	The uuid of the associated payroll for which the recovery case was created. If the recovery case was created for a contractor payment, this field will be null.
status?	RecoveryCaseStatus	Status of the recovery case

---

RecoveryCaseStatus

const RecoveryCaseStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/recoverycase.ts:15

Status of the recovery case

Type Declaration

Name	Type
Lost	"lost"
Open	"open"
Recovered	"recovered"
RedebitInitiated	"redebit_initiated"
WireInitiated	"wire_initiated"

---

RecoveryCaseStatus

RecoveryCaseStatus = ClosedEnum<typeof RecoveryCaseStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/recoverycase.ts:15

Status of the recovery case

---

Reimbursements

Reimbursements = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:127

Reimbursements entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount	string	The dollar amount of the reimbursement for the pay period.
description	string | null	The description of the reimbursement. Null for unnamed reimbursements.
recurring?	boolean	Whether the reimbursement is recurring. This field is only available for unprocessed payrolls.
uuid?	string | null	The UUID of the reimbursement. Null for unnamed reimbursements. This field is only available for unprocessed payrolls.

---

RequiredAttributes

RequiredAttributes = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/childsupportdata.ts:36

RequiredAttributes entity from the Gusto Embedded API.

Properties

Property	Type	Description
key?	ChildSupportDataKey	A required attribute when creating a garnishment for this state agency. The current values are listed as an enum; though unlikely, values could be added if state agency requirements change in the future.
label?	string	A human readable name of the attribute, e.g. CSE Case Number

---

RequiredQuestions

RequiredQuestions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:49

RequiredQuestions entity from the Gusto Embedded API.

Properties

Property	Type	Description
questionText	string	The text of the question
questionUuid	string	The UUID of the question
responseType	ResponseType	The type of response to the question

---

ResponseType

const ResponseType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:38

The type of response to the question

Type Declaration

Name	Type
Document	"document"
Persona	"persona"
RadioButton	"radio_button"
Text	"text"

---

ResponseType

ResponseType = ClosedEnum<typeof ResponseType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/informationrequest.ts:38

The type of response to the question

---

SetupStatus

const SetupStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementstateslist.ts:20

The current status of the state tax setup.

Remarks

• not_started: No requirements have been filled
• in_progress: Some requirements have been filled, or default rates are applied
• complete: All requirements have been filled without default rates

Type Declaration

Name	Type
Complete	"complete"
InProgress	"in_progress"
NotStarted	"not_started"

---

SetupStatus

SetupStatus = ClosedEnum<typeof SetupStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementstateslist.ts:20

The current status of the state tax setup.

Remarks

• not_started: No requirements have been filled
• in_progress: Some requirements have been filled, or default rates are applied
• complete: All requirements have been filled without default rates

---

Signatory

Signatory = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/signatory.ts:33

The representation of a company's signatory

Properties

Property	Type	Description
uuid	string	-
birthday?	string | null	-
email?	string	-
firstName?	string | null	-
hasSsn?	boolean	Indicates whether the signatory has an SSN in Gusto.
homeAddress?	SignatoryHomeAddress | null	-
identityVerificationStatus?	IdentityVerificationStatus | null
isAdmin?	boolean	Whether or not the signatory is also the payroll admin of the company.
lastName?	string | null	-
phone?	string | null	-
title?	string | null	-
version?	string	The current version of the signatory. See the versioning guide for information on how to use this field.

---

SignatoryHomeAddress

SignatoryHomeAddress = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/signatory.ts:21

SignatoryHomeAddress entity from the Gusto Embedded API.

Properties

Property	Type
country	string
city?	string
state?	string
street1?	string
street2?	string
zip?	string

---

State

State = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollemployeecompensationstype.ts:217

State entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The amount that was withheld for this payroll.
amountType?	PayrollEmployeeCompensationsTypeCustomWithholdingsAmountType	How to interpret the amount.
employeeStateFieldUuid?	string	The UUID of the EmployeeStateField this withholding applies to.
overrideType?	PayrollEmployeeCompensationsTypeOverrideType	Override mode. Only one_time is currently exposed.

---

States

States = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/employeestatetaxesrequest.ts:21

States entity from the Gusto Embedded API.

Properties

Property	Type
state	string
questions?	Questions[]

---

Taxes

Taxes = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollreceipt.ts:38

Taxes entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The total amount paid by both employer and employee for this tax.
name?	string	The amount paid for this tax.

---

TaxPayerType

const TaxPayerType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:12

TaxPayerType entity from the Gusto Embedded API.

Type Declaration

Name	Type
Association	"Association"
CCorporation	"C-Corporation"
CoOwnership	"Co-ownership"
GeneralPartnership	"General partnership"
JointVenture	"Joint venture"
LimitedPartnership	"Limited partnership"
Llc	"LLC"
Llp	"LLP"
NonProfit	"Non-Profit"
SCorporation	"S-Corporation"
SoleProprietor	"Sole proprietor"
Trusteeship	"Trusteeship"

---

TaxPayerType

TaxPayerType = ClosedEnum<typeof TaxPayerType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/federaltaxdetails.ts:12

TaxPayerType entity from the Gusto Embedded API.

---

TaxRequirement

TaxRequirement = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirement.ts:35

TaxRequirement entity from the Gusto Embedded API.

Properties

Property	Type	Description
applicableIf?	ApplicableIf[]	An array of references to other requirements within the requirement set. This requirement is only applicable if all referenced requirements have values matching the corresponding value. The primary use-case is dynamically hiding and showing requirements as values change. E.g. Show Requirement-B when Requirement-A has been answered with false. To be explicit, an empty array means the requirement is applicable.
defaultValueApplied?	boolean	Whether the current value is a default rather than an explicitly set one. Remarks
description?	string | null	A more detailed customer facing description of the requirement
editable?	boolean	Whether the value of this requirement can be updated
key?	string	An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set.
label?	string	A customer facing description of the requirement
metadata?	TaxRequirementMetadata	-
payrollBlocking?	boolean	Whether this requirement, when blank, would block payroll processing for the company in this state. Remarks Stable across changes to the field's value: a payroll_blocking: true field reports true whether currently empty or populated.
value?	TaxRequirementsValue | null	The value or "answer" for a tax requirement. Type depends on the requirement metadata type (e.g. string for text/account_number, boolean for radio/checkbox, number for percent/currency/tax_rate). Null when the requirement has not been answered.

---

TaxRequirementMetadata

TaxRequirementMetadata = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:131

TaxRequirementMetadata entity from the Gusto Embedded API.

Properties

Property	Type	Description
type	Type	Describes the type of requirement - each type may have additional metadata properties to describe possible values, formats, etc. Remarks - text: free-text input, no additional requirements - currency: a value representing a dollar amount, e.g. 374.55 representing $374.55 - radio: choose one of options provided, see options - select: choose one of options provided, see options - percent: A decimal value representing a percentage, e.g. 0.034 representing 3.4% - account_number: An account number for a tax agency, more information provided by mask and prefix - tax_rate: A decimal value representing a tax rate, e.g. 0.034 representing a tax rate of 3.4%, see validation for additional validation guidance - workers_compensation_rate: A decimal value representing a percentage, see risk_class_code, risk_class_description, and rate_type
mask?	string | null	[for account_number] A pattern describing the format of the account number Remarks The mask is a sequence of characters representing the requirements of the actual account number. Each character in the mask represents a single character in the account number as follows: - #: a digit (\d) - @: a upper or lower case letter ([a-zA-Z]) - ^: an uppercase letter ([A-Z]) - %: a digit or uppercase letter ([0-9A-Z]) - any other character represents the literal character Examples: - mask: WHT-###### represents WHT- followed by 5 digits, e.g. WHT-33421 - mask: %####-^^ supports values of 75544-AB and Z7654-HK
options?	Options[]	[for select or radio] An array of objects describing the possible values.
prefix?	string | null	[for account_number] A value that precedes the value to be collected - useful for display, but should not be submitted as part of the value. E.g. some tax agencies use an account number that is a company's federal ein plus two digits. In that case the mask would be ## and the prefix XXXXX1234.
rateType?	RateType	[for workers_compensation_rate] The type of rate being collected. Either: Remarks - percent: A percentage formatted as a decimal, e.g. 0.01 for 1% - currency_per_hour: A dollar amount per hour, e.g. 3.24 for $3.24/hr
riskClassCode?	string	[for workers_compensation_rate] The industry risk class code for the rate being requested
riskClassDescription?	string	[for workers_compensation_rate] A description of the industry risk class for the rate being requested
validation?	Validation	[for tax_rate] Describes the validation required for the tax rate

---

TaxRequirementMetadataType

const TaxRequirementMetadataType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:95

Describes the type of tax_rate validation rule

Type Declaration

Name	Type
MinMax	"min_max"
OneOf	"one_of"

---

TaxRequirementMetadataType

TaxRequirementMetadataType = ClosedEnum<typeof TaxRequirementMetadataType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:95

Describes the type of tax_rate validation rule

---

TaxRequirementSet

TaxRequirementSet = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementset.ts:15

TaxRequirementSet entity from the Gusto Embedded API.

Properties

Property	Type	Description
effectiveFrom?	string | null	An ISO 8601 formatted date representing the date values became effective. Some requirement sets are effective dated, while others are not. Multiple requirement sets for the same state/key can/will exist with unique effective dates. If a requirement set is has an effective_from value, all requirement sets with the same key will also have an effective_from value.
key?	string	An identifier for a set of requirements. A list of requirement sets can contain multiple sets with the same key and different effective_from values.
label?	string	Customer facing label for the requirement set, e.g. "Registrations"
requirements?	TaxRequirement[]	-
state?	string	One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)

---

TaxRequirementsState

TaxRequirementsState = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementsstate.ts:15

TaxRequirementsState entity from the Gusto Embedded API.

Properties

Property	Type	Description
companyUuid?	string	-
requirementSets?	TaxRequirementSet[]	-
state?	string	One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)

---

TaxRequirementStatesList

TaxRequirementStatesList = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementstateslist.ts:35

TaxRequirementStatesList entity from the Gusto Embedded API.

Properties

Property	Type	Description
defaultRatesApplied?	boolean	Whether the state is using system-assigned default SUI rates rather than employer-specific rates.
readyToRunPayroll?	boolean	Whether the state tax setup is sufficiently complete for the company to run payroll.
setupStatus?	SetupStatus	The current status of the state tax setup. Remarks - not_started: No requirements have been filled - in_progress: Some requirements have been filled, or default rates are applied - complete: All requirements have been filled without default rates
state?	string	One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)

---

TaxRequirementsValue

TaxRequirementsValue = boolean | string | number

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementsvalue.ts:13

The value or "answer" for a tax requirement. Type depends on the requirement metadata type (e.g. string for text/account_number, boolean for radio/checkbox, number for percent/currency/tax_rate). Null when the requirement has not been answered.

---

Termination

Termination = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/termination.ts:14

The representation of a termination in Gusto.

Properties

Property	Type	Description
uuid	string	The UUID of the termination object.
active?	boolean	Whether the employee's termination has gone into effect.
cancelable?	boolean	Whether the employee's termination is cancelable. Cancelable is true if run_termination_payroll is false and effective_date is in the future.
effectiveDate?	string	The employee's last day of work.
employeeUuid?	string	The UUID of the employee to which this termination is attached.
runTerminationPayroll?	boolean	If true, the employee should receive their final wages via an off-cycle payroll. If false, they should receive their final wages on their current pay schedule.
version?	string	The current version of the object. See the versioning guide for information on how to use this field.

---

Thanksgiving

Thanksgiving = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:65

Thanksgiving entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

TimeOffPolicy

TimeOffPolicy = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicy.ts:44

Representation of a Time Off Policy

Properties

Property	Type	Description
accrualMethod	string	Policy time off accrual method
companyUuid	string	Unique identifier for the company owning the time off policy
employees	TimeOffPolicyEmployees[]	List of employee UUIDs under a time off policy
isActive	boolean	boolean representing if a policy is active or not
name	string	Name of the time off policy
policyType	PolicyType	Type of the time off policy. Only "vacation" and "sick" can be created through the API, but other types may be present if the company was previously a Gusto.com customer.
uuid	string	Unique identifier of a time off policy
accrualRate?	string | null	The rate at which the time off hours will accrue for an employee on the policy. Represented as a float, e.g. "40.0".
accrualRateUnit?	string | null	The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".
accrualWaitingPeriodDays?	number | null	Number of days before an employee on the policy will begin accruing time off hours
carryoverLimitHours?	string | null	The max number of hours an employee can carryover from one year to the next
complete?	boolean	boolean representing if a policy has completed configuration
maxAccrualHoursPerYear?	string | null	The max number of hours an employee can accrue in a year
maxHours?	string | null	The max number of hours an employee can accrue
paidOutOnTermination?	boolean	Boolean representing if an employee's accrued time off hours will be paid out on termination
policyResetDate?	string | null	The date the policy resets. Format MM-DD
version?	string | null	The current version of the object. See the versioning guide for information on how to use this field. The version will be null if the policy is no longer active.

---

TimeOffPolicyEmployees

TimeOffPolicyEmployees = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicy.ts:33

TimeOffPolicyEmployees entity from the Gusto Embedded API.

Properties

Property	Type	Description
balance?	string	The time off balance for the employee
uuid?	string	-

---

TimeOffPolicyRequest

TimeOffPolicyRequest = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicyrequest.ts:44

Request body for creating a time off policy

Properties

Property	Type	Description
accrualMethod	AccrualMethod	Accrual method of the time off policy
name	string	Name of the time off policy
policyType	TimeOffPolicyRequestPolicyType	Type of the time off policy. Currently only "vacation" and "sick" are supported
accrualRate?	string | null	The rate at which the time off hours will accrue for an employee on the policy. Represented as a float, e.g. "40.0".
accrualRateUnit?	string | null	The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".
accrualWaitingPeriodDays?	number | null	Number of days before an employee on the policy will begin accruing time off hours. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0.
carryoverLimitHours?	string | null	The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.
complete?	boolean	boolean representing if a policy has completed configuration
maxAccrualHoursPerYear?	string | null	The max number of hours an employee can accrue in a year. If accrual_method is yearly (per_anniversary_year, per_calendar_year) or unlimited, then max_accrual_hours_per_year must be blank.
maxHours?	string | null	The max number of hours an employee can accrue. If accrual_method is unlimited, then max_hours must be blank.
paidOutOnTermination?	boolean	Boolean representing if an employee's accrued time off hours will be paid out on termination. If accrual_method is unlimited, then paid_out_on_termination must be false.
policyResetDate?	string | null	The date the policy resets. Format MM-DD

---

TimeOffPolicyRequestPolicyType

const TimeOffPolicyRequestPolicyType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicyrequest.ts:12

Type of the time off policy. Currently only "vacation" and "sick" are supported

Type Declaration

Name	Type
Sick	"sick"
Vacation	"vacation"

---

TimeOffPolicyRequestPolicyType

TimeOffPolicyRequestPolicyType = ClosedEnum<typeof TimeOffPolicyRequestPolicyType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/timeoffpolicyrequest.ts:12

Type of the time off policy. Currently only "vacation" and "sick" are supported

---

Totals

Totals = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentgrouppreview.ts:38

Totals entity from the Gusto Embedded API.

Properties

Property	Type	Description
amount?	string	The total amount for the group of contractor payments.
checkAmount?	string	The total check amount for the group of contractor payments.
debitAmount?	string	The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount.
reimbursementAmount?	string	The total reimbursement amount for the group of contractor payments.
wageAmount?	string	The total wage amount for the group of contractor payments.

---

Type

const Type: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:26

Describes the type of requirement - each type may have additional metadata properties to describe possible values, formats, etc.

Remarks

• text: free-text input, no additional requirements
• currency: a value representing a dollar amount, e.g. 374.55 representing $374.55
• radio: choose one of options provided, see options
• select: choose one of options provided, see options
• percent: A decimal value representing a percentage, e.g. 0.034 representing 3.4%
• account_number: An account number for a tax agency, more information provided by mask and prefix
• tax_rate: A decimal value representing a tax rate, e.g. 0.034 representing a tax rate of 3.4%, see validation for additional validation guidance
• workers_compensation_rate: A decimal value representing a percentage, see risk_class_code, risk_class_description, and rate_type

Type Declaration

Name	Type
AccountNumber	"account_number"
Currency	"currency"
Percent	"percent"
Radio	"radio"
Select	"select"
TaxRate	"tax_rate"
Text	"text"
WorkersCompensationRate	"workers_compensation_rate"

---

Type

Type = ClosedEnum<typeof Type>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:26

Describes the type of requirement - each type may have additional metadata properties to describe possible values, formats, etc.

Remarks

• text: free-text input, no additional requirements
• currency: a value representing a dollar amount, e.g. 374.55 representing $374.55
• radio: choose one of options provided, see options
• select: choose one of options provided, see options
• percent: A decimal value representing a percentage, e.g. 0.034 representing 3.4%
• account_number: An account number for a tax agency, more information provided by mask and prefix
• tax_rate: A decimal value representing a tax rate, e.g. 0.034 representing a tax rate of 3.4%, see validation for additional validation guidance
• workers_compensation_rate: A decimal value representing a percentage, see risk_class_code, risk_class_description, and rate_type

---

UnblockOptions

UnblockOptions = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollsubmissionblockertype.ts:12

UnblockOptions entity from the Gusto Embedded API.

Properties

Property	Type	Description
checkDate?	string	The payment check date associated with the unblock option.
metadata?	object	Additional data associated with the unblock option.
unblockType?	string	The type of unblock option for the submission blocker.

---

UnprocessedTerminationPayPeriod

UnprocessedTerminationPayPeriod = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/unprocessedterminationpayperiod.ts:14

The representation of an unprocessed termination pay period.

Properties

Property	Type	Description
checkDate?	string	The check date of the pay period.
debitDate?	string	The debit date of the pay period.
employeeName?	string	The full name of the employee.
employeeUuid?	string	A unique identifier of the employee.
endDate?	string	The end date of the pay period.
payScheduleUuid?	string	A unique identifier of the pay schedule to which the pay period belongs.
startDate?	string	The start date of the pay period.

---

UpcomingEmployment

UpcomingEmployment = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractor.ts:76

The contractor's upcoming employment details, if a rehire is scheduled.

Properties

Property	Type	Description
setupStatus?	string | null	The setup status of the upcoming employment.
startDate?	string	The start date of the upcoming employment.

---

Validation

Validation = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/taxrequirementmetadata.ts:109

[for tax_rate] Describes the validation required for the tax rate

Properties

Property	Type	Description
type	TaxRequirementMetadataType	Describes the type of tax_rate validation rule
max?	string	[for min_max] The inclusive upper bound of the tax rate
min?	string	[for min_max] The inclusive lower bound of the tax rate
rates?	string[]	[for one_of] The possible, unformatted tax rates for selection. Remarks - e.g. ["0.0", "0.001"] representing 0% and 0.1%

---

VerificationStatus

const VerificationStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:33

The verification status of the bank account.

Remarks

'awaiting_deposits' means the bank account is just created and money is being transferred. 'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint. 'verified' means the bank account is verified.

Type Declaration

Name	Type
AwaitingDeposits	"awaiting_deposits"
ReadyForVerification	"ready_for_verification"
Verified	"verified"

---

VerificationStatus

VerificationStatus = ClosedEnum<typeof VerificationStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:33

The verification status of the bank account.

Remarks

'awaiting_deposits' means the bank account is just created and money is being transferred. 'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint. 'verified' means the bank account is verified.

---

VerificationType

const VerificationType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:57

The verification type of the bank account.

Remarks

'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits. 'plaid' means the bank account is connected through Plaid.

Type Declaration

Name	Type
BankDeposits	"bank_deposits"
Plaid	"plaid"
PlaidExternal	"plaid_external"

---

VerificationType

VerificationType = ClosedEnum<typeof VerificationType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/companybankaccount.ts:57

The verification type of the bank account.

Remarks

'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits. 'plaid' means the bank account is connected through Plaid.

---

VeteransDay

VeteransDay = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/holidaypaypolicy.ts:59

VeteransDay entity from the Gusto Embedded API.

Properties

Property	Type
date?	string
name?	string
selected?	boolean

---

WageType

const WageType: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:45

The wage type for the payment.

Type Declaration

Name	Type
Fixed	"Fixed"
Hourly	"Hourly"

---

WageType

WageType = ClosedEnum<typeof WageType>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/contractorpaymentforgrouppreview.ts:45

The wage type for the payment.

---

WarningObject

WarningObject = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/warningobject.ts:11

WarningObject entity from the Gusto Embedded API.

Properties

Property	Type	Description
category?	string	Specifies the type of warning. Can be used to build custom warning handling.
errorKey?	string	Specifies where the warning occurs. Typically identifies the attribute or parameter related to the warning.
message?	string	Provides details about the warning. The message can be surfaced directly to the end user.

---

WireInRequest

WireInRequest = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/wireinrequest.ts:41

Representation of a wire in request

Properties

Property	Type	Description
additionalNotes?	string | null	Notes for the wire in request
amountSent?	string | null	Amount sent through wire in
bankName?	string | null	Name of the bank initiating the wire in
dateSent?	string | null	Date the wire in was sent
originationBank?	string	Name of bank receiving the wire in
originationBankAddress?	string	Address of bank receiving the wire in
paymentType?	PaymentType	Type of payment for the wire in
paymentUuid?	string	Unique identifier of the payment
recipientAccountNumber?	string	Recipient bank account number
recipientAddress?	string	Address of the recipient of the wire in
recipientName?	string	Name of the recipient of the wire In
recipientRoutingNumber?	string	Recipient bank routing number
requestedAmount?	string	Requested amount for the payment
status?	WireInRequestStatus	Status of the wire in
uniqueTrackingCode?	string	Include in note with bank to track payment
uuid?	string	Unique identifier of a wire in request
wireInDeadline?	string	Deadline to submit the wire in

---

WireInRequestStatus

const WireInRequestStatus: object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/wireinrequest.ts:15

Status of the wire in

Type Declaration

Name	Type
Approved	"approved"
AwaitingFunds	"awaiting_funds"
Canceled	"canceled"
PendingReview	"pending_review"

---

WireInRequestStatus

WireInRequestStatus = ClosedEnum<typeof WireInRequestStatus>

Defined in: gusto_embedded_v_2026_06_15/src/models/components/wireinrequest.ts:15

Status of the wire in

---

Workweeks

Workweeks = object

Defined in: gusto_embedded_v_2026_06_15/src/models/components/payrollshow.ts:594

Workweeks entity from the Gusto Embedded API.

Properties

Property	Type	Description
endDate?	RFCDate	The end date of the workweek.
startDate?	RFCDate	The start date of the workweek.