Skip to content

Employee ​

hrms.employee · every change is kept in the audit log · numbered {employee_code}

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
useruserlink → core.userrequired; unique
collegecollegelink → core.college
employee_codeemployee codetextrequired; unique
first_namefirst nametextrequired; personal data
last_namelast nametextpersonal data
work_emailwork emailemailunique; personal data
personal_emailpersonal emailemailpersonal data
mobilemobilephonepersonal data
personal_phonepersonal phonephonepersonal data
date_of_birthdate of birthdatepersonal data
gendergenderselectpersonal data; one of: Male, Female, Other
blood_groupblood groupselectpersonal data; one of: A+, A-, B+, B-, AB+, AB-, O+, O-
employment_typeemployment typeselectone of: Employee, Contractor; default "Employee"
designationdesignationlink → hrms.designation
departmentdepartmentlink → hrms.department
reporting_managerreporting managerlink → hrms.employee
is_manageris managercheckdefault false
joining_datejoining datedate
annual_ctcannual ctcmoney
work_locationwork locationtext
resident_of_indiaresident of indiacheckdefault true
weekend_offweekend offcheckdefault false
permanent_addresspermanent addresslongtextpersonal data
current_addresscurrent addresslongtextpersonal data
emergency_contact_nameemergency contact nametextpersonal data
emergency_contact_phoneemergency contact phonephonepersonal data
panpantextpersonal data; max 10 characters
aadhaaraadhaartextpersonal data; max 12 characters
photophotoimagepersonal data
statusstatusselectone of: Active, Inactive; default "Active"

Permissions ​

RoleCan
hrms:adminread, create, update, delete
hrms:payrollread, update
hrms:managerread
hrms:employeeread, update — only own rows (via user)

API ​

http
GET    /api/hrms/employee?<field>=<value>&limit=100&offset=0
POST   /api/hrms/employee
GET    /api/hrms/employee/:id
PATCH  /api/hrms/employee/:id
DELETE /api/hrms/employee/:id

Edulab Bench developer documentation