Update Terms for the Employee or 1099

patch

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

The Company Id.

employeeId

int32

required

The Employee/1099 Id.

int32

required

The Terms Id.

Body Params

The Contract.

Contract update record.

startOn

date-time | null

Start of the contract. 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

Compensable Hours.

compensationAmount

double | null

This field has different meanings depending on the 'CompensationType' value. Compensable Amount - applies to 'Salaried', 'Commissioned', 'OwnerDraws1099' and 'Form1099' CompensationType. Hourly Rate - applies to 'Hourly' and 'Tipped' CompensationType. Unit Work Rate - applies to 'Piecework' CompensationType.

compensationNumberOfUnits

int32 | null

Number of Units, applies to 'Piecework' CompensationType.

isStatutory

boolean | null

Statutory Employee.

is943

boolean | null

943 Agricultural Employee.

workLocationId

int32 | null

Work Location Id. Use 0 for Work From Home.

departmentId

int32 | null

Department Id.

divisionId

int32 | null

Division of the employee, if divisions are active.

wcCode

string | null

Worker's Compensation Code.

jobCostingCode

string | null

Job Costing Code.

positionId

int32 | null

Position Id.

holidayGroupId

int32 | null

Holiday Group Id.

Headers

api-version

string

Defaults to 1.0

The requested API version

x-api-version

string

Defaults to 1.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200Success