Zoho PeopleInstall

Summary

Retrieve a booked and balance leave report for employees within a specified date range, optionally filtered by department, employee, employee status, leave type, and unit of time.

Inputs

• From Date (required) — Start date of the report period in string format (e.g., '01-Jan-2024').
• To Date (required) — End date of the report period in string format (e.g., '31-Dec-2024').
• Department (JSON Array) — Optional JSON array of up to 30 department IDs to filter the report.
• Employee (JSON Array) — Optional JSON array of up to 30 employee identifiers (Email ID, Employee ID, or Erec No) to filter the report.
• Employee Status (JSON Array) — Optional JSON array of employee statuses such as ACTIVE_USERS, ACTIVE_EMPLOYEE_PROFILES, EX_EMPLOYEES, LOGIN_DISABLED; defaults to ["ACTIVE_USERS"].
• Leave Type (JSON Array) — Optional JSON array of up to 30 leave type IDs to filter the report.
• Limit — Maximum number of results to return; default is 30.
• Start Index — Starting index from which to fetch the employee report; default is 0.
• Unit — Unit of the report values, either 'Day' or 'Hour'; default is 'Day'.

Output shape

a JSON array containing the leave report entries matching the specified filters and date range

The report supports pagination via 'Limit' and 'Start Index' parameters. Filters like department, employee, and leave type expect JSON arrays in string format. Employee Status defaults to ["ACTIVE_USERS"] if not specified.

Examples

Example 1: Fetch leave booked and balance report for January 2024 for active users in departments "dept1" and "dept2", limited to 50 results.

Set From Date to '01-Jan-2024', To Date to '31-Jan-2024', Additional Options include Department as '["dept1","dept2"]', Employee Status as '["ACTIVE_USERS"]', and Limit as 50.