Appearance
API
All endpoints are on the university's own address, e.g. https://<university>.<platform domain>, and need a logged-in user. Each call only returns and changes what the user's roles allow (roles).
| Entity | Endpoint |
|---|---|
| Event / Announcement | /api/hrms/announcement |
| Attendance | /api/hrms/attendance |
| Bank Account | /api/hrms/bank_account |
| Biometric Device | /api/hrms/biometric_device |
| Department | /api/hrms/department |
| Designation | /api/hrms/designation |
| Employee | /api/hrms/employee |
| Employee Document | /api/hrms/employee_document |
| Holiday | /api/hrms/holiday |
| Leave Balance | /api/hrms/leave_allocation |
| Leave Application | /api/hrms/leave_application |
| Leave Day | /api/hrms/leave_application_day |
| Leave Type | /api/hrms/leave_type |
| Letter Template | /api/hrms/letter_template |
| Employee Loan | /api/hrms/loan |
| Payroll Run | /api/hrms/payroll_run |
| Payslip | /api/hrms/payslip |
| Payslip Line | /api/hrms/payslip_line |
| Payslip Request | /api/hrms/payslip_request |
| HR Policy | /api/hrms/policy |
| Reimbursement Claim | /api/hrms/reimbursement |
| Resignation | /api/hrms/resignation |
| Salary Advance | /api/hrms/salary_advance |
| Salary Component | /api/hrms/salary_component |
| Salary Structure | /api/hrms/salary_structure |
| Attendance Star Reward | /api/hrms/star_reward |
Events
| Direction | Event |
|---|---|
| emits | hrms.employee.created |
| emits | hrms.employee.deactivated |
| emits | hrms.leave.applied |
| emits | hrms.leave.approved |
| emits | hrms.leave.rejected |
| emits | hrms.attendance.marked |
| emits | hrms.payroll.finalised |
| emits | hrms.payslip.generated |
| emits | hrms.resignation.approved |
| listens to | recruitment.candidate.selected |
Settings
Each university sets these from its admin screen.
| Setting | Type | Default | Label |
|---|---|---|---|
pfPercent | number | 12 | Provident Fund (% of basic) |
ptMonthly | number | 200 | Professional tax per month (rupees) |
ptFebruary | number | 300 | Professional tax for February (rupees) |
payrollDay | number | 1 | Day of month salary is paid |
attendanceCycleFromDay | number | 26 | Attendance cycle starts on day |
attendanceCycleToDay | number | 25 | Attendance cycle ends on day |
earnedLeaveYearlyCredit | number | 15 | Earned leave credited on 1 January (days) |
earnedLeaveCap | number | 45 | Maximum earned leave balance (days) |
autoCheckoutTime | text | "23:50" | Auto check-out time for open attendance |
lateCheckInReminderTime | text | "12:01" | Reminder to staff not checked in by |
workingSaturdays | text | "All" | Working Saturdays (All, None, or e.g. 1,3,5) |
attendanceStarRewards | check | false | Reward regular attendance with stars and bonus leave |
biometricAttendance | check | false | Accept attendance from biometric devices |