PayClass

Returns pay classes in a business unit

This call returns a list of pay classes in a business unit.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>

The business unit Id.

query Parameters
isActive
boolean
Default: true

If true, only include active pay classes. If false, include non-active pay classes. If not specified, include all.

Responses
get/api/v1/businessUnits/{businessUnitId}/payclass
Request samples 
Response samples 
application/json
[
  • {
    }
]
Updates a pay class in a business unit
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the pay class to be updated


 
Request Body schema: 
required
The set of values to be updated


businessUnitId
string <uuid> 
The business unit Id.


 
code
string or null
The pay class code.


 
hbEstimateCode
string or null
The pay class HeavyBid code.


 
description
string or null
The pay class description.


 
isActive
boolean or null
The active status.


 
Responses 
200
Success


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.


404
The specified resource is not found.


patch/api/v1/payClasses/{id}
Request samples 
{
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "code": "string",
  • "hbEstimateCode": "string",
  • "description": "string",
  • "isActive": true
}