Intranet leave

This page describes the leave sub-module in src/cluster_erp/modules/intranet/leave/. It keeps leave types, balances per employee, type, and year, and leave requests that move through submission and approval. Day counts are Decimal because half days are real; a submitted request reserves days as pending so that an employee cannot spend them twice (src/cluster_erp/modules/intranet/leave/services.py:1-7).

Scope and source¶

• Defined in: src/cluster_erp/modules/intranet/models.py (IntranetLeaveType, IntranetLeaveBalance, IntranetLeaveRequest), leave/services.py, leave/routes.py, leave/schemas.py, leave/metadata.py, and leave/seeds.py.
• Count: 3 tables, 15 routes in leave/routes.py, 4 ActionMeta entries in leave/metadata.py.

Fields¶

The module seeds eight leave types on start when their codes are missing: annual, sick, unpaid, marriage, bereavement, maternity, paternity, and administrative. The seed docstring calls them country-neutral starter data that the organisation edits (src/cluster_erp/modules/intranet/leave/seeds.py:1-12, src/cluster_erp/modules/intranet/module.py:66-95). A new balance row takes default_annual_days of its type as entitled and accrued (src/cluster_erp/modules/intranet/leave/services.py:202-233).

Statuses and actions¶

A request is draft, submitted, approved, rejected, cancelled, or taken (src/cluster_erp/modules/intranet/models.py:93-100).

stateDiagram-v2
 [*] --> draft
 draft --> submitted: submit
 submitted --> approved: approve
 submitted --> rejected: reject
 draft --> cancelled: cancel
 submitted --> cancelled: cancel
 approved --> cancelled: cancel

In prose: a request starts as a draft. Submit runs the checks, reserves the days, and routes the request to an approval chain when one exists. Approve moves the days from pending to taken; Reject releases them. Cancel works from draft, submitted, or approved and gives back pending or taken days (src/cluster_erp/modules/intranet/leave/services.py:55-60, src/cluster_erp/modules/intranet/leave/services.py:647-738). No transition writes taken (src/cluster_erp/modules/intranet/leave/services.py:55-60).

The route lets a caller act only on requests in their scope; Approve and Reject also need intranet_leave_request.approve (src/cluster_erp/modules/intranet/leave/routes.py:255-280). Approve and reject notify the employee with the i18n keys intranet.notif_leave_approved and intranet.notif_leave_rejected (src/cluster_erp/modules/intranet/leave/services.py:716-735).

Day counting¶

_leave_days returns the counted days per calendar year (src/cluster_erp/modules/intranet/leave/services.py:260-334):

• A type with counts_calendar_days counts every day.
• Other types ask GetCompanyDefaultTimezone for the company party and GetOwnerWorkingDays for its open days, so holidays and closures are not counted. When no calendar answers, Monday to Friday count.
• A half day at the start or end removes half a day from that day's year.
• A request across New Year charges each year its own share.

Submit checks¶

Submission runs these checks before any change (src/cluster_erp/modules/intranet/leave/services.py:468-551):

Creating a request also checks the type, the gender restriction, and overlap, and stores half days only when the type allows them (src/cluster_erp/modules/intranet/leave/services.py:570-620).

Approval chain¶

_route_approval asks GetApprovalChainForAction for the resource intranet_leave_request and action approve. With a chain it calls SubmitForApproval and stores the approval request id. Without a chain, or on an error, the request stays submitted for a manual decision (src/cluster_erp/modules/intranet/leave/services.py:740-772). See approvals and approval chains.

Routes¶

Creating a request for another person needs intranet_leave_request.read_all, and the named party must be an active employee (src/cluster_erp/modules/intranet/leave/routes.py:204-223).

Terms introduced¶

Related pages¶

• Intranet module
• Requests
• Working time
• Calendars module

Verified against commit 92f8051 on 2026-11-13.