Skip to content
ShiftlyDevelopers
Documentation menu

Leave

A request you submit is pending. The employee is notified, and decisions are made in Shiftly.

A business offers a set of leave types, such as annual leave and personal leave, and each employee has a balance for each type that builds up as they work. A leave request asks for a span of days against one type.

With leave:write your app can submit a request on an employee's behalf. It arrives pending, and Shiftly tells the employee and the managers. A manager approves or declines it in Shiftly; your app can change or cancel it only while it is pending, and a change afterwards answers leave_not_pending.

Leave dates are calendar days, and leave requests span whole days. A request for a leave type the business does not offer is refused, naming the leave_type field; read the business's Leave types first. A request that overlaps the person's existing leave is refused with conflict.

Balances are worked out when you ask, from the person's accruals and the leave already taken or approved, so there is nothing to page through.

Private kinds of leave, such as family and domestic violence leave, are never shared. A request of that kind shows its leave_type as PRIVATE with no note, whoever connected your app, and its balance and leave type are left out. Your app cannot submit one; staff and managers record it in Shiftly.

Leave blackout periods are the times a business limits leave, such as a busy season. They stop staff asking in Shiftly; they do not stop a request your app submits.