CustomCostTypeItem

Returns custom cost type items

Returns a list of custom cost type 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/custom
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates cost type item
Creates a cost type item for the specified business unit.


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


 
Request Body schema: 
required
The cost type item to create.


costCategoryId
required
string <uuid> 
The cost category (custom cost type) id.


 
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/custom
Request samples 
{
  • "costCategoryId": "7f23623b-e127-469d-a613-f9942d24e112",
  • "code": "CustomCostTypeItem1",
  • "description": "Custom cost type item description"
}
Response samples 
application/json
{
  • "id": "5561186e-0491-49de-9646-c4dede646375",
  • "businessUnitId": "c94c60d5-ecce-4645-a5b0-b305b42ba74e",
  • "isDeleted": false,
  • "costCategoryId": "52b33d24-89c8-4810-a5a2-ab91b6eb6ab0",
  • "code": "Custom-Z",
  • "description": "Custom Fill"
}
Updates custom cost type item
Updates an existing custom cost type item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The custom cost type item id.


 
Request Body schema: 
required
The custom cost type item to be updated.


costCategoryId
required
string <uuid> 
The cost category (custom cost type) id.


 
code
required
string  non-empty 
The code.


 
description
string or null
The description.


 
heavyBidCode
string or null
The HeavyBid code.


 
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.


404
The specified resource is not found.


put/api/v1/costTypes/custom/{id}
Request samples 
{
  • "costCategoryId": "7f23623b-e127-469d-a613-f9942d24e112",
  • "code": "CustomCostTypeItem1",
  • "description": "Custom cost type item description"
}
Deletes a custom cost type item
Deletes a custom cost type item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The custom cost type 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.


404
The specified resource is not found.


delete/api/v1/costTypes/custom/{id}
Request samples 
Returns job custom cost type items
Returns a list of job custom cost type items.


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 null, include all.


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


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


 
Request Body schema: 
required
The job custom cost type item to be created.


customCostTypeItemId
required
string <uuid> 
The custom cost type item id.


 
description
string or null
The description.


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


 
unitCost
number or null <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/jobCustom
Request samples 
{
  • "customCostTypeItemId": "cbd3af49-7d59-4a48-a5f6-a5d523c8386b",
  • "description": "Custom cost type item description",
  • "salesTaxPercent": 7.5,
  • "unitCost": 10.14,
  • "unitOfMeasure": "FT",
  • "accountingCode": "Acct Code"
}
Response samples 
application/json
{
  • "customCostTypeItemId": "1c0ed890-b1f2-4cbf-8d29-9229f00f8595",
  • "description": "string",
  • "salesTaxPercent": 0,
  • "unitCost": 0,
  • "unitOfMeasure": "string",
  • "accountingCode": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "heavyBidCode": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "businessUnitCostType": {
    },
  • "businessUnitCostTypeItem": {
    },
  • "isDiscontinued": true,
  • "isDeleted": true
}
Returns a job custom cost type item
Returns a job custom cost type item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job custom cost type 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 not specified, 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/jobCustom/{id}
Request samples 
Response samples 
application/json
{
  • "customCostTypeItemId": "1c0ed890-b1f2-4cbf-8d29-9229f00f8595",
  • "description": "string",
  • "salesTaxPercent": 0,
  • "unitCost": 0,
  • "unitOfMeasure": "string",
  • "accountingCode": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "heavyBidCode": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "businessUnitCostType": {
    },
  • "businessUnitCostTypeItem": {
    },
  • "isDiscontinued": true,
  • "isDeleted": true
}
Updates job custom cost type item
Updates an existing job custom cost type item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job custom cost type item id.


 
Request Body schema: 
required
The job custom cost type item to be updated.


customCostTypeItemId
required
string <uuid> 
The custom cost type item id.


 
description
string or null
The description.


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


 
unitCost
number or null <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 
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.


404
The specified resource is not found.


put/api/v1/costTypes/jobCustom/{id}
Request samples 
{
  • "customCostTypeItemId": "cbd3af49-7d59-4a48-a5f6-a5d523c8386b",
  • "description": "Custom cost type item description",
  • "salesTaxPercent": 7.5,
  • "unitCost": 10.14,
  • "unitOfMeasure": "FT",
  • "accountingCode": "Acct Code"
}
Deletes job custom cost type item
Deletes the job custom cost type item with the specified id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job custom cost type 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.


404
The specified resource is not found.


delete/api/v1/costTypes/jobCustom/{id}
Request samples 
Returns installed custom cost type items
Returns a list of installed custom cost type items.


Securitybearer 
Request 
Request Body schema: 
The request object for getting installed custom cost type items.


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/customInstalled/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": {
    }
}
Returns received custom cost type items
Returns a list of received custom cost type items.


Securitybearer 
Request 
Request Body schema: 
The request object for getting received custom cost type items.


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.


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


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


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