EmployeeSetting Resource
In Users Module
Per-employee settings such as annual vacation allotment (num_annual_vacation_days), pay defaults,
and employment preferences. Use mine for the current user (includes user_id). Vacation usage and
scheduled time off live on ScheduleEvent; company vacation year reset on CompanySetting.
Endpoints
| Endpoints |
URI |
Access Control |
Description |
| save |
POST /api/EmployeeSetting/save |
Admin or Module WRITE |
|
| mine |
GET /api/EmployeeSetting/mine |
Endpoint level permissions |
|
| find |
GET /api/EmployeeSetting/find |
Admin or Module READ |
|
| get |
GET /api/EmployeeSetting/get |
Admin or Module READ |
|
| save-batch |
POST /api/EmployeeSetting/save-batch |
Admin or Module WRITE |
|
| delete |
POST /api/EmployeeSetting/delete |
Admin or Module WRITE |
|
Properties
| Property |
Type |
Description |
id |
number |
|
user_id |
number |
|
classification_id |
number |
|
is_service_tech |
boolean |
|
is_salary |
boolean |
|
employee_num |
string |
|
notifications_json |
string |
Per-employee notification preference overrides as JSON (which alert types are enabled for this user).
|
num_annual_vacation_days |
number |
|
color_hex |
string |
|
reply_to_account_email |
boolean |
|
qbo_employee_id |
number |
|
hire_date |
date |
|
Settings
| Setting |
|
Pagination Limit (when page parameter is set) |
None |
| Default Sort Order |
By insertion order
|
Relationships
| Related Resource |
Key |
Relationship to EmployeeSetting |
Property |
| User |
user_id |
Belongs To |
User |
