Job

Creates a new job.

Creates a new job, 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 job.

code
required
string

Gets the job code. This is a required field.

businessUnitCode
required
string

Gets the business unit. This is a required field.

status
required
string

Gets the status. Items Enum: "A" for Active, "C" for Completed, "I" for Inactive

id
string or null <uuid>

The Id of the job.

description
string or null

The description.

note
string or null

The note.

address
string or null

The address.

city
string or null

The city.

country
string or null

The country.

state
string or null

The state.

zipCode
string or null

The zip code.

laborRateSetGroup
string or null

The labor rateset group name.

equipmentRateSetGroup
string or null

The equipment rateset group name.

accountingCode
string or null

The accounting code.

accountingState
string or null

The "StateCode" accounting field.

unionClass
string or null

The "UnionClass" accounting field.

unionCode
string or null

The "Union" accounting field.

unionLocal
string or null

The "UnionLocal" accounting field.

certified
string or null

The "Certified" accounting field.

company
string or null

The "Company" accounting field.

localTaxCode
string or null

The "LocalTaxCode" accounting field.

location
string or null

The "Location" accounting field.

accountingTemplateName
string or null

The accounting template name.

Array of objects or null (DisTag)

The job tags.

Responses
post/api/v1/Job
Request samples
application/json
{
  • "code": "Z3924",
  • "businessUnitCode": "manager",
  • "status": "A",
  • "id": "8ed07dc4-081b-4829-a18c-018b80864fd8",
  • "description": "Demo Job for Testing",
  • "note": "Onsite guard service required",
  • "address": "13151 W Airport Blvd",
  • "city": "Sugar Land",
  • "country": "USA",
  • "state": "TX",
  • "zipCode": "77478-6163",
  • "laborRateSetGroup": "000-001-AQ1",
  • "equipmentRateSetGroup": "000-001-AB",
  • "accountingCode": "13807-1234",
  • "accountingState": "TX",
  • "unionClass": "class1",
  • "unionCode": "ACLU",
  • "unionLocal": "ACLU - Houston",
  • "certified": "Certified",
  • "company": "default",
  • "localTaxCode": "Certified",
  • "location": "Local Tax Code",
  • "accountingTemplateName": "Location",
  • "tags": [
    ]
}

Returns a list of jobs.

Returns a list of jobs 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
Responses
get/api/v1/Job
Request samples 
Response samples 
application/json
[
  • {
    }
]
Updates an existing job 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 job guid.


 
Request Body schema: application/json
The job.


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


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


 
status
required
string
Gets the status. Items Enum: "A" for Active, "C" for Completed, "I" for Inactive


 
id
string or null <uuid> 
The Id of the job.


 
description
string or null
The description.


 
note
string or null
The note.


 
address
string or null
The address.


 
city
string or null
The city.


 
country
string or null
The country.


 
state
string or null
The state.


 
zipCode
string or null
The zip code.


 
laborRateSetGroup
string or null
The labor rateset group name.


 
equipmentRateSetGroup
string or null
The equipment rateset group name.


 
accountingCode
string or null
The accounting code.


 
accountingState
string or null
The "StateCode" accounting field.


 
unionClass
string or null
The "UnionClass" accounting field.


 
unionCode
string or null
The "Union" accounting field.


 
unionLocal
string or null
The "UnionLocal" accounting field.


 
certified
string or null
The "Certified" accounting field.


 
company
string or null
The "Company" accounting field.


 
localTaxCode
string or null
The "LocalTaxCode" accounting field.


 
location
string or null
The "Location" accounting field.


 
accountingTemplateName
string or null
The accounting template name.


 
Array of objects or null (DisTag) 
The job tags.


 
Responses 
put/api/v1/Job/{id}
Request samples 
application/json
{
  • "code": "Z3924",
  • "businessUnitCode": "manager",
  • "status": "A",
  • "id": "8ed07dc4-081b-4829-a18c-018b80864fd8",
  • "description": "Demo Job for Testing",
  • "note": "Onsite guard service required",
  • "address": "13151 W Airport Blvd",
  • "city": "Sugar Land",
  • "country": "USA",
  • "state": "TX",
  • "zipCode": "77478-6163",
  • "laborRateSetGroup": "000-001-AQ1",
  • "equipmentRateSetGroup": "000-001-AB",
  • "accountingCode": "13807-1234",
  • "accountingState": "TX",
  • "unionClass": "class1",
  • "unionCode": "ACLU",
  • "unionLocal": "ACLU - Houston",
  • "certified": "Certified",
  • "company": "default",
  • "localTaxCode": "Certified",
  • "location": "Local Tax Code",
  • "accountingTemplateName": "Location",
  • "tags": [
    ]
}