Appearance
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.
| Field | Label | Type | Rules |
|---|---|---|---|
user | user | link → core.user | required; unique |
college | college | link → core.college | |
employee_code | employee code | text | required; unique |
first_name | first name | text | required; personal data |
last_name | last name | text | personal data |
work_email | work email | unique; personal data | |
personal_email | personal email | personal data | |
mobile | mobile | phone | personal data |
personal_phone | personal phone | phone | personal data |
date_of_birth | date of birth | date | personal data |
gender | gender | select | personal data; one of: Male, Female, Other |
blood_group | blood group | select | personal data; one of: A+, A-, B+, B-, AB+, AB-, O+, O- |
employment_type | employment type | select | one of: Employee, Contractor; default "Employee" |
designation | designation | link → hrms.designation | |
department | department | link → hrms.department | |
reporting_manager | reporting manager | link → hrms.employee | |
is_manager | is manager | check | default false |
joining_date | joining date | date | |
annual_ctc | annual ctc | money | |
work_location | work location | text | |
resident_of_india | resident of india | check | default true |
weekend_off | weekend off | check | default false |
permanent_address | permanent address | longtext | personal data |
current_address | current address | longtext | personal data |
emergency_contact_name | emergency contact name | text | personal data |
emergency_contact_phone | emergency contact phone | phone | personal data |
pan | pan | text | personal data; max 10 characters |
aadhaar | aadhaar | text | personal data; max 12 characters |
photo | photo | image | personal data |
status | status | select | one of: Active, Inactive; default "Active" |
Permissions
| Role | Can |
|---|---|
hrms:admin | read, create, update, delete |
hrms:payroll | read, update |
hrms:manager | read |
hrms:employee | read, 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