Creates or updates cost codes (up to 10000).

patch

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The list of cost codes to be added or updated.

A POCO that represents a cost code to be created or updated by the API.

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.

supplyDollars

double | null

The supply cost.

removePayItem

boolean

If HeavyJobApi.Controllers.Models.CostCode.ApiCostCodeWrite.PayItemId is null, whether to remove
an existing relationship. Defaults to false.

workersCompId

uuid | null

Workers comp id

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

204

No Content

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

400Bad Request