Material Codebook

Retrieves all material codebook resources for a business unit.

Retrieves all material codebook resources for a business unit.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
path Parameters
businessUnitId
required
string <guid>

The required business unit id.

query Parameters
$top
string
Default: ""

The max number of records. (e.g. $top=10)

$skip
string
Default: ""

The number of records to skip. (e.g. $skip=5)

$filter
string
Default: ""

A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b)

$orderby
string
Default: ""

Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc)

Responses
get/api/v2/integration/businessunits/{businessUnitId}/materialcodebook
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "currentTopValue": 100,
  • "currentSkipValue": 0,
  • "nextSkipValue": 100
}

Retrieves a specific material codebook resource by its id.

Retrieves a specific material codebook resource by its id.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
path Parameters
id
required
string <guid>

The required material codebook resource id.

businessUnitId
required
string <guid>

The required business unit id.

Responses
get/api/v2/integration/businessunits/{businessUnitId}/materialcodebook/{id}
Request samples
Response samples
application/json
{
  • "data": {
    }
}

Replace a specific material codebook resource by its id.

Replace a specific material codebook resource by its id.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
path Parameters
id
required
string <guid>

The required material codebook resource id.

businessUnitId
required
string <guid>

The required business unit id.

Request Body schema: application/json

The new material codebook resource to replace the old one with.

description
string or null

The description.

unitCost
number or null <decimal>

The unit cost.

unit
string or null

The unit of measure.

nonTaxable
string or null

A flag to represent if the resource is not taxable.

accountingCode
string or null

The accounting code.

accountingDesc
string or null

The accounting code description.

mhPerUnit
number or null <decimal>

The manhours needed in the crew per unit when using resource factoring production.

quoteFolder
string or null

The default class/folder of the resource for the quote system.

resourceText1
string or null

The resource text 1.

resourceText2
string or null

The resource text 2.

scheduleCode
string or null

The code to be used instead of the resource code when exporting to primavera.

excludeFromQuotes
string or null

A flag to exclude the detail when populating quote folders.

Responses
put/api/v2/integration/businessunits/{businessUnitId}/materialcodebook/{id}
Request samples
application/json
{
  • "description": "Base",
  • "unitCost": 25,
  • "unit": "TON",
  • "nonTaxable": "N",
  • "accountingCode": "",
  • "accountingDesc": "",
  • "mhPerUnit": 0,
  • "quoteFolder": "RCP",
  • "resourceText1": "",
  • "resourceText2": "",
  • "scheduleCode": "",
  • "excludeFromQuotes": "Y"
}
Response samples
application/json
{
  • "data": {
    }
}