Leave recall

What Leave Recall Does

Organisations sometimes need staff to return early from approved leave — for example to cover critical work. Leave recall shortens an approved leave request by setting a new last day on leave. Unused days are restored to the employee’s leave balance. The request stays APPROVED so attendance, holiday calendars, and ongoing leave checks continue to use the updated date range.

Recall is different from cancel:

Action	Effect on leave	Balance
Cancel	Voids the whole request (CANCELLED)	Restores all charged days
Recall	Keeps leave through a new end date (APPROVED)	Restores only unused days

Who Can Recall Leave

• HR, managers, and admin users with permission to run the recall consequence on hcm.LeaveRequest.
• In the HCM app, the Recall Leave action appears on the leave request detail page for staff and admin users when the leave is approved, not a half-day request, and the current end date is still in the future.

Employees cannot recall their own leave from self-service.

Prerequisites

1. Leave types, balances, and approval rules are configured under /settings/leave.
2. The leave request is approved.
3. The leave still has remaining days after today (end date in the future).
4. The request is not a half-day leave — cancel half-day leave instead of recalling it.

How To Recall Leave In HCM

1. Open the leave request from Leave → My Requests, the employee Leave tab, or a direct link.
2. Confirm status is Approved and review the current start date, end date, and days charged.
3. Choose Recall Leave.
4. Enter the new last day on leave (inclusive). This must be on or after the start date and before the current end date.
5. Enter a reason for recall.
6. Confirm. Antly:
   • Sets endDate to the new last day on leave
   • Recomputes daysRequested using the leave type’s calculation method
   • Restores unused days on the linked leave balance (usedBalance decreases)
   • Stores audit fields: original end date, original days, recalled at/by, and reason
7. Check the detail page shows a Recalled badge, the shortened period, and updated balance figures.
8. Confirm the holiday calendar and attendance expected set no longer treat the employee as on leave after the new end date.

Balance And Calendar Effects

• Only the difference between the previous and new day counts is restored.
• Subsequent recalls are allowed if the leave can still be shortened further. The first original end date and original days remain for audit.
• Attendance and holiday calendar logic already exclude employees with APPROVED leave where startDate ≤ date ≤ endDate. Shortening endDate returns the employee to expected attendance for later dates automatically.

When To Cancel Instead

• The employee should take no remaining leave days.
• The leave is still pending.
• The leave is a half-day request.
• You would otherwise set an end date that leaves zero days.

Automation And API

• Event: hcm.LeaveRequest:recall
• Consequence: recall on hcm.LeaveRequest (payload: endDate, recallReason)
• Workflow action label: recall leave

Example consequence payload:

See /modules/hcm-data-automation for workflow recipes and /reference/hcm for namespace details.

Related Pages

• Working guide: /modules/hcm-working (Flow 2 leave operations)
• Setup: /modules/hcm-setup
• Data and automation: /modules/hcm-data-automation
• Reference: /reference/hcm