Accrual methods

Consult the following tables to determine which fields to include when creating a time off policy, depending on your accrual_method:

unlimited

API field	Include?	API requirements
`accrual_rate`	⛔ No	N/A - no error thrown but value will not be included
`accrual_rate_unit`	⛔ No	N/A - no error thrown but value will not be included
`accrual_waiting_period_days`	⛔ No	Must be `null`
`paid_out_on_termination`	⛔ No	Must be `null`
`carryover_limit_hours`	⛔ No	Must be `null`
`max_accrual_hours_per_year`	⛔ No	Must be `null`
`max_hours`	⛔ No	Must be `null`

per_pay_period

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	⛔ No	Must be `null`
`accrual_waiting_period_days`	✅ Yes	Optional
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	✅ Yes	Optional
`max_hours`	✅ Yes	Optional

per_calendar_year

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	⛔ No	Must be NULL
`accrual_waiting_period_days`	⛔ No	Must be `0` or `null` or error will be thrown
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	⛔ No	Must be NULL
`max_hours`	✅ Yes	Optional

per_anniversary_year

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	⛔ No	Must be `null`
`accrual_waiting_period_days`	⛔ No	Must be `0` or `null`
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	⛔ No	Must be `null`
`max_hours`	✅ Yes	Optional

per_hour_worked

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	✅ Yes	Required, must be greater than 0
`accrual_waiting_period_days`	✅ Yes	Optional, `null`, or greater than 0
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	✅ Yes	Optional
`max_hours`	✅ Yes	Optional

per_hour_worked_no_overtime

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	✅ Yes	Required, must be greater than 0
`accrual_waiting_period_days`	✅ Yes	Optional, `null`, or greater than 0
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	✅ Yes	Optional
`max_hours`	✅ Yes	Optional

per_hour_paid

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	✅ Yes	Required, must be greater than 0
`accrual_waiting_period_days`	✅ Yes	Optional, `null`, or greater than 0
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	✅ Yes	Optional
`max_hours`	✅ Yes	Optional

per_hour_paid_no_overtime

API field	Include?	API requirements
`accrual_rate`	✅ Yes	Required
`accrual_rate_unit`	✅ Yes	Required, must be greater than 0
`accrual_waiting_period_days`	✅ Yes	Optional, `null`, or greater than 0
`paid_out_on_termination`	✅ Yes	Optional - If request is `null`, will default to `false`
`carryover_limit_hours`	✅ Yes	Optional
`max_accrual_hours_per_year`	✅ Yes	Optional
`max_hours`	✅ Yes	Optional

Updated 1 day ago