Create Accrual Policy
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Create an accrual policy in Zeal's system. When you use this endpoint, you are simply creating a Accrual Policy Object.
Returns Skip link to Returns
Returns boolean indicating success status and a list of Accrual Policy Object
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | array | List of Accrual Policy Object |
| errors | array | Contains list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
companyID
string
required
ID of the company
policy_code
string
required
Unique code to assign to this policy
policy_type
string
required
Type of the accrual policy (accepts: pto, sick_leave, or custom)
policy_name
string
Custom name that can be assigned for the policy
policy_effective_date
date
The effective start date of the policy
accrual_rate_hours
float
required
The rate at which employees will accrue hours
accrual_period_hours
float
required
The number of hours employees need to work to accrue accrual_rate_hours
immediate_balance
float
The initial or immediate hour balance of policy
include_doubletime
boolean
required
Include if doubletime work is eligible for hour accrual
truefalse
include_overtime
boolean
required
Include if overtime work is eligible for hour accrual
truefalse
accrual_waiting_period
float
The number of hours the employees need to work before they are eligible to begin accruing time for policy
accrual_cap
float
The maximum number of hours an employee can accrue within a policy year. Once this limit is reached, no additional hours will accrue until the next accrual period or rollover_date.
rollover_cap
float
The maximum number of unused hours an employee is allowed to carry over from one policy year to the next on the specified rollover date.
rollover_date
date
Required if user passes a value for rollover_cap or accrual_cap
balance_cap
float
The maximum balance an employee is allowed to hold under this policy
``200 200
``400 400
Updated 7 months ago
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request POST \
\
--url https://api.zeal.com/accrualPolicy \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"include_doubletime": true,
"include_overtime": true
}
'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result
Updated7 months ago