Partially updates an existing contract.

patch

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

Access: System, Admin, and ClientAdmin users only.

The endpoint reads the submitted JSON body through PatchValueHelper so omitted fields remain unchanged while supplied fields are updated.

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.

int32

required

Contract identifier from the route.

Body Params

Contract fields to update.

Payload used to partially update an existing employee contract.

startOn

date-time | null

Updated contract start date in ISO 8601 date format (yyyy-MM-dd), or null to keep the current value.
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:

compensableHours

double | null

-214748 to 214748

Updated compensable hours, or null to keep the current value.

compensationAmount

double | null

Updated compensation amount.
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 | null

Updated number of units for piecework compensation types.

isStatutory

boolean | null

Updated statutory-employee flag.

is943

boolean | null

Updated 943 agricultural-employee flag.

workLocationId

int32 | null

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

departmentId

int32 | null

Updated department identifier.

divisionId

int32 | null

Updated division identifier when company divisions are enabled.

wcCode

string | null

Updated worker's compensation code.

jobCostingCode

string | null

Updated job-costing code.

socCode

string | null

Updated Standard Occupational Classification (SOC) code as an unformatted 6-character string (for example, "111011"),
or null to keep the current value. Applies to U.S. employees only.

positionId

int32 | null

Updated position identifier.

holidayGroupId

int32 | null

Updated holiday-group identifier.

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