Overview
This endpoint is used to create Inventory Item detail within the CMiC system.
Notes
Authentication and authorization are required.
The item code in the request is validated. If validation fails, the request may be rejected.
System-generated fields are ignored if provided in the request payload.
UI Navigation
Asset Management - Inventory - Setup - Item Detail
Finders
Not applicable.
This is a POST (create) endpoint and does not support finders.
Path Parameters
Not applicable.
This endpoint does not use path parameters.
Query Standards
Not applicable.
This endpoint does not support finder, limit, offset, or orderBy.
Finders with Example
Not applicable.
Finders are not supported for POST operations.
Attributes
All attributes are listed below for completeness.
Only attributes marked as Mandatory = True are required during creation.
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |
|---|---|---|---|---|---|---|---|
| CitemdCompCode | ciitemdetail | CitemdCompCode | Company Code | String | 8 | ALT | True |
| CitemdCompName | ciitemdetail | CitemdCompName | Company Name | String | 30 | Andy's Company ALT | False |
| CitemdItemCode | ciitemdetail | CitemdItemCode | Item Code | String | 16 | 12 FT GRDR | True |
| CitemdItemName | ciitemdetail | CitemdItemName | Item Name | String | 60 | 12 Foot Steel Girder | False |
| CitemdItemTypeCode | ciitemdetail | CitemdItemTypeCode | Item Type Code | String | 2 | ST | True |
| CitemdItemTypeName | ciitemdetail | CitemdItemTypeName | Item Type Name | String | 30 | Aggregates | False |
| CitemdLocCode | ciitemdetail | CitemdLocCode | Location Code | String | 7 | MAIN | True |
| CitemdLocName | ciitemdetail | CitemdLocName | Location Name | String | 60 | Main Warehouse | False |
| CitemdLotCtrlFlag | ciitemdetail | CitemdLotCtrlFlag | Manual Cost Batch Selection | String | 1 | N | True |
| CitemdBinCtrlFlag | ciitemdetail | CitemdBinCtrlFlag | Bin Ctrl Flag | String | 1 | N | False |
| CitemdSerialFlag | ciitemdetail | CitemdSerialFlag | Serialized Item | String | 1 | N | True |
| CitemdUsageCode | ciitemdetail | CitemdUsageCode | Item Equipment Usage Code | String | 1 | N | True |
| CitemdCostUpdateLevelCode | ciitemdetail | CitemdCostUpdateLevelCode | Cost Update Level | String | 1 | I | True |
| CitemdInvAccCode | ciitemdetail | CitemdInvAccCode | Inventory Account Code | String | 16 | 1700.100 | True |
| CitemdRevAccCode | ciitemdetail | CitemdRevAccCode | Internal Issue Revenue Account | String | 16 | 4000.700 | True |
| CitemdWriAccCode | ciitemdetail | CitemdWriAccCode | Write Off Account Code | String | 16 | 1700.200 | True |
| CitemdAdjAccCode | ciitemdetail | CitemdAdjAccCode | Adjustment Account Code | String | 16 | 1700.300 | True |
| CitemdVarAccCode | ciitemdetail | CitemdVarAccCode | Variance Account Code | String | 16 | 1700.500 | True |
| CitemdSuspAccCode | ciitemdetail | CitemdSuspAccCode | Suspense Account Code | String | 16 | 1700.400 | True |
| CitemdBookOnHandQty | ciitemdetail | CitemdBookOnHandQty | On Book Quantity | Number | 16/8 | 1000.0 | False |
| CitemdOnHandQty | ciitemdetail | CitemdOnHandQty | On Hand Quantity | Number | 16/8 | 1000.0 | False |
| CitemdOnOrderQty | ciitemdetail | CitemdOnOrderQty | On Order Quantity | Number | 16/8 | 12.0 | False |
| CitemdReserveQty | ciitemdetail | CitemdReserveQty | Reserve Quantity | Number | 16/8 | 1.0 | False |
| CitemdMinOrderQty | ciitemdetail | CitemdMinOrderQty | Minimum Order | Number | 16/8 | 1.0 | False |
| CitemdStdOrderQty | ciitemdetail | CitemdStdOrderQty | Standard Order | Number | 16/8 | 700.0 | False |
| CitemdMaxOrderQty | ciitemdetail | CitemdMaxOrderQty | Maximum Order | Number | 16/8 | 700.0 | False |
| CitemdMinOnhandQty | ciitemdetail | CitemdMinOnhandQty | Minimum On Hand | Number | 16/8 | 1.0 | False |
| CitemdMaxOnhandQty | ciitemdetail | CitemdMaxOnhandQty | Maximum On Hand | Number | 16/8 | 1000.0 | False |
| CitemdStdOnhandQty | ciitemdetail | CitemdStdOnhandQty | Standard On Hand | Number | 16/8 | 50.0 | False |
| CitemdMarketPriceAmt | ciitemdetail | CitemdMarketPriceAmt | Market Price | Number | 18/4 | 25.0 | False |
| CitemdSellPriceAmt | ciitemdetail | CitemdSellPriceAmt | Sell Price | Number | 18/4 | 35.0 | False |
| CitemdBuybackPriceAmt | ciitemdetail | CitemdBuybackPriceAmt | Buyback Price | Number | 18/4 | 12.0 | False |
| CitemdRestockPriceAmt | ciitemdetail | CitemdRestockPriceAmt | Re-Stock Charge | Number | 18/4 | 30.0 | False |
| CitemdStdCostAmt | ciitemdetail | CitemdStdCostAmt | Standard Cost | Number | 18/4 | 30 | False |
| CitemdAvgCostAmt | ciitemdetail | CitemdAvgCostAmt | Average Cost | Number | 18/4 | 30 | False |
| CitemdLastCostAmt | ciitemdetail | CitemdLastCostAmt | Last Cost | Number | 18/4 | 4 | False |
| CitemdCostUpdateDate | ciitemdetail | CitemdCostUpdateDate | Cost Update Date | String | N/A | 2014-05-22 00:00:00 | False |
| CitemdCrtDate | ciitemdetail | CitemdCrtDate | Creation Date | String | N/A | 2010-05-12 00:00:00 | False |
| CitemdCrtUserCode | ciitemdetail | CitemdCrtUserCode | Creation By User | String | 30 | QA1 | False |
| CitemdLastModifyDate | ciitemdetail | CitemdLastModifyDate | Last Modify Date | String | N/A | 2014-10-01 00:00:00 | False |
| CitemdLastModifyUserCode | ciitemdetail | CitemdLastModifyUserCode | Last Modify User | String | 30 | QA3 | False |
| CitemdTempInsertFlag | ciitemdetail | CitemdTempInsertFlag | Temp Insert Flag | String | 1 | N | False |
| CitemdBookReserveQty | ciitemdetail | CitemdBookReserveQty | Book Reserve Qty | Number | 16/8 | 0.0 | False |
| CitemdDeprExpAccCode | ciitemdetail | CitemdDeprExpAccCode | Depreciation Expense Account Code | String | 16 | 1700.400 | False |
| CitemdAccumDeprAccCode | ciitemdetail | CitemdAccumDeprAccCode | Accumulated Depreciation Account Code | String | 16 | 1700.400 | False |
| CitemdTax1Code | ciitemdetail | CitemdTax1Code | Purchasing Tax 1 Code | String | 11 | 01 | False |
| CitemdTax2Code | ciitemdetail | CitemdTax2Code | Purchasing Tax 2 Code | String | 11 | T5 | False |
| CitemdTax3Code | ciitemdetail | CitemdTax3Code | Purchasing Tax 3 Code | String | 11 | T6 | False |
| CitemdSoldAtCostAccCode | ciitemdetail | CitemdSoldAtCostAccCode | Cost of Goods Sold Account | String | 16 | 4000.701 | True |
| CitemdSalesTax1Code | ciitemdetail | CitemdSalesTax1Code | Sales Tax 1 Code | String | 11 | 01 | False |
| CitemdSalesTax2Code | ciitemdetail | CitemdSalesTax2Code | Sales Tax 2 Code | String | 11 | T5 | False |
| CitemdSalesTax3Code | ciitemdetail | CitemdSalesTax3Code | Sales Tax 3 Code | String | 11 | T6 | False |
| CitemdCmpQty | ciitemdetail | CitemdCmpQty | CMP On Hand Quantity | Number | 16/4 | 0.0 | False |
| CitemdBookCmpQty | ciitemdetail | CitemdBookCmpQty | Book Cmp Qty | Number | 16/4 | 0.0 | False |
| CitemdAffilRevAccCode | ciitemdetail | CitemdAffilRevAccCode | Affiliate Sales Revenue Account | String | 16 | 4000.700 | True |
| CitemdCustRevAccCode | ciitemdetail | CitemdCustRevAccCode | Customer Sales Revenue Account | String | 16 | 4000.700 | True |
| CitemdAllowNegQtyFlag | ciitemdetail | CitemdAllowNegQtyFlag | Allow Negative Balances | String | 1 | Y | False |
| CitemdLocActiveFlag | ciitemdetail | CitemdLocActiveFlag | Loc Active Flag | String | 1 | Y | False |
| CitemdAdditionalInvAmt | ciitemdetail | CitemdAdditionalInvAmt | Additional Inv Amt | Number | N/A | 0 | False |
| CitemdInventoryItemCode | ciitemdetail | CitemdInventoryItemCode | Item | String | 16 | BRICK1 | False |
| CitemdInventoryTypeCode | ciitemdetail | CitemdInventoryTypeCode | Item Code | String | 2 | 01 | False |
| CitemdInventoryLocCode | ciitemdetail | CitemdInventoryLocCode | Item Location Code | String | 7 | MAIN | False |
| CitemdSalesProductFlag | ciitemdetail | CitemdSalesProductFlag | Sales Code | String | 1 | N | False |
| CitemdMsAvailableFlag | ciitemdetail | CitemdMsAvailableFlag | Available For MS System | String | 1 | Y | True |
| CitemdIuCreateDate | ciitemdetail | CitemdIuCreateDate | Initial Create Date | String | N/A | Sytem Generated | False |
| CitemdIuUpdateDate | ciitemdetail | CitemdIuUpdateDate | Last Update Date | String | N/A | Sytem Generated | False |
| CitemdVUuid | ciitemdetail | CitemdVUuid | Unique Id | String | 64 | Generated | False |
Basic authentication
Created
"{\n \"CitemdCompCode\": \"ZZ\",\n \"CitemdCompName\": \"CMiC-ZZ Test Company Incorp\",\n \"CitemdItemCode\": \"SSHAMMER\",\n \"CitemdItemName\": \"SSHAMMER\",\n \"CitemdItemTypeCode\": \"1\",\n \"CitemdItemTypeName\": \"Standard\",\n \"CitemdLocCode\": \"MAIN\",\n \"CitemdLocName\": \"Main Warehouse ABCDEFGHIKLMNOPQ\",\n \"CitemdLotCtrlFlag\": \"N\",\n \"CitemdBinCtrlFlag\": null,\n \"CitemdSerialFlag\": \"N\",\n \"CitemdUsageCode\": \"N\",\n \"CitemdCostUpdateLevelCode\": \"I\",\n \"CitemdInvAccCode\": \"4000.700\",\n \"CitemdRevAccCode\": \"4000.700\",\n \"CitemdWriAccCode\": \"4000.700\",\n \"CitemdAdjAccCode\": \"4000.700\",\n \"CitemdVarAccCode\": \"4000.700\",\n \"CitemdSuspAccCode\": \"4000.700\",\n \"CitemdBookOnHandQty\": null,\n \"CitemdOnHandQty\": null,\n \"CitemdOnOrderQty\": null,\n \"CitemdReserveQty\": null,\n \"CitemdMinOrderQty\": null,\n \"CitemdStdOrderQty\": null,\n \"CitemdMaxOrderQty\": null,\n \"CitemdMinOnhandQty\": null,\n \"CitemdMaxOnhandQty\": null,\n \"CitemdStdOnhandQty\": null,\n \"CitemdMarketPriceAmt\": null,\n \"CitemdSellPriceAmt\": null,\n \"CitemdBuybackPriceAmt\": null,\n \"CitemdRestockPriceAmt\": null,\n \"CitemdStdCostAmt\": null,\n \"CitemdAvgCostAmt\": null,\n \"CitemdLastCostAmt\": null,\n \"CitemdCostUpdateDate\": null,\n \"CitemdCrtDate\": null,\n \"CitemdCrtUserCode\": null,\n \"CitemdLastModifyDate\": null,\n \"CitemdLastModifyUserCode\": null,\n \"CitemdTempInsertFlag\": null,\n \"CitemdBookReserveQty\": null,\n \"CitemdDeprExpAccCode\": null,\n \"CitemdAccumDeprAccCode\": null,\n \"CitemdTax1Code\": null,\n \"CitemdTax2Code\": null,\n \"CitemdTax3Code\": null,\n \"CitemdSoldAtCostAccCode\": \"4000.700\",\n \"CitemdSalesTax1Code\": null,\n \"CitemdSalesTax2Code\": null,\n \"CitemdSalesTax3Code\": null,\n \"CitemdCmpQty\": null,\n \"CitemdBookCmpQty\": null,\n \"CitemdAffilRevAccCode\": \"4000.700\",\n \"CitemdCustRevAccCode\": \"4000.700\",\n \"CitemdAllowNegQtyFlag\": null,\n \"CitemdLocActiveFlag\": null,\n \"CitemdAdditionalInvAmt\": null,\n \"CitemdInventoryItemCode\": null,\n \"CitemdInventoryTypeCode\": null,\n \"CitemdInventoryLocCode\": null,\n \"CitemdSalesProductFlag\": null,\n \"CitemdMsAvailableFlag\": \"N\",\n \"CitemdIuCreateDate\": \"2026-06-09T11:51:30-04:00\",\n \"CitemdIuUpdateDate\": null,\n \"CitemdVUuid\": \"53D4E53C97837658E0630B811DAC4B07\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://127.0.0.1:7101/ci-rest-api/rest/1/ciitemdetail/53D4E53C97837658E0630B811DAC4B07\",\n \"name\": \"ciitemdetail\",\n \"kind\": \"item\"\n },\n {\n \"rel\": \"canonical\",\n \"href\": \"http://127.0.0.1:7101/ci-rest-api/rest/1/ciitemdetail/53D4E53C97837658E0630B811DAC4B07\",\n \"name\": \"ciitemdetail\",\n \"kind\": \"item\"\n }\n ]\n}"