API Reference

Create TimeOff Policy

post
https://api.worklio.com/wep/companies//timeoff-policies

Create timeoff policy and set information about it.

This endpoint can be called only by System and Admin level users.

Employee call will return Forbidden result even for Employee own company. \

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Body Params
int32 | null
required

When creating a Time Off Policy, you can either set all the data or enter only the presetId here, and all policy values will be set according to the selected preset. If you specify a presetId along with other details for a policy, all other details will be ignored, and the values from the preset will be used. Use the GET method, 'List of Presets,' to preview presets and their values.

string | null

Enter a name for the policy.

int32
enum

Definition when time off accruals should begin.

Members:

  • 1 - CalendarYear ( CalendarYear. )
  • 2 - EmploymentAnniversary ( EmploymentAnniversary. )

Allowed:
int32 | null
1 to 12

Select the month when the time off accruals should start. Data type is validated and is required if accrualYearType property is set to 1. Data type is validated and is required if accrualYearType property is set to 1.

int32 | null
≥ 0

Define when the accrual starts for a new employee.

int32 | null
≥ 0

Specify how long a new employee must wait before using their accrued time off.

serviceYear
object
int32
enum

Type of Legislative

Members:

  • 1 - US ( US. )
  • 255 - Global ( Global. )

Allowed:
Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Updated about 16 hours 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

Updated about 16 hours ago