> ## Documentation Index
> Fetch the complete documentation index at: https://help-empuls.xoxoday.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Other HRMS (custom API)

> Custom API integration for HRMS

## **Introduction**

This document describes the process for integrating your native HRMS (via custom REST API) with Empuls for automating user data management.

## **Data Fields Required from HRMS**

The following data fields need to be shared for all employees in a JSON format.

Data Fields are provided below:

| **Column** | **Data Fields**        | **Required / Conditional** | **Data Type** | **Utility**                                                                                         |
| ---------- | ---------------------- | -------------------------- | ------------- | --------------------------------------------------------------------------------------------------- |
| **A**      | Employee ID            | Required                   | Varchar       | Identity of the user                                                                                |
| **B**      | Email                  | Required                   | Varchar       | Identity of the user                                                                                |
| **C**      | First Name             | Required                   | Varchar       | Identity of the user                                                                                |
| **D**      | Last Name              | Conditional                | Varchar       | Identity of the user                                                                                |
| **E**      | Department             | Conditional                | Varchar       | Set up rewarding/gifting rules                                                                      |
| **F**      | Department Head Email  | Conditional                | Varchar       | Set up rewarding/gifting rules                                                                      |
| **G**      | Designation            | Conditional                | Varchar       | Profile information visible to other users of the platform                                          |
| **H**      | Grade Name             | Conditional                | Varchar       | Set up rewarding/gifting rules                                                                      |
| **I**      | HR Email               | Conditional                | Varchar       | Individual Mapping for setting up rewarding rules                                                   |
| **J**      | Manager Email          | Conditional                | Varchar       | Individual Mapping for setting up rewarding rules, Org chart display and reports access to managers |
| **K**      | Cost Centre            | Conditional                | Varchar       | Set up rewarding/gifting rules                                                                      |
| **L**      | Cost Centre Head Email | Conditional                | Varchar       | Individual Mapping for setting up rewarding rules                                                   |
| **M**      | Business Unit          | Conditional                | Varchar       | Set up rewarding/gifting rules                                                                      |
| **N**      | Site / Location        | Conditional                | Varchar       | Set up rewarding/gifting rules                                                                      |
| **O**      | Joining Date           | Conditional                | Date          | Work Anniversary gifting & Public wishes on the milestone events.                                   |
| **P**      | Date Of Birth          | Conditional                | Date          | Birthday gifting and public wishes on the occasion                                                  |
| **Q**      | Contact No.            | Conditional                | Varchar       | Profile Information visible to other employees.                                                     |
| **R**      | Employee Status\*      | Required                   | Varchar       | Empuls access blocked to disabled accounts.                                                         |

Employee Status can be Active/Inactive.

The fields marked as conditional depend upon the modules available, the Rewards matrix, etc.

## **Integration Process**

1. Client to provide the API document details that are required to set up this integration.
2. Client should whitelist Xoxoday NAT IPs. Our NAT IPs are;

* 50.112.248.135
* 44.224.115.77
* 52.74.39.101
* 52.76.120.90

3. Empuls development team will then estimate the efforts and provide a dedicated timeline for the integration to go-live.
4. On the integration is set-up, the system will log the data sync status and notify the Super Admin of the status of the data update via email.

<Note>For any additional details please contact your account manager or reach out to us directly at [cs@xoxoday.com](mailto:cs@xoxoday.com).</Note>