Skip to main content

Leave management

The leave module lets your workspace define what kinds of leave employees can take, how much they get, who is eligible, and how requests are reviewed. Everything lives under Leave in the admin sidebar (routes begin with /admin/leave). Employees apply and check balances from their portal.

How leave fits together​

Leave is built up in layers. Set them up in this order the first time:

LayerWhat it doesWhere
Leave typeA named kind of leave (Annual, Casual, Sick…)./admin/leave/types
Leave policyThe rules for one type — quota, eligibility, carry-forward, sandwich rules, effective dates./admin/leave/policies
Leave groupA bundle of policies attached to a shift or employee, so different staff get different entitlements./admin/leave/groups
AllocationWrites each employee's yearly balance for the fiscal year./admin/leave/allocations
BalanceThe running total an employee can draw from./admin/leave/balances

Your workspace already ships with a starter set of leave types and policies, so you can review and adjust rather than build from scratch.

Leave types​

A leave type is the label employees see when they apply. To add one, open Leave Types and select Add Leave Type.

FieldNotes
NameShown to employees. Must be unique in your workspace.
CodeA short tag (up to 10 characters, e.g. AL, SL). Also unique.
ColorUsed on the calendar and balance chips.
PaidWhether the leave is paid. Unpaid types (like leave without pay) are still tracked.
PayShown when Paid is on. The share of a normal day's pay each day of this leave is paid at, from 1 to 100%. The default is 100 (full pay); enter 50 for half-pay leave.
UnitDays (the default) or Hours. An hourly type is for a dentist's appointment or a late start: an application is part of one day, and the quota, allocation and balance are all hours. Fixed once the type has allocations or applications. See Hourly leave.
Approval flowShown once the workspace has leave flows. Match by the flows' conditions (the default) lets the approvals engine pick the flow; naming a flow pins every application of this type to it, whatever the conditions say. See Approval flows.

Deleting a type deactivates it rather than erasing history. You cannot deactivate a type that still has pending applications — resolve those first.

Leave at reduced pay​

When a paid type's Pay is under 100%, payroll withholds the rest of each day of that leave:

  • A day of 50% leave is paid as half a day. Four days of it in a month withhold two days' pay.
  • A half-day application withholds half as much: half a day of 50% leave withholds a quarter of a day's pay.
  • If the type's policy counts weekends and holidays (a sandwich rule), the rest days inside the leave are paid at the same share.
  • The withheld pay is part of the Unpaid Leave Deduction, not an absence, and the payroll run's breakdown counts it under Unpaid Leaves: four days at 50% count as 2.
  • A day inside the leave on which attendance shows the employee at work, not on leave, is paid in full.
  • A payroll run with Skip attendance deductions pays the leave in full, as it does unpaid leave.
  • Leave encashment and final settlement do not use it: they pay out a balance at the policy's encashment rate (see Encashment).

Employment contracts list the type in their leave table with its share in the Pay column ("50%"); a full-pay type shows "Paid". The Leave Types and Leave Balances pages show the share next to the type too.

Where your country's starter set pays a tier of sick or maternity leave at a reduced rate, that tier is its own leave type with Pay already set, for example "Sick Leave (Half Pay)" at 50%. Each tier keeps its own balance.

caution

If you have been posting the unpaid share of reduced-pay leave as a payroll adjustment, stop once the type's Pay is set. Payroll now withholds it, and the adjustment would dock the employee twice.

Hourly leave​

A type with Unit set to Hours is taken in hours inside one day. The application form asks for the From Date and the Hours (in half hours, up to 24) instead of a date range and the half-day toggle; the summary and the balance cards show hours. Two hourly applications may share a day (a morning and an afternoon appointment); a day-long leave excludes everything on its dates.

Approving an hourly leave does not mark the day on leave on attendance: the employee still works the rest of it, so the day is left to its punches. Payroll docks an unpaid, or reduced-pay, hourly leave as that share of the shift day: two unpaid hours on an eight-hour shift withhold a quarter of a day's pay, under Unpaid Leave Deduction like any other reduced-pay leave. A fully paid hourly type costs nothing on the slip.

The policy's quota, carry forward limit, negative balance and cyclic credit are hours too, and the policy editor says so at the top when the type is hourly. Maximum consecutive days and the document threshold do not apply. The yearly allocation, accrual and carry forward treat an hourly type like any other: hours are allocated, accrue and carry over as hours, and nothing is converted.

Money is the exception, because a rate is a figure per day. Wherever a balance is priced by the day (encashment, the leave line of a final settlement, the liability snapshot), an hourly balance is turned into days first:

