Skip to main content
POST
Create Accrual Policy

Authorizations

Authorization
string
header
required

Body

application/json
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)

accrual_rate_hours
number<float>
required

The rate at which employees will accrue hours

accrual_period_hours
number<float>
required

The number of hours employees need to work to accrue accrual_rate_hours

include_doubletime
boolean
required

Include if doubletime work is eligible for hour accrual

include_overtime
boolean
required

Include if overtime work is eligible for hour accrual

policy_name
string

Custom name that can be assigned for the policy

policy_effective_date
string<date>

The effective start date of the policy

immediate_balance
number<float>

The initial or immediate hour balance of policy

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>

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
number<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
string<date>

Required if user passes a value for rollover_cap or accrual_cap

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