Description
labor, material, equipment, sub, kits, or other inventory items that can be sourced to an opportunity. Click Item Catalog Screen for more information.
Resource Overview
| Endpoint | Definition |
| GET/CatalogItems | Retrieve a list of information related to catalog items. |
| POST/CatalogItems | Add catalog items. |
| PUT/CatalogItems | Modify existing catalog items. |
Attributes
| Attribute | Description | Data Type | Notes |
|---|---|---|---|
| Active | indicates if the category is active or inactive | boolean | |
| AllocationUnitTypeID | unique identifier for the allocation unit type | integer(int32) | |
| AllocationUnitTypeName | name given for the unit measure allocated for a catalog item | string | Max Length: 50 |
| AllocateFromMobile | indicates whether material and equipment catalog items are available for time allocation or auto expenses | boolean | |
| AvailableToBid | indicates whether an item can be included directly in the estimate. | boolean | |
| CatalogId | unique identifier for catalog | integer(int32) | |
| CatalogItemCategoryID | unique identifier catalog item | integer(int32) | |
| CatalogItemID | unique identifier for the catalog item | integer(int32) | |
| CatalogName | name of the catalog | string | Max Length: 200 |
| EPANumber | numerical value assigned by the Environmental Protection Agency for certain chemicals | string | Max Length: 50 |
| EPAName | name associated with EPA number | boolean | Max Length: 250 |
| ForceUnitPricing | indicates if an item should be sold by unit pricing | boolean | |
| Inventory | determines whether an item can be placed in the inventory | boolean | |
| ItemAlternateName | an alternate name for an item usually is the technical name such as the genus or species of an item | string | Max Length: 200 |
| ItemCode | vendor or manufacturer code | string | Max Length: 50 |
| ItemCost | the dollar value of purchasing an item | number(double) | |
| ItemDescription | detailed description of an item | string | Max Length: 200 |
| ItemName | title given to an item or kit | string | Max Length: 2147483647 |
| ItemType | one of the following catalog item groups: material, labor, equipment, sub, other, or kit | string | Max Length: 10 |
| LastUpdatedByUserID | unique identifier of the user to make the most recent update for a catalog item | integer(int32) | |
| LastUpdatedByUserName | full name of the user to make the most recent update for a catalog item | string | Max Length: 101 |
| LastUpdatedDateTime | date and time when the item was last updated | DateTime | |
| MaterialBarcode1 | Primary barcode value for the catalog item. | string | |
| MaterialBarcode2 | Secondary barcode value for the catalog item. | string | |
| PurchaseUnitCost | total amount incurred per catalog item unit | number(double) | |
| PurchaseUnitTypeID | unique identifier for the purchase unit type | integer(int32) | |
| PurchaseUnitTypeName | the title given to purchase unit type | string | Max Length: 50 |
| TakeoffItemID | unique identifier for a takeoff catalog item | integer(int32) | |
| UnitTypeAllocationConversion | conversion rate between purchase and allocation units | number(double) |