Update Employee

put

https://in-api.ledgers.cloud/v3/hr/employee

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

Body Params

name

string

required

Employee name

branch

int32

required

Branch of an employee for PT calculation

doj

date

required

Date of joining of an employee

personal_mobile

int32

required

Personal mobile number of an employee to do checkin and checkout

employee_id

string

Employee Identification number(Alphanumeric)

designation

string

Designation of an employee(Alphanumeric)

department

string

Employee Department

personal_email

string

Personal email id of an employee

office_email

string

required

Official email id of an employee

pan

string

pan number of an employee

employee_status

string

enum

required

Status of an employee

office_mobile

int32

The official mobile number associated with the employee

reporting_to

string

The person to whom the employee directly reports

father_name

string

The name of the employee's father.

employment_type

string

enum

The type of employment.

Allowed:

dob

string

required

Date of birth of the employee

blood_group

string

The blood group of the employee.

marital_status

string

enum

The marital status of the employee.

Allowed:

emergency_contact

int32

Emergency contact number for the employee

gender

string

enum

required

Gender of the employee.

Allowed:

aadhar

int32

Aadhar number of an employee

religion

string

The religion of the employee.

employee_account_name

string

Name associated with the employee's bank account.

employee_account_number

int32

Bank account number of the employee.

employee_bank_branch

string

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

employee_bank_name

string

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

employee_ifsc_code

string

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

employee_account_type

string

enum

The type of bank account.

Allowed:

uan_number

int64

Universal Account Number.

esi_number

int64

Employee State Insurance (ESI) number.

present_address

array of objects

Present residential address details, including city, state, country, pincode, and address lines.

present_address

permanent_address

array of objects

Permanent residential address details, including city, state, country, pincode, and address lines.

permanent_address

shift

date-time

Shift Timing of an employee

dateofexit

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_description

string

required

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

gid

string

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.

Headers

api-token

string

generate token from authentication api

x-api-key

string

Defaults to xyz

This will shared while register

Responses

200200

401401

500500

502502

503503