LEDGERS icon

LEDGERS

Interact with LEDGERS API
Join our community

Actions34

Overview

This node interacts with an HRMS (Human Resource Management System) API focused on Indian operations to retrieve employee data. Specifically, the "Get All Employees" operation fetches a list of employees with support for pagination, filtering, and sorting. This is useful in scenarios where you need to integrate employee information into workflows, such as generating reports, syncing employee data with other systems, or automating attendance and status monitoring.

Practical examples:

  • Fetching all active employees who are currently present for daily attendance tracking.
  • Retrieving a paginated list of employees sorted by name or ID for display in dashboards.
  • Searching employees by name with filters on their status (active/inactive) and attendance.

Properties

Name Meaning
Limit Number of employees to return per request (pagination limit).
Filters Collection of optional filters to refine the employee list:
- Attendance Status Filter employees by attendance status: Present (1) or Absent (0).
- Search Term Search employees by name using a text query.
- Sort By Sort order of the results: Ascending or Descending.
- Sort By Field Field to sort by: Employee Name or Employee ID.
- Status Filter employees by employment status: Active (1) or Inactive (0).

Output

The output JSON contains an array of employee objects matching the specified filters and pagination. Each employee object typically includes fields such as employee name, employee ID, attendance status, and employment status. The exact structure depends on the API response but generally provides comprehensive employee details suitable for further processing or display.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential and authentication token to access the HRMS API.
  • The node performs an authenticated login request to obtain an API token before fetching employee data.
  • The API URL endpoint must be configured correctly in the node credentials.
  • Network connectivity to the HRMS API service is required.

Troubleshooting

  • Authentication failures: If the node throws errors related to authentication, verify that the API key credential and login credentials (email/password) are correct and have sufficient permissions.
  • Empty or unexpected responses: Ensure that the filter parameters are valid and that the API endpoint is reachable. Incorrect filter values or network issues may result in empty data arrays.
  • Pagination limits: Setting very high limits might cause performance issues or API rate limiting; use reasonable pagination sizes.
  • Sorting or filtering errors: Using unsupported sort fields or invalid filter values may cause the API to reject the request or return errors.

Links and References

  • Refer to your HRMS API documentation for detailed information about employee data fields and supported filters.
  • Consult n8n documentation on how to configure API credentials and handle pagination in custom nodes.

Discussion