BusinessUnitPreference

Gets the list of preferences for the business unit.

Securitybearer
Request
path Parameters
id
required
string <uuid>

ID of the business unit that the preferences belong to.

Responses
get/api/v1/businessUnits/{id}/preferences
Request samples 
Response samples 
application/json
{
  • "defaultLaborRateSetId": "cd0aa29d-86fe-427e-8746-ead5d739cd65",
  • "defaultPayClassId": "da5d4157-0bc2-4364-8cad-72c5fc1b3a52",
  • "defaultEquipmentRateSetId": "626aecd6-1ccb-4be1-ae3e-d07d095f877d",
  • "startOfPayWeek": "tuesday",
  • "truckingCostTypeId": "d7041413-6554-4596-950f-ff96434ab163"
}
Updates preferences for the business unit.
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the business unit that the preferences belong to.


 
Request Body schema: 
required
The preferences to update for the business unit.


defaultLaborRateSetId
string or null <uuid> 
ID of the default labor rate set to apply to a new job.


 
defaultEquipmentRateSetId
string or null <uuid> 
ID of the default equipment rate set to apply to a new job.


 
startOfPayWeek
string (DayOfWeek) 
 Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"  
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


put/api/v1/businessUnits/{id}/preferences
Request samples 
{
  • "defaultLaborRateSetId": "cd0aa29d-86fe-427e-8746-ead5d739cd65",
  • "defaultEquipmentRateSetId": "626aecd6-1ccb-4be1-ae3e-d07d095f877d",
  • "startOfPayWeek": "tuesday"
}