Saves detailed U.S. employment settings for the onboarding.

put

https://example.com/wep/companies/{companyId}/onboarding/start/{id}/employmentdetail

Access: System, Admin, and ClientAdmin users only.

This endpoint validates compensation, workers' compensation, payroll-policy, and referenced entity selections before persisting the employment-detail step.
It is intended for U.S. employee and 1099 onboarding types only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company identifier from the route.

int32

required

Onboarding identifier from the route.

Body Params

Detailed U.S. employment settings to save.

Employer-provided employment details collected during onboarding step 1.

employmentType

int32

enum

Work Schedule Type

Members:

1 - PartTime ( Part-Time. )
2 - FullTime ( Full-Time. )
3 - Temporary ( Temporary. )
4 - Intern ( Intern. )
5 - Seasonal ( Seasonal. )

Allowed:

compensationType

int32

enum

CompensationType_v10 enum

Members:

1 - Salaried ( Salaried. )
2 - Hourly ( Hourly. )
3 - Piecework ( Piecework. )
4 - Commissioned ( Commissioned. )
5 - Form1099 ( 1099 Employee. )
6 - OwnerDraws1099 ( 1099 - Owner Draws. )
7 - Tipped ( Tipped. )

Allowed:

compensableHours

double | null

required

0 to 9999999

Compensable Hours.

compensationAmount

double | null

Compensation amount used for salary-, commission-, owner-draw-, or 1099-based compensation types.

compensationHourlyRate

double | null

-214748 to 214748

Hourly rate used for hourly or tipped compensation types.

compensationUnitWorkRate

double | null

-214748 to 214748

Per-unit rate used for piecework compensation.

compensationNumberOfUnits

int32 | null

Number of work units used for piecework compensation.

isStatutory

boolean

Statutory Employee.

is943

boolean

943 Agricultural Employee.

workLocationId

int32 | null

required

Work Location Id. Use 0 for 'Works From Home'.

departmentId

int32 | null

Department Id.

divisionId

int32 | null

Division of the employee, if divisions are active.

holidayGroupId

int32 | null

Holiday-group identifier assigned to the employee, when applicable.

wcCode

string | null

Worker's Compensation Code.

socCode

string | null

Standard Occupational Classification (SOC) code as an unformatted 6-character string (for example, "111011").

sCorpOwner

boolean | null

Indicates whether the employee is treated as an S-corporation owner.

businessOwner

boolean | null

Indicates whether the employee is a business owner.

percentageOfOwnership

double | null

0 to 100

Ownership percentage used when owner fields apply.

eligibleForSection125

boolean | null

Indicates whether the employee is eligible for a Section 125 plan.

corporateOfficer

boolean | null

Indicates whether the employee is a corporate officer.

exemptFromWC

boolean | null

Indicates whether the employee is exempt from workers' compensation coverage.

workerType

int32

enum

Members:

0 - NonExempt ( Non-exempt. )
1 - Exempt ( Exempt. )

Allowed:

eeoClass

int32

enum

Members:

1 - ExecutiveSeniorManagers ( Executive/Senior Level Officials and Managers. )
2 - FirstMidLevelManagers ( First/Mid Level Officials and Managers. )
3 - Professionals ( Professionals. )
4 - Technicians ( Technicians. )
5 - SalesWorkers ( Sales Workers. )
6 - AdministrativeSupportWorkers ( Administrative Support Workers. )
7 - CraftWorkers ( Craft Workers. )
8 - Operatives ( Operatives. )
9 - LaborersAndHelpers ( Laborers and Helpers. )
10 - ServiceWorkers ( Service Workers. )

payrollPolicyId

int32 | null

Payroll-policy identifier assigned to the employee, when applicable.

highlyCompensated

int32

enum

Highly Compensated Employee

Members:

0 - No ( No. )
1 - YesMoreThan5Owner ( Yes - More than 5% Owner. )
2 - YesCompensationOnly ( Yes - Compensation Only. )

Allowed:

keyEmployee

int32

enum

Members:

0 - No ( No. )
1 - YesOfficerExceedCompTreshold ( YesOfficerExceedCompTreshold. )
2 - YesMoreThan5Owner ( YesMoreThan5Owner. )
3 - YesMoreThan1OwnerAnd150kComp ( YesMoreThan1OwnerAnd150kComp. )

Allowed:

benefitGroupId

int32 | null

Benefit-group identifier assigned to the employee, when applicable.

jobDescription

string | null

Job description or duties summary.

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

Responses

200OK

400Bad Request

403Forbidden

500Internal Server Error