POST /rest/v2.0/companies/{company_id}/estimating/catalogs/items

Creates new Cost Item

Servers

Path parameters

Name Type Required Description
company_id String Yes

Unique company identifier associated with the Procore User Account.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Request body fields

Name Type Required Description
description String No

The description of the cost item.

cost_type_code String No

The cost type code associated with the cost item. Applicable only for items categorized under a Custom cost type.

cost_type_name String No

The name of the cost type associated with the cost item. Applicable only for items categorized under a Custom cost type.

unit_labor_rate Number No

The unit labor rate for the cost item.

catalog_id String Yes

The catalog ID associated with the cost item.

unit_labor Number No

The unit labor required for the cost item.

material_waste Number No

The waste percentage associated with the cost item.

unit_cost Number No

The unit cost of the cost item.

unit String Yes

The unit of measurement for the cost item.

Valid values:

  • "SQ_YD"
  • "FT"
  • "SQ_FT"
  • "MINUTES"
  • "HOURS"
  • "MONTHS"
  • "YD"
  • "DAYS"
  • "CU_FT"
  • "CU_YD"
  • "SQUARE"
  • "GAL"
  • "WEEKS"
  • "LUMP_SUM"
  • "EA"
  • "TON"
  • "LB"
  • "NONE"
sub_items[] Array No

Array of sub-items associated with the cost item. Ignore unless you are creating an Assembly.

sub_items[].description String No

The description of the cost item.

sub_items[].cost_type_code String No

The cost type code associated with the cost item. Applicable only for items categorized under a Custom cost type.

sub_items[].cost_type_name String No

The name of the cost type associated with the cost item. Applicable only for items categorized under a Custom cost type.

sub_items[].unit_labor_rate Number No

The unit labor rate for the cost item.

sub_items[].unit_labor Number No

The unit labor required for the cost item.

sub_items[].material_waste Number No

The waste percentage associated with the cost item.

sub_items[].unit_cost Number No

The unit cost of the cost item.

sub_items[].unit String No

The unit of measurement for the cost item.

Valid values:

  • "SQ_YD"
  • "FT"
  • "SQ_FT"
  • "MINUTES"
  • "HOURS"
  • "MONTHS"
  • "YD"
  • "DAYS"
  • "CU_FT"
  • "CU_YD"
  • "SQUARE"
  • "GAL"
  • "WEEKS"
  • "LUMP_SUM"
  • "EA"
  • "TON"
  • "LB"
  • "NONE"
sub_items[].multiplier Number Yes

The multiplier applied to the cost sub-item.

sub_items[].name String No

The name of the cost item.

sub_items[].notes String No

Any additional notes about the cost item.

sub_items[].waste Number No

The waste percentage associated with the cost item.

sub_items[].labor_margin Number No

The margin applied to the labor for the cost item.

sub_items[].manufacturer String No

The manufacturer of the cost item.

sub_items[].type String No

The type of the cost item.

Valid values:

  • "CUSTOM"
  • "SUBCONTRACTOR"
  • "LABOR"
  • "PART"
  • "ASSEMBLY"
  • "EQUIPMENT"
  • "TRAVEL"
sub_items[].supplier String No

The supplier of the cost item.

sub_items[].is_untaxed Boolean No

Indicates whether the cost item is untaxed.

sub_items[].unit_labor_cost Number No

The cost of the unit labor.

sub_items[].item_id String No

The ID of the existing item this cost item. Ignore if creating a new item.

sub_items[].catalog_number String No

The catalog number of the cost item.

sub_items[].item_margin Number No

The margin applied to the cost item.

name String Yes

The name of the cost item.

notes String No

Any additional notes about the cost item.

waste Number No

The waste percentage associated with the cost item.

labor_margin Number No

The margin applied to the labor for the cost item.

manufacturer String No

The manufacturer of the cost item.

type String Yes

The type of the cost item.

Valid values:

  • "CUSTOM"
  • "SUBCONTRACTOR"
  • "LABOR"
  • "PART"
  • "ASSEMBLY"
  • "EQUIPMENT"
  • "TRAVEL"
supplier String No

The supplier of the cost item.

is_untaxed Boolean No

Indicates whether the cost item is untaxed.

unit_labor_cost Number No

The cost of the unit labor.

catalog_number String No

The catalog number of the cost item.

item_margin Number No

The margin applied to the cost item.

color String No

The color associated with the cost item.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.