Employee

Returns employees for a business unit

This call returns employees with accounting values for a specified business unit.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>

The business unit Id.

query Parameters
accountingTemplateName
string

The accounting system template name. If not specified, use default accounting system.

isActive
boolean
Default: true

If true, only include active employees. If false, only include inactive employees. If null, include all.

isDeleted
boolean
Default: false

If true, only include deleted employees. If false, only include non-deleted employees. If null, include all.

isForeman
boolean

If true, only include current foremen. If false, only include non-active foremen. If not specified, include all.

includeHistoricalForeman
boolean

If true, only include any active or inactive foremen. If false, only include non-foremen. If not specified, include all.

Responses
get/api/v1/businessUnits/{businessUnitId}/employees
Request samples 
Response samples 
application/json
[
  • {
    }
]
Returns employees
This call returns a list of employees for the specified business unit, employees, accounting template, active status, foreman status, and deleted status.


Securitybearer 
Request 
Request Body schema: 
Set of filters for the request.


businessUnitId
required
string <uuid> 
The business unit id.


 
employeeCodes
Array of strings or null
List of employee codes.


 
employeeIds
Array of strings or null <uuid> 
List of employee ids.


 
accountingTemplateName
string or null
The accounting template name.


 
isActive
boolean or null
The active flag.


 
isForeman
boolean or null
The active foreman flag.


 
includeHistoricalForeman
boolean or null
The historical foreman flag.


 
isDeleted
boolean or null
The soft-deleted flag.


 
cursor
string or null
Optional.
When there are additional results, the metadata nextCursor field
should be passed to retrieve the next page of results.


 
limit
integer or null <int32> 
The maximum number of results that should be returned.


 
Responses 
post/api/v1/employees/advancedRequest
Request samples 
{
  • "businessUnitId": "e353a65e-8c01-4d28-9495-38bc04ccee38",
  • "employeeCodes": [
    ],
  • "employeeIds": [
    ],
  • "accountingTemplateName": "ACCT1",
  • "isActive": true,
  • "isForeman": true,
  • "isDeleted": false,
  • "cursor": "DGDS93EaYwDQj4ggr0meNz6T7vkZpDqxLFIs2leWDww",
  • "limit": 500
}
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Call to get Employee details that include physical address, cell phone and other phone.
Securitybearer 
Request 
query Parameters
isDeleted
boolean
 
limit
integer <int32> 
 Default:  1000
The maximum number of results that should be returned.


 
cursor
string
 
Responses 
get/api/v1/employees
Request samples 
Delete an employee. Employee will be deleted at the company level, and business unit- or job-level 
relationships will also be deleted.
Securitybearer 
Request 
Request Body schema: 
MEmployee Ids


 Array 
string <uuid> 
 
Responses 
204
No Content


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.


delete/api/v1/employees
Request samples 
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]