ZEzeal

Update Accrual Policy

patch/accrualPolicy

Request

Request body

companyIDstring required

ID of the company

policy_codestring required

Unique code assigned to the policy

policy_typestring

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

policy_effective_datestring date

The effective start date of the policy

accrual_rate_hoursnumber float

The rate at which employees will accrue hours

accrual_period_hoursnumber float

The number of hours employees need to work to accrue accrual_rate_hours

immediate_balancenumber float

The initial or immediate hour balance of policy

include_doubletimeboolean

Include if doubletime work is eligible for hour accrual

include_overtimeboolean

Include if overtime work is eligible for hour accrual

accrual_waiting_periodnumber float

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

accrual_capnumber float

Max hours an employee can accrue in one calendar year

rollover_capnumber float

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

rollover_datestring date

Required if user passes a value for rollover_cap

policy_statusstring

The status of the policy (accepts live or terminated)

include_flatboolean

Include if flat earning component is eligible for accrual

balance_capnumber float

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

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "companyID": "123er534efrerwwe3444e",
    "policy_code": "001",
    "policy_type": "pto",
    "policy_name": "Updated name",
    "policy_effective_date": "2023-03-01",
    "accrual_rate_hours": 10,
    "accrual_period_hours": 40,
    "immediate_balance": 50,
    "include_doubletime": true,
    "include_overtime": true,
    "accrual_cap": 50,
    "rollover_cap": 90,
    "rollover_date": "01-01",
    "policy_status": "live"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.