Subcontract

Returns subcontract items

Returns a list of subcontract items for the specified business unit.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>

The business unit id.

query Parameters
isDeleted
boolean

If true, only include deleted items. If false, only include non-deleted items. If blank, include all.

Responses
get/api/v1/businessUnits/{businessUnitId}/costTypes/subcontract
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates subcontract item
Creates a subcontract item for the specified business unit.


Securitybearer 
Request 
path Parameters
businessUnitId
required
string <uuid> 
The business unit id.


 
Request Body schema: 
required
The subcontract item to create.


code
required
string  non-empty 
The code.


 
description
string or null
The description.


 
heavyBidCode
string or null
The HeavyBid code.


 
Responses 
post/api/v1/businessUnits/{businessUnitId}/costTypes/subcontract
Request samples 
{
  • "code": "IF-Z",
  • "description": "Import Fill"
}
Response samples 
application/json
{
  • "id": "04f2c3f9-140e-4faf-ae35-98aa40852db9",
  • "businessUnitId": "07c00dc0-aecf-45bd-bf9e-74628188b3c7",
  • "isDeleted": false,
  • "code": "IF-Z",
  • "description": "Import Fill"
}
Updates subcontract item
Updates an existing subcontract item given its id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The subcontract item id.


 
Request Body schema: 
required
The subcontract item to be updated.


code
required
string  non-empty 
The code.


 
description
string or null
The description.


 
heavyBidCode
string or null
The HeavyBid code.


 
Responses 
put/api/v1/costTypes/subcontract/{id}
Request samples 
{
  • "code": "IF-Z",
  • "description": "Import Fill"
}
Deletes a subcontract item
Deletes a subcontract item given its id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The subcontract item id.


 
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/costTypes/subcontract/{id}
Request samples 
Returns job subcontract items
Returns a list of job subcontract items (i.e., subcontractor work that can be done on one or more cost codes).


Securitybearer 
Request 
path Parameters
jobId
required
string <uuid> 
The job id.


 
query Parameters
isDeleted
boolean
If true, only include deleted items. If false, only include non-deleted items. If blank, include all.


 
isDiscontinued
boolean
If true, only include discontinued items. If false, only include non-discontinued items. If blank, include all.


 
Responses 
get/api/v1/jobs/{jobId}/costTypes/jobSubcontract
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates job subcontract item
Creates a job subcontract item on the specified job.


Securitybearer 
Request 
path Parameters
jobId
required
string <uuid> 
The job id.


 
Request Body schema: 
required
The subcontract to be added.


subcontractId
required
string <uuid> 
The subcontract guid.


 
description
string or null
The description.


 
salesTaxPercent
number <double> 
The sales tax, expressed as a percent (e.g., 8 means 8% sales tax).


 
tmRate
number <double> 
The T&M rate, in dollars per unit of measure.


 
unitCost
number <double> 
The cost per unit of measure, in dollars.


 
unitOfMeasure
string or null
The unit of measure.


 
accountingCode
string or null
The accounting code.


 
Responses 
post/api/v1/jobs/{jobId}/costTypes/jobSubcontract
Request samples 
{
  • "subcontractId": "a7e4fdbe-8485-4bbd-b9bd-122bbad73ebc",
  • "description": "Job subcontract",
  • "salesTaxPercent": 10.1,
  • "tmRate": 7.5,
  • "unitCost": 20.5,
  • "unitOfMeasure": "CY",
  • "accountingCode": "S-ACC"
}
Response samples 
application/json
{
  • "id": "58236983-650d-4528-a9f3-f773a0366ecd",
  • "code": "IF-Z",
  • "jobId": "77de8c55-1b14-4f43-afc2-9f2edb6d64fb",
  • "description": "Import Fill",
  • "isDeleted": false,
  • "isDiscontinued": false,
  • "subcontractId": "58236983-650d-4528-a9f3-f773a0366ecd",
  • "salesTaxPercent": 8.25,
  • "tmRate": 200.5,
  • "unitCost": 50.2,
  • "unitOfMeasure": "TON",
  • "accountingCode": "S-ACC"
}
Returns a job subcontract item
Returns a job subcontract item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job subcontract item id.


 
query Parameters
isDeleted
boolean
If true, only include deleted items. If false, only include non-deleted items. If blank, include all.


 
isDiscontinued
boolean
If true, only include discontinued items. If false, only include non-discontinued items. If blank, include all.


 
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.


