📡 API Reference
Employee Sub-Resource Endpoints
API endpoints for employee awards, levels, settings, statistics, and recurring expenses.
Employee Awards
Base Path: /api/employee-award
GET /api/employee-award # List awards
GET /api/employee-award/:id # Get award
POST /api/employee-award # Create award
PUT /api/employee-award/:id # Update award
DELETE /api/employee-award/:id # Delete awardCreate Body:
{
"name": "Employee of the Month",
"year": "2025",
"employeeId": "employee-uuid"
}Employee Levels
Base Path: /api/employee-level
GET /api/employee-level # List levels
POST /api/employee-level # Create level
PUT /api/employee-level/:id # Update level
DELETE /api/employee-level/:id # Delete levelCreate Body:
{
"level": "Senior",
"tag": [{ "id": "tag-uuid" }]
}Employee Settings
Base Path: /api/employee-setting
Per-employee configuration, such as time tracking preferences.
GET /api/employee-setting # List settings
GET /api/employee-setting/:id # Get setting
POST /api/employee-setting # Create setting
PUT /api/employee-setting/:id # Update setting
DELETE /api/employee-setting/:id # Delete settingEmployee Statistics
Base Path: /api/employee-statistics
Read-only aggregate statistics.
GET /api/employee-statistics/months
GET /api/employee-statistics/count
GET /api/employee-statistics/statisticsStatistics Response:
{
"totalWorkHours": 160.5,
"totalIncome": 8500,
"totalExpenses": 1200,
"totalBonuses": 500
}Employee Recurring Expenses
Base Path: /api/employee-recurring-expense
GET /api/employee-recurring-expense # List
GET /api/employee-recurring-expense/:id # Get by ID
POST /api/employee-recurring-expense # Create
PUT /api/employee-recurring-expense/:id # Update
DELETE /api/employee-recurring-expense/:id # Delete
GET /api/employee-recurring-expense/employee/:id # By employeeCreate Body:
{
"categoryName": "Insurance",
"value": 500,
"currency": "USD",
"startDate": "2025-01-01",
"employeeId": "employee-uuid"
}Employee Recent Visits
Base Path: /api/employee-recent-visit
Track recently visited entities for quick access.
GET /api/employee-recent-visit # List recent visits
POST /api/employee-recent-visit # Record visit
DELETE /api/employee-recent-visit/:id # Delete visitEmployee Notification Settings
Base Path: /api/employee-notification-setting
GET /api/employee-notification-setting # Get settings
POST /api/employee-notification-setting # Create settings
PUT /api/employee-notification-setting/:id # Update settingsRelated Pages
- Employee Endpoints — main employee API
- Employee Management — feature guide
- Employee Entities — DB schema