ERPNext HRMS icon

ERPNext HRMS

Work with ERPNext/Frappe HRMS v15-v16 documents and methods

Leave Allocation → Get Many

AI-generated

Summary

Retrieve multiple Leave Allocation documents from ERPNext HRMS with optional filtering, field selection, ordering, and pagination control.

Inputs

  • API Version (required) — Select the Frappe REST API version (v1 or v2) to use for requests.
  • Fields — Specify fields to return as a comma-separated list or a JSON array string (e.g., name,employee_name,status). Defaults to ["name"].
  • Filters JSON — Provide filter criteria in Frappe filter JSON format, either as an array of conditions (e.g., [["status","=","Active"]]) or an object (e.g., {"employee":"HR-EMP-0001"}).
  • Return All — Boolean flag to fetch all matching documents (true) or limit the number of returned items (false). Defaults to false.
  • Limit — Maximum number of documents to return when Return All is false. Range: 1-1000, default is 50.
  • Order By — Sorting order of the results, specified as a string (e.g., "modified desc"). Default is "modified desc".

Output shape

a list of Leave Allocation documents as JSON objects

If Return All is true, paginates internally to retrieve up to 1000 documents at a time until no more remain. The output items include only the fields specified in the Fields parameter. Filters apply server-side constraints on returned records.

Links

Discussion