Creates a new cost code with accounting values.

post

https://api.hcssapps.com/heavyjob/api/v1/costCodes

The code will be uppercased and trimmed of whitespace.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

accountingTemplateName

string

Body Params

Cost Code object with it's associated accounting fields

jobId

uuid

required

The job that the cost code is in. This is a required field.

code

string

required

length ≥ 1

The cost code code. This is a required field.

description

string | null

The cost code description.

quantity

double | null

The quantity.

unitOfMeasure

string | null

The unit of measure.

laborHours

double | null

The labor hours.

equipmentHours

double | null

The equipment hours.

laborDollars

double | null

The labor cost.

equipmentDollars

double | null

The equipment cost.

materialDollars

double | null

The material cost.

subcontractDollars

double | null

The subcontract cost.

status

string

enum

Allowed:

note

string | null

The cost code note.

historicalActivityCode

string | null

The historical activity code.

historicalBiditem

string | null

The historical biditem code.

heavyBidEstimateCode

string | null

The estimate code.

isTm

boolean | null

The flag indicating whether the cost code is a time-and-material item.

startDate

date-time | null

The start date.

endDate

date-time | null

The end date.

duration

double | null

The duration (days).

isHiddenFromMobile

boolean | null

The flag indicating whether the cost code is hidden from mobile.
Default is false.

isCapExpected

boolean | null

The flag indicating whether to set the cost code to cap expected.
Default is true.

payItemId

uuid | null

The pay item that this cost code is associated with.

payItemFactor

double | null

Any costs contributed by this cost code are multiplied by
this factor before being applied to its parent pay item.

isPayItemDriver

boolean | null

Whether this cost code contributes to the cost of its parent
pay item.

accountingCode

string | null

The accounting code.

category

string | null

"Category" accounting field

cpm

string | null

"CPM Code" accounting field

glAcct

string | null

"GL Acct" accounting field

subJob

string | null

"Sub-Job" accounting field

wbsCode

string | null

"WBS Code" accounting field

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

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.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK