Employee

Creates a new employee.

Create a new employee 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
required

The employee.

code
required
string

Gets the employee code. This is a required field.

businessUnitCode
required
string

Gets the business unit. This is a required field.

id
string or null <uuid>

Gets the master data id for this entity.

payClass
string or null

Gets the pay class. The default HeavyJob pay class will be assigned if the value is null or empty while doing POST/PUT requests.

phone
string or null

The phone number of the employee.

accountingCode
string or null

The accounting code.

address
string or null

The address of the employee.

address2
string or null

The address2 of the employee.

city
string or null

The city.

state
string or null <= 2 characters

The state.

zipCode
string or null

The zip code.

isForeman
boolean or null

Whether the employee is a foreman.

isActive
boolean or null

The active status of the employee.

isSalaried
boolean or null

The salaried status of the employee.

department
string or null

The "Department" accounting field.

costType
string or null

The "CostType" accounting field.

earnCode
string or null

The "EarnCode" accounting field.

crew
string or null

The "Crew" accounting field.

unionCode
string or null

The "UnionCode" accounting field.

division
string or null

The "Division" accounting field.

salary
number or null <double>

The "Salary" accounting field.

generalLedgerAccount
string or null

The "GLAcct" accounting field.

taxCode
string or null

The "TaxCode" accounting field.

type
string or null

The "Type" accounting field.

isDiscontinued
boolean or null

Whether the employee is discontinued.

supervisor
string or null

The supervisor.

defaultEquipment
string or null

The default equipment.

company
string or null

The company.

mobilePhone
string or null

The mobile phone of the employee.

email
string or null

The email address of the employee.

lastName
string or null

The last name.

firstName
string or null

The first name.

suffix
string or null

The suffix.

middleInitial
string or null <= 1 characters

The middle initial.

accountingTemplateName
string or null

The accounting template name.

payRateLevel
string or null

The "Pay Rate Level" accounting field.

payType
string or null

The "Pay Type" accounting field.

trade
string or null

The "Trade" accounting field.

viewExclusions
Array of strings or null (EmployeeViewType)

Gets the view exclusions.

Value: "timeCard"
Responses
post/api/v1/Employee
Request samples
application/json
{
  • "code": "01-CHARLES, C",
  • "businessUnitCode": "manager",
  • "id": "a16e9d88-2781-4798-a7dd-f418ad3fccf6",
  • "payClass": "MECHV-(HWI-4217)",
  • "phone": "882-838-8366",
  • "accountingCode": "Z193",
  • "address": "99 Ciprianni Blvd",
  • "address2": "#123",
  • "city": "Da Nng",
  • "state": "AR",
  • "zipCode": "444-DDD",
  • "isForeman": true,
  • "isActive": true,
  • "isSalaried": true,
  • "department": "Supers",
  • "costType": "Labor",
  • "earnCode": "Earn",
  • "crew": "rate03",
  • "unionCode": "ACLU",
  • "division": "trade-zz",
  • "salary": 20.5,
  • "generalLedgerAccount": "GL Acct",
  • "taxCode": "Tax Code",
  • "type": "Type",
  • "isDiscontinued": false,
  • "supervisor": "CARP, M",
  • "defaultEquipment": "loader-01",
  • "company": "Bob JV",
  • "mobilePhone": "867-5309",
  • "email": "charles@company.com",
  • "lastName": "Clark",
  • "firstName": "Charles",
  • "suffix": "M",
  • "middleInitial": "default",
  • "accountingTemplateName": "1",
  • "payRateLevel": "R",
  • "payType": "CARP",
  • "trade": null,
  • "viewExclusions": [
    ]
}

Returns a list of employees.

Returns a list of employees for the specified business unit code 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
includeDeleted
boolean
Default: false

Optional, if set to true result will also include deleted employees.

Example: includeDeleted=true
Responses
get/api/v1/Employee
Request samples 
Response samples 
application/json
[
  • {
    }
]
Updates an employee 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 employee guid.


 
Request Body schema: application/json
required
The employee.


code
required
string
Gets the employee code.  This is a required field.


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


 
id
string or null <uuid> 
Gets the master data id for this entity.


 
payClass
string or null
Gets the pay class. The default HeavyJob pay class will be assigned if the value is null or empty while doing POST/PUT requests.


 
phone
string or null
The phone number of the employee.


 
accountingCode
string or null
The accounting code.


 
address
string or null
The address of the employee.


 
address2
string or null
The address2 of the employee.


 
city
string or null
The city.


 
state
string or null  <= 2 characters 
The state.


 
zipCode
string or null
The zip code.


 
isForeman
boolean or null
Whether the employee is a foreman.


 
isActive
boolean or null
The active status of the employee.


 
isSalaried
boolean or null
The salaried status of the employee.


 
department
string or null
The "Department" accounting field.


 
costType
string or null
The "CostType" accounting field.


 
earnCode
string or null
The "EarnCode" accounting field.


 
crew
string or null
The "Crew" accounting field.


 
unionCode
string or null
The "UnionCode" accounting field.


 
division
string or null
The "Division" accounting field.


 
salary
number or null <double> 
The "Salary" accounting field.


 
generalLedgerAccount
string or null
The "GLAcct" accounting field.


 
taxCode
string or null
The "TaxCode" accounting field.


 
type
string or null
The "Type" accounting field.


 
isDiscontinued
boolean or null
Whether the employee is discontinued.


 
supervisor
string or null
The supervisor.


 
defaultEquipment
string or null
The default equipment.


 
company
string or null
The company.


 
mobilePhone
string or null
The mobile phone of the employee.


 
email
string or null
The email address of the employee.


 
lastName
string or null
The last name.


 
firstName
string or null
The first name.


 
suffix
string or null
The suffix.


 
middleInitial
string or null  <= 1 characters 
The middle initial.


 
accountingTemplateName
string or null
The accounting template name.


 
payRateLevel
string or null
The "Pay Rate Level" accounting field.


 
payType
string or null
The "Pay Type" accounting field.


 
trade
string or null
The "Trade" accounting field.


 
viewExclusions
Array of strings or null (EmployeeViewType) 
Gets the view exclusions.


 Value: "timeCard"  
Responses 
put/api/v1/Employee/{id}
Request samples 
application/json
{
  • "code": "01-CHARLES, C",
  • "businessUnitCode": "manager",
  • "id": "a16e9d88-2781-4798-a7dd-f418ad3fccf6",
  • "payClass": "MECHV-(HWI-4217)",
  • "phone": "882-838-8366",
  • "accountingCode": "Z193",
  • "address": "99 Ciprianni Blvd",
  • "address2": "#123",
  • "city": "Da Nng",
  • "state": "AR",
  • "zipCode": "444-DDD",
  • "isForeman": true,
  • "isActive": true,
  • "isSalaried": true,
  • "department": "Supers",
  • "costType": "Labor",
  • "earnCode": "Earn",
  • "crew": "rate03",
  • "unionCode": "ACLU",
  • "division": "trade-zz",
  • "salary": 20.5,
  • "generalLedgerAccount": "GL Acct",
  • "taxCode": "Tax Code",
  • "type": "Type",
  • "isDiscontinued": false,
  • "supervisor": "CARP, M",
  • "defaultEquipment": "loader-01",
  • "company": "Bob JV",
  • "mobilePhone": "867-5309",
  • "email": "charles@company.com",
  • "lastName": "Clark",
  • "firstName": "Charles",
  • "suffix": "M",
  • "middleInitial": "default",
  • "accountingTemplateName": "1",
  • "payRateLevel": "R",
  • "payType": "CARP",
  • "trade": null,
  • "viewExclusions": [
    ]
}