Leave
Explains leave request creation, preview, approval queue, balances, calendar, cancellation, and admin balance adjustments.
Workflow
- RequestEmployee / HR: Choose employee, leave type, dates, day portion, reason, and attachment.
- PreviewSystem: Calculate days, holidays, balance, paid/unpaid impact, and over-quota state.
- ApproveManager / Admin: Approve, reject, cancel, or adjust with reviewer notes.
- Use downstreamPayroll / Reports: Include approved leave in payroll, reports, portal, and calendars.
| Stage | Actor | Action | Result |
|---|---|---|---|
| Request | Employee / HR | Choose employee, leave type, dates, day portion, reason, and attachment. | The request is ready for preview/review. |
| Preview | System | Calculate days, holidays, balance, paid/unpaid impact, and over-quota state. | Reviewer sees the effect before approval. |
| Approve | Manager / Admin | Approve, reject, cancel, or adjust with reviewer notes. | Calendar and balances update. |
| Use downstream | Payroll / Reports | Include approved leave in payroll, reports, portal, and calendars. | Leave impact is visible across modules. |
Essential fields
Employee / Admin / HR
Leave request form
Creates a leave request and checks the impact before approval.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Employee | Person taking leave. | Ali Ahmed |
Admin form requires this; portal uses current user. |
| Leave type | Category of leave. | Annual Leave |
Required. |
| Start / end date | Leave period. | 2026-06-20 to 2026-06-21 |
Required. |
| Day portion | Full day or half day. | full_day |
Depends on leave type policy. |
| Reason | Why leave is needed. | Family commitment |
Required for review. |
| Attachment | Supporting file. | medical-note.pdf |
Required for some leave types. |
| Preview | Shows expected days and balance effect. | 2 days |
Check before submit. |
Essential fields
Admin / Manager
Leave review form
Approves, rejects, or cancels pending leave requests.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Request | Leave item being reviewed. | Sara sick leave |
Read dates and type carefully. |
| Reviewer notes | Decision explanation. | Approved with attachment |
Required for audit clarity. |
| Decision | Approve, reject, or cancel. | Approve |
Only approved leave affects final calendars/balances. |
Essential fields
Admin / HR
Leave balance adjustment form
Manually corrects employee leave balances when policy or migration requires it.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Employee | Person whose balance changes. | Ali Ahmed |
Required. |
| Leave type | Balance category. | Annual Leave |
Required. |
| Reason | Why HR is adjusting. | Opening balance correction |
Required for audit. |
| Effective date | When adjustment applies. | 2026-06-01 |
Recommended. |
Essential table
Database listing
Leave requests and queue tables
Shows requests, status, dates, attachments, review state, and action buttons.
Filters: Search, Status, Type, Date, Employee
| Column | What it means | Where it comes from | Example interpretation |
|---|---|---|---|
| Employee | Who requested leave. | leave_requests.employee. | Sara Khan. |
| Type | Leave category. | leave_types relationship. | Sick Leave. |
| Dates | Start, end, and portion. | request date fields. | 1 full day. |
| Days | Calculated balance impact. | preview/service calculation. | 0.5 for half-day. |
| Attachment | Whether proof exists. | attachment_path. | Required for sick leave. |
| Reviewer | Who handled it. | reviewer_id. | Ayesha Manager. |
Available actions
- Open or edit the record when permission allows it.
- Filter the list without losing the current page context.
- Use status badges to decide which item needs attention first.
Essential table
Database listing
Leave balances and calendar tables
Explains available days and calendar display.
Filters: Employee, Type, Year, Status
| Column | What it means | Where it comes from | Example interpretation |
|---|---|---|---|
| Employee | Balance owner. | employee relationship. | Ali Ahmed. |
| Leave type | Balance category. | leave_types. | Annual Leave. |
| Entitled | Total allowance. | policy or adjustments. | 18 days. |
| Used / pending | Approved and waiting requests. | leave_requests. | Used 4, pending 2. |
| Available | Days left after approved/pending logic. | computed balance. | 12 available. |
| Status | Current workflow state for the row. | The record status field or computed workflow state. | Pending means someone still needs to act. |
Available actions
- Open or edit the record when permission allows it.
- Filter the list without losing the current page context.
- Use status badges to decide which item needs attention first.
Full field appendix
Main docs show essential fields only. Open Documentation Coverage for every detected source field, action, column, route hint, controller hint, and test hint.