Create a leave policy

Create a leave policy. It's active right away and takes effect today. Describe each leave type it earns in one of three lists: accruedLeaveTypes for leave earned as workers work, frontLoadedLeaveTypes for paid leave granted in a lump each period, and unpaidFrontLoadedLeaveTypes for unpaid leave granted the same way. Leave types are referenced by name, so they must already exist. See List leave types and Create a leave type.

The policy needs at least one leave type, and each leave type can appear only once. If a leave type has no pay code yet, one is created. See the Guide to the Leave Accrual API for how award rules and tenure tiers work.

Body Params

Include at least one leave type across the three lists, and each leave type only once.

string
required

A unique name, ignoring case. 1 to 100 characters after surrounding spaces are removed.

string

An optional description.

string
enum
required

When front-loaded periods start. CALENDAR starts them on calendar boundaries, like January 1. HIRE_DATE starts them on each worker's hire anniversary.

Allowed:
accruedLeaveTypes
array of objects
accruedLeaveTypes
frontLoadedLeaveTypes
array of objects
frontLoadedLeaveTypes
unpaidFrontLoadedLeaveTypes
array of objects
unpaidFrontLoadedLeaveTypes
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json