Creates a new contract for the employee.

post

https://example.com/wep/companies/{companyId}/employees/{employeeId}/contracts

Access: System, Admin, and ClientAdmin users only.

The employee must belong to the specified company. The created contract is returned as the public contract DTO.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company identifier from the route.

employeeId

int32

required

Employee or contractor identifier from the route.

Body Params

Contract payload to create.

Payload used to create a new employee contract.

startOn

date-time | null

required

Contract start date in ISO 8601 date format (yyyy-MM-dd).
Data type is validated and must be Number

workSchedule

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:

payPeriod

int32

enum

Members:

0 - NA ( N/A. )
1 - Weekly ( Weekly. )
2 - BiWeekly ( Bi-weekly. )
3 - SemiMonthly ( Semi-monthly. )
4 - Monthly ( Monthly. )

Allowed:

payrollPolicyID

int32 | null

Optional payroll-policy identifier. When omitted, the company's default payroll policy is used.

compensableHours

double | null

required

Compensable hours defined by the contract.

compensationAmount

double | null

required

Compensation amount defined by the contract.
For salaried, commissioned, owner-draw, and 1099 contracts this is the compensable amount.
For hourly and tipped contracts this is the hourly rate.
For piecework contracts this is the unit-work rate.

compensationNumberOfUnits

int32

Number of units for piecework compensation types.

isStatutory

boolean

Indicates whether the worker is treated as a statutory employee.

is943

boolean

Indicates whether the worker is treated as a 943 agricultural employee.

workLocationId

int32 | null

required

Work-location identifier. Use 0 for work-from-home.

departmentId

int32 | null

Department identifier assigned to the contract, when applicable.

divisionId

int32 | null

Division identifier assigned to the contract when company divisions are enabled.

wcCode

string | null

Worker's compensation code assigned to the contract.

jobCostingCode

string | null

Job-costing code assigned to the contract.

socCode

string | null

Standard Occupational Classification (SOC) code as an unformatted 6-character string (for example, "111011").
Applies to U.S. employees only; ignored for global employees.

positionId

int32 | null

Position identifier assigned to the contract, when applicable.

holidayGroupId

int32 | null

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

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200OK