API Reference

Add a new Terms for the Employee or 1099

post
https://api.worklio.com/wep/companies//employees//contracts
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The Company Id.

int32
required

The Employee/1099 Id.

Body Params

The Terms.

date-time | null
required

Start of the contract. Data type is validated and must be Number

int32
enum
required

Work Schedule Type

Members:

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

Allowed:
int32
enum
required

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:
int32
enum

Members:

  • 0 - NA ( N/A. )
  • 1 - Weekly ( Weekly. )
  • 2 - BiWeekly ( Bi-weekly. )
  • 3 - SemiMonthly ( Semi-monthly. )
  • 4 - Monthly ( Monthly. )
Allowed:
int32 | null

Payroll Policy ID (optional). If not used, DEFAULT policy is used

double | null
required

Compensable Hours.

double | null
required

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.

int32

Number of Units, applies to 'Piecework' CompensationType.

boolean

Statutory Employee.

boolean

943 Agricultural Employee.

int32 | null
required

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

int32 | null

Department Id.

int32 | null

Division of the employee, if divisions are active.

string | null

Worker's Compensation Code.

string | null

Job Costing Code.

int32 | null

Position Id.

Headers
string
Defaults to 1.0

The requested 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

Updated 7 months ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain

Updated 7 months ago