Updates an employee by its id.

put

https://api.hcssapps.com/setups/api/v1/Employee/{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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The employee guid.

Body Params

The employee.

Employee object with associated accounting fields.

code

string

required

Gets the employee code. This is a required field.

businessUnitCode

string

required

Gets the business unit. This is a required field.

uuid | null

Gets the master data id for this entity.

payClass

string | 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 | null

The phone number of the employee.

accountingCode

string | null

The accounting code.

address

string | null

The address of the employee.

address2

string | null

The address2 of the employee.

city

string | null

The city.

state

string | null

The state.

zipCode

string | null

The zip code.

isForeman

boolean | null

Whether the employee is a foreman.

isActive

boolean | null

The active status of the employee.

isSalaried

boolean | null

The salaried status of the employee.

minimumBaseRate

double | null

The minimum base rate of the employee.

department

string | null

The "Department" accounting field.

costType

string | null

The "CostType" accounting field.

earnCode

string | null

The "EarnCode" accounting field.

crew

string | null

The "Crew" accounting field.

unionCode

string | null

The "UnionCode" accounting field.

division

string | null

The "Division" accounting field.

salary

double | null

The "Salary" accounting field.

generalLedgerAccount

string | null

The "GLAcct" accounting field.

taxCode

string | null

The "TaxCode" accounting field.

type

string | null

The "Type" accounting field.

isDiscontinued

boolean | null

Whether the employee is discontinued.

supervisor

string | null

The supervisor.

defaultEquipment

string | null

The default equipment.

company

string | null

The company.

mobilePhone

string | null

The mobile phone of the employee.

string | null

The email address of the employee.

lastName

string | null

The last name.

firstName

string | null

The first name.

suffix

string | null

The suffix.

middleInitial

string | null

The middle initial.

accountingTemplateName

string | null

The accounting template name.

payRateLevel

string | null

The "Pay Rate Level" accounting field.

payType

string | null

The "Pay Type" accounting field.

trade

string | null

The "Trade" accounting field.

viewExclusions

array of objects | null

Gets the view exclusions.

viewExclusions

Allowed:

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.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here!