RateSetGroup

Returns a list of rate set groups.

Returns a list of rate set groups for the specified business unit code.

For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
businessUnitCode
required
string

The business unit code.

Example: businessUnitCode=MANAGER
type
string (RateSetGroupType)

The rate set group type. If not specified, all types will be returned.

Enum: "labor" "workersComp" "tmLabor" "salary" "equipment" "tmEquipment"
Example: type=labor
Responses
get/api/v1/RateSetGroup
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Creates a new rate set group.
Creates a new rate set group for the specified business unit.  Also
creates an associated rate set based on the type.  (e.g., creating
a labor rate set group will create a labor rate set within the group).
Code must be unique for the business unit.


For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
code
required
string
The code of the rate set group.


 
description
string or null
The description.


 
type
required
string (RateSetGroupType) 
 Enum: "labor" "workersComp" "tmLabor" "salary" "equipment" "tmEquipment"  
businessUnitCode
required
string
The business unit code.


 
Responses 
post/api/v1/RateSetGroup
Request samples 
{
  • "code": "code",
  • "description": "description",
  • "type": "labor",
  • "businessUnitCode": "manager"
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Updates an existing rate set group by its id.
For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
the rate set group id


 
Request Body schema: application/json
code
required
string
The code of the rate set group.


 
description
string or null
The description.


 
type
required
string (RateSetGroupType) 
 Enum: "labor" "workersComp" "tmLabor" "salary" "equipment" "tmEquipment"  
businessUnitCode
required
string
The business unit code.


 
Responses 
put/api/v1/RateSetGroup/{id}
Request samples 
application/json
{
  • "code": "code",
  • "description": "description",
  • "type": "labor",
  • "businessUnitCode": "manager"
}