RateSet

Returns a single employee rate set.

Returns a single employee rate set or null for the specified business unit and rate set group.

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
employeeRateSetGroupCode
required
string

The employee rate set group code.

Example: employeeRateSetGroupCode=RSGROUP1
Responses
get/api/v1/RateSet/Employee
Request samples 
Response samples 
application/json
{
  • "businessUnitCode": "manager",
  • "employeeRates": [
    ],
  • "effectiveDate": "2018-01-01T04:30:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "71098bb7-99d4-4333-b9a0-77114f7f2317"
}
Creates a new employee rate set.
Creates a new employee rate set, using its group code as a unique identifier on the specified business unit.


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


Securitybearer 
Request 
Request Body schema: application/json
Employee rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisEmployeeRate) 
Gets the employee rates.


 
effectiveDate
string or null <date-time> 
Gets the effective date.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to uniquely identify this rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate set.


 
Responses 
post/api/v1/RateSet/Employee
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "employeeRates": [
    ],
  • "effectiveDate": "2018-01-01T04:30:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "71098bb7-99d4-4333-b9a0-77114f7f2317"
}
Updates an existing employee rate set by its id.
If the rate set group code is null, the employee rates to be applied to all rate sets.


After the result of this operation, the server entity will match exactly what is sent here.  (i.e., excluded rates will be interpreted as "not needed" and deleted from the server)


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


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The employee rate set guid.


 
Request Body schema: application/json
The employee rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisEmployeeRate) 
Gets the employee rates.


 
effectiveDate
string or null <date-time> 
Gets the effective date.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to uniquely identify this rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate set.


 
Responses 
put/api/v1/RateSet/Employee/{id}
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "employeeRates": [
    ],
  • "effectiveDate": "2018-01-01T04:30:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "71098bb7-99d4-4333-b9a0-77114f7f2317"
}
Returns a single pay class rate set.
Returns a single pay class rate set or null for the specified business unit and rate set group.


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
payClassRateSetGroupCode
required
string
The pay class rate set group code.


 
 Example:  payClassRateSetGroupCode=RSGROUP1
Responses 
get/api/v1/RateSet/PayClass
Request samples 
Response samples 
application/json
{
  • "businessUnitCode": "manager",
  • "payClassRates": [
    ],
  • "effectiveDate": "2018-01-01T12:00:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "dfbe1430-547a-4c85-91c9-6bbec96a2859"
}
Creates a new pay class rate set.
Creates a new pay class rate set, using its group code as a unique identifier on the specified business unit.


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


Securitybearer 
Request 
Request Body schema: application/json
The pay class rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisPayClassRate) 
Gets the pay class rates.


 
effectiveDate
string or null <date-time> 
Gets the effective date.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to uniquely identify this rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate set.


 
Responses 
post/api/v1/RateSet/PayClass
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "payClassRates": [
    ],
  • "effectiveDate": "2018-01-01T12:00:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "dfbe1430-547a-4c85-91c9-6bbec96a2859"
}
Updates an existing pay class rate set by its id.
The payload has an outer wrapper and a list of pay class rates.  All
fields of the outer wrapper should be specified.


In list of rates, the pay class code is used as the primary key.
(i.e., id has no effect).


For pay classes that are specified in the payload, the server will
match exactly what is sent.  In other words, if fields are not
specified (e.g., taxPercent), they will be saved as 0, replacing
any existing data.


If a rate exists, but is not  provided in the payload, the existing
rate will remain as-is.


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


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The pay class rate set guid.


 
Request Body schema: application/json
Pay class rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisPayClassRate) 
Gets the pay class rates.


 
effectiveDate
string or null <date-time> 
Gets the effective date.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to uniquely identify this rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate set.


 
Responses 
put/api/v1/RateSet/PayClass/{id}
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "payClassRates": [
    ],
  • "effectiveDate": "2018-01-01T12:00:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "dfbe1430-547a-4c85-91c9-6bbec96a2859"
}
Returns a single equipment rate set.
Returns a single equipment rate set or null for the specified business unit and rate set group.


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
equipmentRateSetGroupCode
required
string
The equipment rate set group code.


 
 Example:  equipmentRateSetGroupCode=RSGROUP1