days = hours ÷ the employee's standard hours per day, to two decimals

The standard hours per day are the ones payroll uses: the figure on the employee's salary assignment when it sets one, otherwise the length of their shift, otherwise the workspace's default shift, otherwise eight. Sixteen hours on an eight-hour day are two days, and are paid or valued as two days. The encashment rate on an hourly type's policy is still a rate per day.

Leave policies​

Each type needs a policy to be usable. From Leave Types, use the settings action on a type (or open Leave Policies and pick the type) to reach the policy editor at /admin/leave/policies/{leaveTypeId}.

A type has one active policy at a time, versioned by its effective dates. Saving updates the current active policy; setting an Effective To date lets you retire an old policy and start a new one later.

Accrual mode​

  • Annual Quota — the standard mode. The full yearly quota is credited when leave is allocated.
  • Cyclic Accrual — credits a fixed number of leave days for every block of worked days (for example, 1 day of rest for every 20 worked). Used for residential or rotational staff. When you choose this, set Worked Days per Cycle, Leave Days Credited, and an optional Max Accumulated cap. A daily job counts the previous day's qualifying worked days shortly after 01:00 in your workspace's time zone, once that day's attendance is marked, and tops up the balance automatically.

Policy settings​

SettingWhat it controls
Annual Quota (days)Days granted per fiscal year (for annual-quota mode).
Max Consecutive DaysThe longest single stretch an employee can request.
Carry ForwardWhether unused days roll into the next year, and the Max Carry Forward Days cap.
EncashmentWhether leftover days can be cashed out, the Encashment Basis, and the rate (see Encashment).
Negative BalanceWhether employees may go below zero, and by how many days.
Applicable GenderRestrict a type to all, male, or female employees.
Min Service MonthsHold the type until an employee reaches a tenure.
Employment TypesRestrict a type to the employment types you tick, at allocation and when employees apply. None ticked means every employment type.
Pro-rata for New JoinersScale the quota down for staff who joined mid-year.
Requires Document After (days)Force an attachment when a request exceeds this length (0 = never).
Accrual MethodHow the quota becomes available: Annual releases it all at once; Monthly releases it gradually (one-twelfth per completed month of service). Quarterly is also selectable.

Sandwich rules​

Sandwich rules make non-working days (weekends, week-offs, public holidays) count against leave in some cases:

  • Between — off-days that fall between two leave days count as leave (e.g. a Friday + Monday request consumes the weekend too).
  • Adjacent — off-days immediately next to a leave day count as leave. The Adjacent Scope picks Immediate (one day per side) or All (chains through every connected off-day and adjacent holiday).
note

Without any sandwich rule, requests only consume actual working days — weekends and holidays inside the range are skipped automatically.

Leave groups​

Not every employee gets every policy. A leave group bundles the policies that apply to a category of staff (office staff, drivers, residential workers…), and that bundle is what an employee actually draws from.

On Leave Groups, create a group, then tick the policies it contains. Groups are grouped by accrual mode (Annual Quota vs Cyclic Accrual) to make selection clearer.

How a group reaches an employee, in order of priority:

  1. Direct assignment — a group set on the employee record.
  2. Shift default — the default leave group on the employee's active shift.
  3. Company default — the group flagged Default group, used as a workspace-wide fallback.

An employee is only allocated (and can only apply for) policies that belong to their single resolved group. A group that is still assigned to employees or shifts cannot be deleted — reassign them first.

Allocating leave​

Allocation writes each employee's starting balance for a fiscal year. Open Allocations, pick the fiscal year, and select Allocate for All Employees.

What allocation does:

  • Grants each eligible employee the quota from every annual-quota policy in their leave group.
  • Applies pro-rata for anyone who joined mid-year (when the policy allows it).
  • Carries forward last year's leftover balance, capped by the policy's carry-forward limit.
  • Skips employees who fail a policy's gender, tenure, or employment-type conditions.
  • Never duplicates an allocation that already exists for the selected year.

You can also allocate a single employee via the API, but the page handles the common "run it for everyone" case.

tip

When your fiscal year rolls over automatically (see Company Setup → Fiscal Years), the new year's allocation — including carry-forward from the year that just closed — runs the same night. A daily job also fills any current fiscal year that has no allocations yet, and catches up at platform start, so allocation self-heals regardless of when your year starts. The manual Allocate for All Employees button remains for immediate reruns.

Balances​

Leave Balances shows what each employee has left. Search for the employee and pick the fiscal year (the current year is selected to start with). The balance for a type is:

