API Reference

Update Accrual Policy

patch
https://api.zeal.com/accrualPolicy
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates an accrual policy in Zeal's system

Returns

Returns boolean indicating success status and the updated Accrual Policy Object

attributetypedescription
successbooleanResponse status
dataarrayUpdated Accrual Policy Object
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of the company

string
required

Unique code assigned to the policy

string

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

date

The effective start date of the policy

float

The rate at which employees will accrue hours

float

The number of hours employees need to work to accrue accrual_rate_hours

float

The initial or immediate hour balance of policy

boolean

Include if doubletime work is eligible for hour accrual

boolean

Include if overtime work is eligible for hour accrual

float

The number of hours the employees need to work before they are eligible to begin accruing time for policy

float

Max hours an employee can accrue in one calendar year

float

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

date

Required if user passes a value for rollover_cap

string

The status of the policy (accepts live or terminated)

boolean

Include if flat earning component is eligible for accrual

float

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

Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago