Skip to main content
PATCH
Update Accrual Policy

Authorizations

Authorization
string
header
required

Body

application/json
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
string<date>

The effective start date of the policy

accrual_rate_hours
number<float>

The rate at which employees will accrue hours

accrual_period_hours
number<float>

The number of hours employees need to work to accrue accrual_rate_hours

immediate_balance
number<float>

The initial or immediate hour balance of policy

include_doubletime
boolean

Include if doubletime work is eligible for hour accrual

include_overtime
boolean

Include if overtime work is eligible for hour accrual

accrual_waiting_period
number<float>

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

accrual_cap
number<float>

Max hours an employee can accrue in one calendar year

rollover_cap
number<float>

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

rollover_date
string<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

balance_cap
number<float>

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

Response

200

success
boolean
default:true
Example:

true

data
object