balance = accrued + carried forward − used − encashed
  • Accrued is the amount available so far. For annual accrual that equals the full allocation; for monthly accrual it grows month by month.
  • Used rises when a request is approved; encashed rises when days are cashed out.
  • For a type that accrues monthly or quarterly, the card shows Accrued so far with the year's allocation beside it ("15 of 20 this year") in place of Allocated, so the figures on the card add up to the balance.

Employees see their own balances in the portal; admins with view access see everyone's.

Applications and approvals​

Applying​

Employees apply from the portal (/portal/leaves/apply). A request captures the leave type, from/to dates, an optional half-day, a reason, and an optional attachment. When submitted, the system checks that:

  • the type is active and the dates fall inside the current fiscal year;
  • the employee meets the policy's gender, tenure, employment-type, and leave-group conditions;
  • the range contains working days, and does not exceed the max consecutive limit;
  • there is enough balance (unless the policy permits a negative balance within its limit);
  • the dates don't overlap an existing pending or approved request;
  • an attachment is present if the length triggers the document requirement;
  • the dates do not fall in a hard blackout period (see below).

The number of days is calculated from working days in the range, adjusted for any sandwich rule.

Blackout periods​

Leave → Blackout Periods (/admin/leave/blackouts) holds the dates when leave is discouraged or refused: a product launch week, the audit, the festival rush. A period has a name, from and to dates, an optional reason shown to employees, the departments it applies to (none means everyone) and the leave types (none means every type). Its effect is one of two:

  • Refuse applications on: an application for those dates is refused with the period's name and reason. A hard period.
  • Off: the application goes through, and the approver sees a Blackout note with the period's name and reason on the pending queue and in the Approvals inbox. A soft period.

Employees see the periods ahead that apply to them at the top of the apply form, each marked leave is refused or flagged to the approver. A period can be deactivated and kept for next year. Blackouts bear on applications only: an allocation request or an encashment is never blocked.

Allocation requests​

An employee who has no allocation for a type (an on request type), or needs more of an annual one, can ask from My Leaves → Request allocation: the type, the days (hours for an hourly type), a reason. The request travels the approvals engine as subject Leave allocation; the seeded default flow is the reporting manager, provided they hold Approve Leave, then anyone holding Allocate Leave (for the whole workspace with View All Leaves, otherwise for their own direct reports). When it is approved, the days are added to the employee's allocation for the current fiscal year, the balance grows, and an ordinary application can follow. HR reviews the queue at Leave → Allocation Requests (/admin/leave/allocation-requests) or in the Approvals inbox; a reporting manager with Approve Leave alone sees their direct reports' requests there. One pending request per type at a time; the employee can withdraw a pending one.

Who may decide a request:

  • With an approval flow (the default, once flows are seeded), the flow's steps say. In the seeded flow the reporting manager's approval passes the request on, and someone holding Allocate Leave gives the final yes; a refusal at either step ends it. A reporting manager whose role does not hold Approve Leave is passed over, and the request waits on Allocate Leave straight away. A manager who also holds Allocate Leave grants the days in one action on the Allocation Requests page.
  • With no flow for the subject, the decision made on the Allocation Requests page is final, so approving needs Allocate Leave: it adds days to a balance. Someone with Approve Leave alone can still refuse a direct report's request, and is told which permission approving needs.
  • Nobody decides their own request, from this page or from the Approvals inbox, whatever they hold. Unlike leave itself there is no exception for a workspace with a single approver: the request waits for someone else.

Two people deciding the same request at once cannot both succeed: the second is told the request is no longer pending, and the days are added once.

The time-off officer​

Some workspaces route leave to a person who is not the reporting manager: an office manager, a team coordinator. Set Time-off officer on the employee's record (Employment details), then use the Time-off officer approver type in a leave flow's step. An employee with none set skips that step, as a missing manager would. The officer is used only where a flow says so; the default leave flow is unchanged.

Reviewing​

New requests arrive as Pending. The employee's reporting manager is emailed. If the employee has no reporting manager (or theirs has left or has no email address), the email goes instead to the users who can approve leave for everyone: those holding both Approve Leave and View All Leaves, usually HR and admins. Any reviewer with the approve permission can act on the queue at Pending Approvals (/admin/leave/pending):

  • Approve — marks the request approved, deducts the days from the balance, and marks those dates as on leave on the attendance record. The employee is emailed.
  • Reject — requires a reason, which is emailed to the employee.

You can't approve or reject your own leave while another approver can decide it. In a workspace with only one approver, that person can still decide their own.

A request is decided once. If two reviewers act on the same request at the same moment, the first decision stands and the second reviewer is told it has just been decided or cancelled: the days leave the balance once, and a rejection cannot overwrite an approval.

The leave approval queue

