Update Accrual Policy

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Updates an accrual policy in Zeal's system

Returns

Returns boolean indicating success status and the updated Accrual Policy Object

attribute type description
success boolean Response status
data array Updated Accrual Policy Object
errors array Contains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

companyID

string

required

ID of the company

policy_code

string

required

Unique code assigned to the policy

policy_type

string

Type of the accrual policy (accepts: pto, sick_leave, or custom)

policy_effective_date

date

The effective start date of the policy

accrual_rate_hours

float

The rate at which employees will accrue hours

accrual_period_hours

float

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

Include if doubletime work is eligible for hour accrual

truetruefalse

include_overtime

boolean

Include if overtime work is eligible for hour accrual

truetruefalse

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

Max hours an employee can accrue in one calendar year

rollover_cap

float

Max hours an employee can rollover from one year to the next year, on specified rollover date

rollover_date

date

Required if user passes a value for rollover_cap

policy_status

string

The status of the policy (accepts live or terminated)

include_flat

boolean

Include if flat earning component is eligible for accrual

truefalse

balance_cap

float

The maximum balance an employee is allowed to hold under this policy

`200 200

`400 400

Updated 11 months ago


ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request PATCH \
     --url https://api.zeal.com/accrualPolicy \
     --header 'accept: application/json' \ 
     --header 'content-type: application/json'

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

application/json

200 - Result400 - Result

Updated 11 months ago