Zoho People icon

Zoho People

Consume Zoho People API

Leave → Get Encashment Report

AI-generated

Summary

Retrieve leave encashment reports from Zoho People for a specified pay period, optionally filtered by employees and paginated.

Inputs

  • Pay Period Setting ID (required) — ID of the pay period setting which the pay cycle falls in.
  • From Date (required) — Start date of the pay cycle, formatted as a string (e.g. '01-Jan-2024').
  • To Date (required) — End date of the pay cycle, formatted as a string (e.g. '31-Jan-2024').
  • Employee (JSON Array) — Optional JSON array of employee identifiers (Email ID, Employee ID, or Erec No) to filter the report, with a maximum of 30 employees.
  • Unit — Optional unit of the report, either 'Day' or 'Hour'. Defaults to 'Day'.
  • Start Index — Optional zero-based index to start fetching employee encashment reports from, used for pagination.
  • Limit — Optional maximum number of results to return. Defaults to 30.

Output shape

A JSON array where each element represents an employee's leave encashment report data for the specified pay period.

The results can be paginated through 'Start Index' and 'Limit' parameters. Filtering by specific employees via the 'Employee (JSON Array)' input is supported.

Discussion