Responses 
get/api/v1/RateSet/Equipment
Request samples 
Response samples 
application/json
{
  • "businessUnitCode": "manager",
  • "equipmentRates": [
    ],
  • "effectiveDate": "2017-12-01T00:00:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "98437f72-839f-48f4-a9f9-6c96304d85f0"
}
Creates a new equipment rate set.
Creates a new equipment rate set, using its group code as a unique identifier on the specified business unit.


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


Securitybearer 
Request 
Request Body schema: application/json
The equipment rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisEquipmentRate) 
The underlying EquipmentRates


 
effectiveDate
string or null <date-time> 
The DateTime from which these equipment rates become effective.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to identify this particular rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate set.


 
Responses 
post/api/v1/RateSet/Equipment
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "equipmentRates": [
    ],
  • "effectiveDate": "2017-12-01T00:00:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "98437f72-839f-48f4-a9f9-6c96304d85f0"
}
Updates an existing equipment rate set by its id.
After the result of this operation, the server entity will match exactly what is sent here.  (i.e., excluded rates will be interpreted as "not needed" and deleted from the server)


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


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The equipment rate set guid.


 
Request Body schema: application/json
The equipment rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisEquipmentRate) 
The underlying EquipmentRates


 
effectiveDate
string or null <date-time> 
The DateTime from which these equipment rates become effective.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to identify this particular rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate set.


 
Responses 
put/api/v1/RateSet/Equipment/{id}
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "equipmentRates": [
    ],
  • "effectiveDate": "2017-12-01T00:00:00",
  • "rateSetGroupCode": "000-001-AB",
  • "rateSetGroupDescription": "Primary rate set",
  • "id": "98437f72-839f-48f4-a9f9-6c96304d85f0"
}
Returns a single cost adjustment rate set.
Returns a single cost adjustment rate set or null for the specified business unit and rate set group.


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
costAdjustmentRateSetGroupCode
required
string
The cost adjustment rate set group code.


 
 Example:  costAdjustmentRateSetGroupCode=RSGROUP1
Responses 
get/api/v1/RateSet/CostAdjustment
Request samples 
Response samples 
application/json
{
  • "businessUnitCode": "manager",
  • "costAdjustmentRates": [
    ],
  • "effectiveDate": "2018-01-01T05:15:15",
  • "rateSetGroupCode": "groupCode",
  • "rateSetGroupDescription": "groupDescription"
}
Creates a new cost adjustment rate set.
Creates a new cost adjustment rate set, using its group code as a unique identifier on the specified business unit.


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


Securitybearer 
Request 
Request Body schema: application/json
The cost adjustment rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisCostAdjustmentRate) 
Gets the cost adjustment rates.


 
effectiveDate
string or null <date-time> 
Gets the effective date.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to uniquely identify this rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate.


 
Responses 
post/api/v1/RateSet/CostAdjustment
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "costAdjustmentRates": [
    ],
  • "effectiveDate": "2018-01-01T05:15:15",
  • "rateSetGroupCode": "groupCode",
  • "rateSetGroupDescription": "groupDescription"
}
Updates an existing cost adjustment rate set by its id.
After the result of this operation, the server entity will match exactly what is sent here.  (i.e., excluded rates will be interpreted as "not needed" and deleted from the server)


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


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The cost adjustment rate set guid.


 
Request Body schema: application/json
The cost adjustment rate set.


businessUnitCode
required
string
Gets the business unit code.


 
Array of objects or null (DisCostAdjustmentRate) 
Gets the cost adjustment rates.


 
effectiveDate
string or null <date-time> 
Gets the effective date.


 
rateSetGroupCode
required
string
Gets the rate set group code, used to uniquely identify this rate
set.


 
rateSetGroupDescription
string or null
Gets the rate set group description.


 
id
string or null <uuid> 
The Id of the rate.


 
Responses 
put/api/v1/RateSet/CostAdjustment/{id}
Request samples 
application/json
{
  • "businessUnitCode": "manager",
  • "costAdjustmentRates": [
    ],
  • "effectiveDate": "2018-01-01T05:15:15",
  • "rateSetGroupCode": "groupCode",
  • "rateSetGroupDescription": "groupDescription"
}