What the queue holds depends on the reviewer. Someone who also has View All Leaves (HR and admins) sees every pending request in the workspace. Someone who can approve but not view all leaves (the Department Head role, for example) sees, approves and rejects only the requests of the employees who report to them.

Who decides, and in what order, is the leave approval flow (see Approval flows). The default flow is exactly the rule above: one step, anyone holding Approve Leave, company-wide with View All Leaves and team-only without it. A workspace can add custom flows — leave over five days also goes to HR, say — and approvers can decide from the portal's cross-module Approvals inbox as well as from this page.

Managers can also watch their own team's requests through the team view, and Leave Applications (/admin/leave/applications) lists every request with status filters, search, CSV export, and a printable register.

Cancelling​

An employee can cancel a request that is still pending, or an approved request whose start date is still in the future. Cancelling an approved leave restores the balance and clears the attendance marks; the employee is notified.

A cancellation that crosses a decision is refused rather than half applied: if the request was approved in the moment the employee pressed Cancel, they are told it has just been decided, and can cancel the now-approved leave, which gives the days back.

Leave calendar​

Leave Calendar (/admin/leave/calendar) shows approved leave across the whole workspace on a month grid. Each employee-on-leave appears as a colored dot (using the leave type's color) on the days they're away — a quick way to spot coverage gaps before approving more requests.

Encashment​

If a policy allows encashment, unused days can be paid out. The policy's Encashment Basis says how a day is priced:

  • Days of basic pay: the rate is a multiple of the employee's daily basic pay, which is their monthly basic ÷ 30. A rate of 1 pays one day's basic for each encashed day, and 1.5 pays a day and a half. Each employee is paid at their own salary. The monthly basic is the one payroll pays: what the salary structure's Basic component gives on the employee's gross, from the salary in force (today on this page, the last working day in a final settlement). Editing the structure changes it, as it changes the next payroll run.
  • Fixed amount per day: the rate is an amount in your workspace currency, the same for every employee.
payout = days × the per-day figure

Open Encashment (/admin/leave/encashment) and choose an employee. Only leave types whose policy allows encashment appear, with the balance, the per-day figure and the total. The balance is the one Leave Balances shows: for a type that accrues monthly or quarterly, only the days accrued so far can be encashed. Select Process Encashment on a type to cash out its whole balance; the encashed days are deducted from the balance.

An hourly type is paid by the day too. Its balance is shown in hours with the days it is paid as beside it ("32 hours · paid as 4 days, at 8 hours a day"), the payout is those days times the per-day figure, and the hours are what leave the balance. A final settlement prices an hourly balance the same way, as of the last working day.

Process Encashment records the encashment and shows the amount. It does not add the amount to a payroll run: pay it through a payroll adjustment.

A type cannot be processed, and says why, when its policy has no rate, or when it is priced in days of basic pay and the employee's salary structure gives no basic pay (it has no Basic component).

Who can do what​

Access to leave features is governed by permissions (see /docs/workspace/access-control):

PermissionGrants
leave.view_ownSee your own balances, applications, and team requests.
leave.view_allView all applications, balances, the calendar, and groups.
leave.applyApply for and cancel your own leave.
leave.approveReview the pending queue and approve or reject requests.
leave.configureManage types, policies, groups, allocations, blackout periods, and encashment.
leave.allocateGive the final yes on an allocation request: the second step of the default flow, and the only permission that approves one where no flow applies.
approvals.configureChange the approval flow leave applications travel (see Approval flows).

Leave liability​

Reports → Leave → Liability is what the workspace owes in untaken paid leave: for each employee and paid leave type, the balance in days times the employee's daily basic pay (monthly BASIC over thirty, the rate encashment uses). An hourly type's balance is shown and valued in days, its hours over the employee's standard hours per day (see Hourly leave). An employee with no salary assigned, or a structure with no BASIC, shows a zero rate and the balance, so the gap is visible rather than silently priced at nothing.

A job takes the snapshot once a day, from 02:00 workspace time: if that hour is missed (a deploy, or the night the clocks go forward and 02:00 never comes) the next hour takes it instead. Snapshot now replaces today's without waiting. The tab reads the latest snapshot on or before the date you pick, with totals by type and a CSV, and names the date of the snapshot it read.

Every night's snapshot is kept for about two months (62 days). Older than that, only the last snapshot of each month is kept, so a month end stays a plain date for as long as you need it, while a mid-month date from last spring reads the month end before it.

Email notifications​

The module sends automatic emails at each step — a request notice to the manager, and approval, rejection, or cancellation notices to the employee. You can review and customize the wording under your workspace's email templates.