Create Payroll Policy

post

https://api.worklio.com/wep/companies/{companyId}/policies

Creates new payroll policy. Policy name DEFAULT is reserved for Default payroll policy used by Start Default Payroll endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Body Params

payFrequency

int32

enum

required

Members:

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

Allowed:

firstPayPeriodEndDate

date-time | null

required

First Pay Period End Date Data type is validated and must be Number

secondPayPeriodEndDate

date-time | null

Second Pay Period End Date Data type is validated and must be Number Data type is validated and is required if payFrequency property is set to 3.

firstPayDate

date-time | null

required

First Pay Date Data type is validated and must be Number

movePayDayOnHolidaysAndWeekends

int32

enum

required

Members:

0 - DayAfter ( First Business Day After )
1 - DayBefore ( Last Business Day Before )

Allowed:

autoRun

boolean | null

Autorun - payroll will be started and processed automatically

name

string | null

Policy Name

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

Language

Credentials

Bearer

jwt

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success