404
The specified resource is not found.


get/api/v1/costTypes/jobSubcontract/{id}
Request samples 
Response samples 
application/json
{
  • "id": "58236983-650d-4528-a9f3-f773a0366ecd",
  • "code": "IF-Z",
  • "jobId": "77de8c55-1b14-4f43-afc2-9f2edb6d64fb",
  • "description": "Import Fill",
  • "isDeleted": false,
  • "isDiscontinued": false,
  • "subcontractId": "58236983-650d-4528-a9f3-f773a0366ecd",
  • "salesTaxPercent": 8.25,
  • "tmRate": 200.5,
  • "unitCost": 50.2,
  • "unitOfMeasure": "TON",
  • "accountingCode": "S-ACC"
}
Updates job subcontract item
Updates an existing job subcontract item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job subcontract item id.


 
Request Body schema: 
required
The job subcontract item to be updated.


subcontractId
required
string <uuid> 
The subcontract guid.


 
description
string or null
The description.


 
salesTaxPercent
number <double> 
The sales tax, expressed as a percent (e.g., 8 means 8% sales tax).


 
tmRate
number <double> 
The T&M rate, in dollars per unit of measure.


 
unitCost
number <double> 
The cost per unit of measure, in dollars.


 
unitOfMeasure
string or null
The unit of measure.


 
accountingCode
string or null
The accounting code.


 
Responses 
put/api/v1/costTypes/jobSubcontract/{id}
Request samples 
{
  • "subcontractId": "a7e4fdbe-8485-4bbd-b9bd-122bbad73ebc",
  • "description": "Job subcontract",
  • "salesTaxPercent": 10.1,
  • "tmRate": 7.5,
  • "unitCost": 20.5,
  • "unitOfMeasure": "CY",
  • "accountingCode": "S-ACC"
}
Deletes job subcontract item
Deletes the job subcontract item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job subcontract item id.


 
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/costTypes/jobSubcontract/{id}
Request samples 
Returns subcontract transactions
Returns a list of subcontract transactions.


Securitybearer 
Request 
Request Body schema: 
The request object for getting subcontract item transactions.


jobIds
Array of strings or null <uuid> 
List of Job Ids.
Used with JobTagIds to limit jobs. Returns jobs with JobIds and JobTagIds.


 
jobTagIds
Array of strings or null <uuid> 
List of Job Tag Ids.
Used with JobIds to limit jobs. Returns jobs with JobIds and JobTagIds.


 
foremanIds
Array of strings or null <uuid> 
List of Foreman Ids.
Used to limit transactions. Returns transactions only for foremen specified.


 
startDate
string or null <date-time> 
Beginning local date (yyyy-MM-dd) of date range.
Used with EndDate. Transactions whose dates fall within this date range will be included.


 
endDate
string or null <date-time> 
End local date (yyyy-MM-dd) of date range.
Used with StartDate. Transactions whose dates fall within this date range will be included.


 
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.


 
businessUnitId
string or null <uuid> 
The business unit id.


 
costCodeIds
Array of strings or null <uuid> 
List of Cost Code Ids.


 
modifiedSince
string or null <date-time> 
The modifiedSince datetime.


 
onlyTM
boolean or null
The onlyTM optional parameter to filter to T&M data.


 
Responses 
post/api/v1/costTypes/subcontractWork/advancedRequest
Request samples 
{
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "foremanIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "cursor": "string",
  • "limit": 0,
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "costCodeIds": [
    ],
  • "modifiedSince": "2019-08-24T14:15:22Z",
  • "onlyTM": true
}
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}