PayClass

Creates a new pay class.

Creates a new pay class, using its 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.

code
required
string

Gets the pay class code. This is a required field.

businessUnitCode
required
string

Gets the business unit. This is a required field.

id
string or null <uuid>

The id of the pay class.

description
string or null

The description of the pay class.

unionCode
string or null

The "UnionCode" accounting field.

accountingCode
string or null

The accounting code.

category
string or null

The "Category" accounting field.

trade
string or null

The "Trade" accounting field.

type
string or null

The "Type" accounting field.

unionClass
string or null

The "UnionClass" accounting field.

unionLocal
string or null

The "UnionLocal" accounting field.

craft
string or null

The "Craft" accounting field.

heavyBidCode
string or null

The HeavyBid code.

isActive
boolean or null

is active flag.

accountingTemplateName
string or null

The accounting template name.

Responses
post/api/v1/PayClass
Request samples
application/json
{
  • "code": "02-MECH-H-(HWI-4217)",
  • "businessUnitCode": "manager",
  • "id": "4ff1c87a-e57f-4ebb-84f1-803784a3bc37",
  • "description": "Mechanic (Heavy Equipment)",
  • "unionCode": "Union Code",
  • "accountingCode": "ACLU",
  • "category": "833205z",
  • "trade": "Trade",
  • "type": "Type",
  • "unionClass": "Union Class",
  • "unionLocal": "Union Local",
  • "craft": "Craft",
  • "heavyBidCode": "HB-OEXC",
  • "isActive": true,
  • "accountingTemplateName": "default"
}

Returns a list of pay classes.

Returns a list of pay classes for the specified business unit and accounting template.

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
accountingTemplateName
string
Default: ""

The accounting template name. If blank or unspecified, the primary accounting template for the business unit is used.

Example: accountingTemplateName=MAINTEMPLATE
Responses
get/api/v1/PayClass
Request samples 
Response samples 
application/json
[
  • {
    }
]
Updates an existing pay class by its id.
After the result of this operation, the server entity will match exactly what is sent here.  (i.e., excluded fields 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 pay class guid.


 
Request Body schema: application/json
The pay class.


code
required
string
Gets the pay class code.  This is a required field.


 
businessUnitCode
required
string
Gets the business unit.  This is a required field.


 
id
string or null <uuid> 
The id of the pay class.


 
description
string or null
The description of the pay class.


 
unionCode
string or null
The "UnionCode" accounting field.


 
accountingCode
string or null
The accounting code.


 
category
string or null
The "Category" accounting field.


 
trade
string or null
The "Trade" accounting field.


 
type
string or null
The "Type" accounting field.


 
unionClass
string or null
The "UnionClass" accounting field.


 
unionLocal
string or null
The "UnionLocal" accounting field.


 
craft
string or null
The "Craft" accounting field.


 
heavyBidCode
string or null
The HeavyBid code.


 
isActive
boolean or null
is active flag.


 
accountingTemplateName
string or null
The accounting template name.


 
Responses 
put/api/v1/PayClass/{id}
Request samples 
application/json
{
  • "code": "02-MECH-H-(HWI-4217)",
  • "businessUnitCode": "manager",
  • "id": "4ff1c87a-e57f-4ebb-84f1-803784a3bc37",
  • "description": "Mechanic (Heavy Equipment)",
  • "unionCode": "Union Code",
  • "accountingCode": "ACLU",
  • "category": "833205z",
  • "trade": "Trade",
  • "type": "Type",
  • "unionClass": "Union Class",
  • "unionLocal": "Union Local",
  • "craft": "Craft",
  • "heavyBidCode": "HB-OEXC",
  • "isActive": true,
  • "accountingTemplateName": "default"
}