Versions Compared

Version Old Version 3 New Version 4
Changes made by

T E Gautham

T E Gautham

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can generate the API key for your organization yourself.

1.2 Endpoint

https://www.hinote.in/hrworks/api/v1/addEmployeeAttendanceFileUpload.do?key=<customer_api_key>
You need to use https in your API call.

...

Input can be provided as a request parameter named inputData or as a request body. Input should comply with the output of the schema API. A typical example is as follows.

{
  "employeeId": "XYZ0001",
  "firstName": "Deepika Sharma",
  "dateOfBirth": "1995-03-01",
  "nationality": "Indian",
  "fatherName": "Anil Sharma",
  "maritalStatus": "Unmarried",
  "salutation": "Ms",
  "bloodGroup": "A Positive",
  "bankBranch": "Axis Bank/Chennai",
  "bankAccountNo": "111111111111",
  "nameInBankAccount": "Deepika A Sharma",
  "dateOfJoining": "2021-04-01",
  "pfJoinDate": "2021-04-01",
  "userId": "XYZ0001",
  "password": "0723$XYZ",
  "tpg": "CPG",
  "gender": "Female",
  "statutoryId": {
    "pan": "DHCPS2159K"
  },
  "designation": "Project Manager",
  "manager": "E0101",
  "employeeType": "PM",
  "status": "Employed",
  "division": "Application Development",
  "workLocation": "Chennai",
  "shift": "Shift 1",
  "contactAddress": [{
    "addressType": "Current Address",
    "addressLine1": "Adyar Main Road",
    "city": "Chennai",
    "state": "Tamilnadu",
    "country": "India",
    "postalCode": "600113",
    "isPrimary": true
  }],
  "contactEmail": [{
    "emailType": "email",
    "emailId": "deepika@xyzco.com",
    "isPrimary": true
  }],
     
  "other.ePS_Contribution": "Yes",
  "payPackage": {
    "fromDate": "2021-04-01",
    "action": "Add Full",
    "compensationDetails": {
      "basic": 30000,
      "hra": 10000,
      "employerPF": "Inherit"
    },
    "deductionDetails": {
      "otherDeduction": 800,
      "employeePF": "Inherit"
    }
  }
}

input. The data file should be an xls file (in MS Excel 97/2000/XP format) or in the CSV format. The template file for this can be downloaded from HRWorks application itself.

The template file contains the following columns:

  1. Employee Id: Employee Id as specified in HRWorks.
  2. Date: Date for which attendance is being uploaded. Should be Excel date value.
  3. In Time: Date and Time of the employee entry time. Should be Excel date time value.
  4. Out Time: Date and Time of the employee exit time. Should be Excel date time value.
  5. In Location: Should be left as blank. Created for future use.
  6. Out Location: Should be left as blank. Created for future use.
  7. Comments: Any relevant comments for the attendance entry. Can be left blank.

3. Response


If the Add Employee request API call is successful, the API shall return a response such as the below.

...

The data file should be an xls file (in MS Excel 97/2000/XP format) or in the CSV format. The template file for this can be downloaded from HRWorks application itself. The template file contains the following columns:

...