API Reference

Initial setup to Employee's TimeOff Policy

post
https://api.worklio.com/wep/companies//employees//timeoff-policy-setups/

Initial setup to timeoff employee 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. \

Path Params
int32
required
int32
required
int32
required

Id from endpoint companies/{companyId:int}/timeoffpolicies/{policyId:int}

Body Params
date

The Rule Start Date indicates when entitlements to an employee's time off policy will begin. This is the starting date from which accrual and availability delays are calculated, if defined in the Time Off Policy. Data type is validated and must be Number

date | null

You can set probation end date for this employee. Usable in situations where you want to allow employee to start using this Time Off Rule in advance of other employees. System will automatically calculate this date if you leave it blank. Data type is validated and must be Number

double | null

This applies to plans based on hours worked. Enter the annual hours an employee must work to earn the full accrual amount. This field is for informational purposes only and is not used for calculation.

double | null

Maximum number of work hours that can be used to calculate accrual hours per pay period.

double | null

Number of hours the employee has worked this accrual year in previous system.

double | null

Number of hours the employee has rolled over from previous accrual year.

double | null

Number of hours the employee has lost during roll over from previous accrual year because of the Rollover Limit. Enter Positive Amount.

double | null

Number of hours the employee has already accrued in the current accrual year.

double | null

Number of hours already used by the employee in the current accrual year. Enter Positive Amount.

double | null

Sum of the adjustments for the emplyoee in the current accrual year. Enter Negative Or Positive Amount.

double | null

Number of hours the employee has lost because of the Balance Limit. Enter Positive Amount.

double | null

Number of hours the employee has lost because of the Annual Limit. Enter Positive Amount.

participationLimits
object
Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Updated 7 months ago

Language
Credentials
Bearer
jwt
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago