v1

latestOpenAPI 3.1.02026-08-045901.5 MB

Update Employee

This API functionality is used at the time of adding a new employee. This is used in add employee page of HR Ledgers

put/hr/employee

Headers

api-tokenstring

generate token from authentication api

x-api-keystring

Request body

namestring required

Employee name

branchinteger required

Branch of an employee for PT calculation

dojstring date required

Date of joining of an employee

personal_mobileinteger required

Personal mobile number of an employee to do checkin and checkout

employee_idstring

Employee Identification number(Alphanumeric)

designationstring

Designation of an employee(Alphanumeric)

departmentstring

Employee Department

personal_emailstring

Personal email id of an employee

office_emailstring required

Official email id of an employee

panstring

pan number of an employee

employee_status'inactive' | 'active' | 'absconded' | 'resigned' | 'terminated' | 'furloughed' | 'informed long leave' | 'uninformed absence' | 'discipline improvement plan' required

Status of an employee

office_mobileinteger

The official mobile number associated with the employee

reporting_tostring

The person to whom the employee directly reports

father_namestring

The name of the employee's father.

employment_type'Full Time' | 'Part Time' | 'Contractual' | 'Apprentice' | 'Intern'

The type of employment.

dobstring required

Date of birth of the employee

blood_groupstring

The blood group of the employee.

marital_status'Unmarried or Single' | 'Married' | 'Divorced' | 'Widowed' | 'Others'

The marital status of the employee.

emergency_contactinteger

Emergency contact number for the employee

gender'Male' | 'Female' | 'Others' required

Gender of the employee.

aadharinteger

Aadhar number of an employee

religionstring

The religion of the employee.

employee_account_namestring

Name associated with the employee's bank account.

employee_account_numberinteger

Bank account number of the employee.

employee_bank_branchstring

The branch of the bank where the employee holds an account.

employee_bank_namestring

The name of the bank where the employee holds an account.

employee_ifsc_codestring

IFSC (Indian Financial System Code) of the employee's bank.

employee_account_type'Please Select' | 'Current Account' | 'Savings Account'

The type of bank account.

uan_numberinteger

Universal Account Number.

esi_numberinteger

Employee State Insurance (ESI) number.

shiftstring date-time

Shift Timing of an employee

dateofexitstring date-time required

This field is mandatory when employee status is [inactive, absconded, resigned, terminated, furloughed, informed long leave, uninformed absence, discipline improvement plan]

exit_descriptionstring required

This field is mandatory when employee status is [inactive, absconded, resigned, terminated, furloughed, informed long leave, uninformed absence, discipline improvement plan]

gidstring required

Reference code of the employee. This is generated when the employee is added to the system and is used to link salary details with that employee.

Response

200

statusinteger
msgstring
datastring
statusCodestring

Example response

{
  "status": 1,
  "msg": "success",
  "data": "Updated Successfully",
  "statusCode": "200"
}