Items are goods, services, or kits that you purchase from vendors or sell to customers. Items are used in Inventory Control, Order Entry, and Purchasing. The type of an item (itemType
) affects other item parameters.
Possible item types are:
inventory
- Items that will be available in inventory, sales, and purchasing transactions.nonInventory
- Items that will be available in both sales and purchasing transactions or contracts.purchaseOnlyNonInventory
- Items that will only be available in purchasing transactions or contract expenses. salesOnlyNonInventory
- Items that will only be available in sales transactions or contracts.kit
- The parent item of a (non-stockable) kit (which is assembled from other items at the time of the order). This type is only available if Kits is enabled in either Order Entry or Inventory Control.stockableKit
- The parent item of a stockable kit (which is assembled from other items and stored before order). This type is only available if Stockable kits is enabled in Inventory Control.Returns up to 100 object references from the collection with a key, ID, and link for each item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "79",
- "id": "FVP-020",
- "href": "/objects/inventory-control/item/79"
}, - {
- "key": "73",
- "id": "FVP-016",
- "href": "/objects/inventory-control/item/73"
}, - {
- "key": "70",
- "id": "FVP-014",
- "href": "/objects/inventory-control/item/70"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100
}
}
Creates a new item.
id required | string <= 30 characters Unique identifier for the item. Example: "23" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string <= 100 characters Unique name for the item. Example: "Dell Laptop 13inch" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
itemType required | string Default: "inventory" The type for the item. Item type determines where the item will be available. Example: "inventory" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
costMethod required | string or null Default: "standard" Set the accounting method to use to determine the cost of inventory. This field applies only if Inventory Control is configured to enable multiple cost methods and the item type is Inventory. After you create an item, you cannot change its cost method. Example: "standard" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableFulfillment | boolean Default: false Set this field to true if you want to enable fulfillment for non inventory item. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isItemEnabledForMRR | boolean Default: false Whether to include the item in the Software Digital Board Book calculations of monthly recurring revenue. Changing an item's MRR field only affects new transactions or contract lines going forward. It will not affect existing transactions or contract lines. The best practice is to not change an item's MRR setting once the item has been used in a transaction. If you need to change your item's MRR configuration after implementing Digital Board Book (DBB), contact your Sage Intacct account manager for more information. This field is only applicable if your company subscribes to the Software Digital Board Book. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Provide product line to which this item belongs. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedDescription | string <= 400 characters Provide a detailed description of the item. This is most useful if you have many items that have only slight variations. The description is used as the default Item description when the item is entered in Order Entry, Purchasing, and Inventory Control transactions. Example: "13 inch dell laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
poDescription | string <= 400 characters Use this field to provide a purchase transaction description that was used in a legacy accounting system during implementation or to provide additional item details for internal reporting. This description does not appear in any transactions and does not print on any documents. Example: "13 inch dell laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
soDescription | string <= 400 characters Use this field to provide a sales transaction description that was used in a legacy accounting system during implementation or to provide additional item details for internal reporting. This description does not appear in any transactions and does not print on any documents. Example: "13 inch dell laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Unit of measure group for the item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notes | string <= 1000 characters Notes or detailed information not captured elsewhere. Example: "Dell 13 inch laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vsoeCategory | string or null Default: null Fair value category. Example: "software" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vsoeDefaultDeliveryStatus | string or null Default: "delivered" VSOE default delivery status. Example: "delivered" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vsoeDefaultDeferralStatus | string or null Default: "deferUntilItemIsDelivered" VSOE default deferral status. Example: "deferUntilItemIsDelivered" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
substituteItemId | string Substitute item ID Example: "Dell Laptop 14inch" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Provide information about if item is tracked by serial, lot, bin, expiration date, or any combination of those. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object These numbers override the default precision, or number of decimal places, for this item in the Inventory Control, Order Entry, and Purchasing applications. For example, an item with a cost of $0.00456 requires five decimal places. Depending on your needs, you can assign the item a different precision in each application. For example, you can enter 4 in Purchasing and Inventory and 2 in Sales. The default precision as shipped from Intacct is two decimal places for each application. However, for Order Entry and Purchasing, you can change this default to a precision of up to 10 decimal places in the application's configuration. While Sage Intacct uses the number of decimal places specified here for the item in transactions, it rounds values to 10 decimal places for costing calculations, to 2 decimal places for the General Ledger, and to 2 decimal places for reports. If your company is subscribed to Contracts, the value of Unit cost precision. Sales must either be blank or 10. In this scenario, the best practice is to leave this field blank. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Only for Inventory items. Provide the count, volume, and weight of the item expressed in the base unit of the unit of measure (UOM) so a landed cost is distributed proportionately to the item when a landed cost is distributed across multiple items. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object When replenishment is enabled on the Configure Inventory Control, use this section of fields to include the item in replenishment, which automates the process of identifying when to reorder items and generating purchase orders. The values you enter are used in the replenishment calculations and drive the reorder information displayed for the item on the Replenish Inventory. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The Item details gives wholesale distribution companies the ability to define an item with many more attributes that are unique for their operations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
defaultConversionType | string Default: "quantity" Option to select default conversion type either Quantity or Price Example: "quantity" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isEnabledForContracts | boolean Default: false Set this to true if you want to enable the item for contracts. Example: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kitRevenuePosting | string or null Default: "componentLevel" Kit revenue posting. Example: "componentLevel" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kitRevenuePrinting | string or null Default: "individualComponents" Kit revenue posting. Example: "individualComponents" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Contract Term section is enabled only if contracts is subscribed for item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The fields in this section allow you to set default templates to use for this item when the item is selected in a contract line or as an expense. The user can override these defaults on the contract line or expense. For Non-Inventory (Purchase only) items, only the Expense template fields are applicable. This section is not applicable to Kit and Stockable kit items; | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Created
Bad Request
{- "id": "Dell_15_6_XPS_15_Multi_Touch",
- "name": "Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)",
- "status": "active",
- "description": "Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)",
- "costMethod": "standard",
- "notes": "Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)",
- "itemType": "inventory",
- "productLine": {
- "id": "2"
}, - "kitRevenuePosting": null,
- "substituteItemId": "",
- "inventory": {
- "shippingWeight": 120,
- "glGroup": {
- "id": "Auto GL Group"
}
}, - "sales": {
- "isTaxable": true,
- "basePrice": "1300",
- "taxGroup": {
- "id": "Goods Standard Rate"
}, - "taxSolution": {
- "id": "United Kingdom - VAT"
}, - "isAvailableForDropShip": false,
- "isAvailableForBuyToOrder": false,
- "allowMultipleTaxGroups": false
}, - "purchasing": {
- "standardCost": "1200"
}, - "unitOfMeasure": {
- "id": "Count"
}, - "precision": {
- "inventoryPrecision": 10,
- "purchasingPrecision": 10,
- "salesPrecision": 10,
- "upc": "23342"
}, - "tracking": {
- "enableSerialNo": true,
- "serialMask": "",
- "enableLotCategory": false,
- "lotCategory": "",
- "enableBins": false,
- "enableExpiration": false
}, - "replenishment": {
- "enableReplenishment": true,
- "replenishmentMethod": "reorderPoint",
- "unitOfMeasureDefault": "Each",
- "reorderPoint": 1,
- "safetyStock": 1,
- "reorderQuantity": 1,
- "maximumOrderQuantity": 10
}, - "measurements": {
- "weightUnitOfMeasure": {
- "id": "Grams"
}, - "netWeight": 12,
- "lengthWidthHeightUnitOfMeasure": {
- "id": "Centimeters"
}, - "length": 12.4554,
- "width": 12,
- "height": 12,
- "thicknessUnitOfMeasure": {
- "id": "Centimeters"
}, - "thickness": 12,
- "minimumThickness": 12,
- "maximumThickness": 13,
- "areaUnitOfMeasure": {
- "id": "Square Inch"
}, - "area": 12,
- "volumeUnitOfMeasure": {
- "id": "Cubic Centimeters"
}, - "volume": 22,
- "diameterUnitOfMeasure": {
- "id": "Centimeters"
}, - "innerDiameter": 12,
- "outerDiameter": 12,
- "durometerUnitOfMeasure": "22",
- "densityUnitOfMeasure": "grams per cubic centimeter",
- "density": 22
}, - "itemDetails": {
- "universalProductCode": 123456789123,
- "internationalArticleNumber": 1234567891234,
- "isSafetyItem": true,
- "isRestrictedItem": false,
- "isCompliantItem": false,
- "condition": "Good",
- "engineeringAlert": "Verification of Item",
- "specification1": "Dell 15.6 XPS 15",
- "isApprovedByEngineering": true,
- "isApprovedByQualityControl": true,
- "isApprovedBySales": true,
- "primaryCountryOfOrigin": "USA"
}, - "contractTerm": {
- "periodsMeasuredIn": "weeks",
- "numberOfPeriods": 99,
- "isProratedPricingAllowed": false,
- "defaultRenewalTemplate": {
- "id": "SUBInvoiceSameAsOriginalPrcie"
}
}, - "commercial": {
- "brand": "Dell Inspiron",
- "subBrand": "Dell 15 inch",
- "category": "Dell 15.6 XPS 15",
- "subCategory": "Dell 15.6 XPS 15",
- "catalogReference": "Dell 15.6 XPS 15 Multi",
- "color": "Platinum Silver",
- "size1": "12",
- "size2": "12",
- "isGiftCard": true,
- "isWebEnabled": true,
- "webName": "Dell Inspiration 15 inch LED",
- "webShortDiscription": "Dell Inspiration 15 inch LED",
- "webLongDescription": "Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)",
- "defaultConversionType": "quantity"
}, - "enableFulfillment": false,
- "itemVendor": [
- {
- "vendor": {
- "key": "12"
}, - "stockNumber": "#5678901234",
- "leadTime": 15,
- "demandForecastDuringLeadTime": 5,
- "economicalOrderQuantity": 10,
- "vendorMinimumOrderQuantity": 10,
- "isPreferredVendor": true
}
], - "warehouseInfo": [
- {
- "warehouse": {
- "key": "2"
}, - "storageArea": "Bella",
- "economicOrderQuantity": 10,
- "reorderPoint": 1,
- "reorderQuantity": 10,
- "minOrderQuantity": 10,
- "maxOrderQuantity": 100,
- "maximumStock": 300,
- "minimumStock": 50,
- "safetyStock": 20,
- "replenishmentMethod": "reorderPoint",
- "enableReplenishment": false
}
], - "landedCost": {
- "enableLandedCost": true
}
}
{- "ia::result": {
- "key": "2458",
- "id": "Dell_15_6_XPS_15_Multi_Touch",
- "href": "/objects/inventory-control/item/104"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified item.
key required | string System-assigned unique key for the item. |
OK
Bad Request
{- "ia::result": {
- "key": "2458",
- "id": "Dell_15_6_XPS_15_Multi_Touch_1",
- "status": "active",
- "isItemEnabledForMRR": false,
- "name": "Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)",
- "description": "12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo)",
- "poDescription": "XPS 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo)",
- "soDescription": "XPS 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo)",
- "productLine": {
- "id": "2",
- "key": "2",
- "href": "/objects/inventory-control/product-line/2"
}, - "contractDefault": {
- "billingTemplate": {
- "key": "8",
- "id": "100_Advance_One_time"
}, - "revRecTemplate1": {
- "key": "6",
- "id": "Daily_Rate_Auto",
- "href": "/objects/contracts/revenue-template/6"
}, - "revRecTemplate2": {
- "key": "6",
- "id": "Daily_Rate_Auto",
- "href": "/objects/contracts/revenue-template/6"
}, - "expenseTemplate1": {
- "key": "1",
- "id": "Exp_Daily_Auto",
- "href": "/objects/contracts/expense-template/1"
}, - "expenseTemplate2": {
- "key": "1",
- "id": "Exp_Daily_Auto",
- "href": "/objects/contracts/expense-template/1"
}, - "isDefaultBundle": false,
- "contractFairValueCategory": {
- "key": "6",
- "id": "Miscellaneous on demand services"
}, - "defaultContractDeliveryStatus": "delivered",
- "defaultContractDeferralStatus": "deferRevenueUntilItemIsDelivered"
}, - "substituteItemId": "",
- "inventory": {
- "shippingWeight": 120,
- "glGroup": {
- "incomeGLAccount": "1300",
- "expenseGLAccount": "1200",
- "inventoryGLAccount": "1500",
- "cogsGLAccount": "1200",
- "arGLAccountNumber": "1400",
- "apGLAccountNumber": "1100",
- "deferredRevenueGLAccountNumber": "1250",
- "defaultRevenueRecognitionTemplate": "",
- "id": "Auto GL Group"
}, - "autoPrintLabel": false
}, - "dateLastSold": "2023-12-15",
- "dateLastReceived": "2023-12-16",
- "sales": {
- "isTaxable": true,
- "taxGroup": {
- "id": "Goods Standard Rate",
- "key": "6",
- "href": "/objects/tax/item-tax-group/19"
}, - "taxSolution": {
- "id": "United Kingdom - VAT",
- "key": "3",
- "href": "/objects/tax/tax-solution/3"
}, - "isAvailableForDropShip": false,
- "isAvailableForBuyToOrder": false,
- "basePrice": "1300",
- "allowMultiPleTaxGroups": false
}, - "costMethod": "standard",
- "purchasing": {
- "standardCost": "1200"
}, - "unitOfMeasureGroup": {
- "id": "Count",
- "key": "1",
- "href": "/objects/inventory-control/unit-of-measure-group/1"
}, - "notes": "Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)",
- "precision": {
- "inventoryPrecision": 10,
- "purchasingPrecision": 10,
- "salesPrecision": 10,
- "upc": "2"
}, - "itemType": "inventory",
- "tracking": {
- "enableSerialNo": true,
- "serialMask": "",
- "enableLotCategory": false,
- "lotCategory": "",
- "enableBins": false,
- "enableExpiration": false
}, - "kitRevenuePosting": null,
- "kitRevenuePrinting": null,
- "vsoeCategory": "productSpecified",
- "vsoeDefaultDeliveryStatus": "delivered",
- "vsoeDefaultDeferralStatus": "deferUntilItemIsDelivered",
- "contractTerm": {
- "isStartDateAndEndDateEnabled": false,
- "periodsMeasuredIn": "weeks",
- "numberOfPeriods": 99,
- "isProratedPricingAllowed": false,
- "defaultRenewalTemplate": {
- "id": "SUBInvoiceSameAsOriginalPrcie",
- "key": "18"
}
}, - "landedCost": {
- "enableLandedCost": true
}, - "audit": {
- "createdDateTime": "2023-12-15T10:53:10Z",
- "modifiedDateTime": "2023-12-15T10:53:10Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "quantityOnOrder": "2",
- "quantityOnHand": "2",
- "quantityOnHold": "1",
- "quantityAllocated": "0",
- "quantityReserved": "0",
- "quantityUncommitted": "0",
- "quantityInTransit": "0",
- "replenishment": {
- "enableReplenishment": true,
- "replenishmentMethod": "reorderPoint",
- "unitOfMeasureDefault": "Each",
- "reorderPoint": 1,
- "safetyStock": 1,
- "reorderQuantity": 1,
- "maximumOrderQuantity": 10
}, - "measurements": {
- "weightUnitOfMeasure": {
- "id": "Grams",
- "key": "15",
- "href": "/objects/inventory-control/unit-of-measure/15"
}, - "netWeight": 500,
- "lengthWidthHeightUnitOfMeasure": {
- "id": "inch",
- "key": "8",
- "href": "/objects/inventory-control/unit-of-measure/8"
}, - "length": 12.4554,
- "width": 12,
- "height": 12,
- "thicknessUnitOfMeasure": {
- "id": "inch",
- "key": "8",
- "href": "/objects/inventory-control/unit-of-measure/8"
}, - "thickness": 2,
- "minimumThickness": 1,
- "maximumThickness": 3,
- "areaUnitOfMeasure": {
- "id": "Square Inch",
- "key": "37",
- "href": "/objects/inventory-control/unit-of-measure/37"
}, - "area": 12,
- "volumeUnitOfMeasure": {
- "id": "Cubic Centimeters",
- "key": "28",
- "href": "/objects/inventory-control/unit-of-measure/28"
}, - "volume": 22,
- "diameterUnitOfMeasure": {
- "id": "inch",
- "key": "8",
- "href": "/objects/inventory-control/unit-of-measure/8"
}, - "innerDiameter": 15,
- "outerDiameter": 16,
- "durometerUnitOfMeasure": "22",
- "densityUnitOfMeasure": "grams per cubic centimeter",
- "density": 22
}, - "itemDetails": {
- "universalProductCode": 123456789123,
- "internationalArticleNumber": 1234567891234,
- "isSafetyItem": true,
- "isRestrictedItem": false,
- "isCompliantItem": false,
- "condition": "Good",
- "engineeringAlert": "Verification of Item",
- "specification1": "Dell Inspiration 15 inch LED",
- "specification2": "",
- "specification3": "",
- "isApprovedByEngineering": true,
- "isApprovedByQualityControl": true,
- "isApprovedBySales": true,
- "primaryCountryOfOrigin": "USA"
}, - "commercial": {
- "brand": "Dell Inspiron",
- "subBrand": "Dell 15 inch",
- "category": "Dell 15.6 XPS 15",
- "subCategory": "Dell 15.6 XPS 15",
- "catalogReference": "Dell 15.6 XPS 15 Multi",
- "color": "Silver",
- "style": "15 inch multi touch",
- "size1": "12",
- "size2": "12",
- "isGiftCard": false,
- "isWebEnabled": true,
- "webName": "Dell Inspiration 15 inch LED",
- "webShortDiscription": "Dell Inspiration 15 inch LED",
- "webLongDescription": "Dell Inspiration 15 inch LED"
}, - "defaultConversionType": "quantity",
- "enableFulfillment": false,
- "isEnabledForContracts": false,
- "itemVendor": [
- {
- "id": "84",
- "key": "84",
- "item": {
- "id": "Dell_15_6_XPS_15_Multi_Touch_1",
- "key": "2458",
- "href": "/objects/inventory-control/item/2458"
}, - "vendor": {
- "id": "vendorId-1702543576--vendorId-1702543576",
- "key": "2386",
- "href": "/objects/accounts-payable/vendor/2386"
}, - "stockNumber": "#5678901234",
- "leadTime": 15,
- "demandForecastDuringLeadTime": 5,
- "economicalOrderQuantity": 10,
- "vendorMinimumOrderQuantity": 10,
- "bestPrice": "1000.00",
- "latestPrice": "1100.00",
- "unitOfMeasure": {
- "id": "Each",
- "key": "3",
- "href": "/objects/inventory-control/unit-of-measure/3"
}, - "conversionFactor": "1",
- "isPreferredVendor": true,
- "href": "/objects/inventory-control/item-vendor/84"
}
], - "warehouseInfo": [
- {
- "id": "80",
- "key": "80",
- "item": {
- "key": "2458",
- "id": "Dell_15_6_XPS_15_Multi_Touch_1",
- "href": "/objects/inventory-control/item/2458"
}, - "warehouse": {
- "key": "2",
- "id": "WH02",
- "href": "/objects/inventory-control/warehouse/2"
}, - "storageArea": "Bella",
- "inventoryCycle": {
- "key": "",
- "id": ""
}, - "standardCost": "1200.00",
- "lastCost": "1500.00",
- "averageCost": "1450.00",
- "reorderMethod": null,
- "economicOrderQuantity": 10,
- "reorderPoint": 1,
- "reorderQuantity": 10,
- "minOrderQuantity": 10,
- "maxOrderQuantity": 100,
- "maximumStock": 300,
- "minimumStock": 50,
- "lastSoldDate": "2024-12-01",
- "lastReceivedDate": "2023-12-12",
- "defaultBin": {
- "id": "",
- "key": ""
}, - "onOrder": 2,
- "inTransit": 0,
- "onHand": 2,
- "onHold": 1,
- "reserved": 0,
- "allocated": 0,
- "unCommitted": 0,
- "warehouseLocation": {
- "key": "",
- "currency": "",
- "id": ""
}, - "safetyStock": 20,
- "replenishmentMethod": "reorderPoint",
- "enableReplenishment": true,
- "standardCostEntries": [ ],
- "itemWarehouseVendor": [ ],
- "href": "/objects/inventory-control/item-warehouse-inventory/80"
}
], - "kitComponents": [ ],
- "itemLandedCost": [
- {
- "id": "74",
- "key": "74",
- "item": {
- "id": "Dell_15_6_XPS_15_Multi_Touch_1",
- "key": "2458",
- "href": "/objects/inventory-control/item/2458"
}, - "distributionMethod": "count",
- "distributionMethodBaseUnit": "Each",
- "landedCostValue": "1.000000000",
- "active": false,
- "href": "/objects/inventory-control/item-landed-cost/74"
}, - {
- "id": "75",
- "key": "75",
- "item": {
- "id": "Dell_15_6_XPS_15_Multi_Touch_1",
- "key": "2458",
- "href": "/objects/inventory-control/item/2458"
}, - "distributionMethod": "volume",
- "distributionMethodBaseUnit": "Teaspoon",
- "landedCostValue": "",
- "active": false,
- "href": "/objects/inventory-control/item-landed-cost/75"
}, - {
- "id": "76",
- "key": "76",
- "item": {
- "id": "Dell_15_6_XPS_15_Multi_Touch_1",
- "key": "2458",
- "href": "/objects/inventory-control/item/2458"
}, - "distributionMethod": "weight",
- "distributionMethodBaseUnit": "Ounce",
- "landedCostValue": "",
- "active": false,
- "href": "/objects/inventory-control/item-landed-cost/76"
}
], - "href": "/objects/inventory-control/item/2458"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing item by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned unique key for the item. |
name | string <= 100 characters Unique name for the item. Example: "Dell Laptop 13inch" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableFulfillment | boolean Default: false Set this field to true if you want to enable fulfillment for non inventory item. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isItemEnabledForMRR | boolean Default: false Whether to include the item in the Software Digital Board Book calculations of monthly recurring revenue. Changing an item's MRR field only affects new transactions or contract lines going forward. It will not affect existing transactions or contract lines. The best practice is to not change an item's MRR setting once the item has been used in a transaction. If you need to change your item's MRR configuration after implementing Digital Board Book (DBB), contact your Sage Intacct account manager for more information. This field is only applicable if your company subscribes to the Software Digital Board Book. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Provide product line to which this item belongs. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedDescription | string <= 400 characters Provide a detailed description of the item. This is most useful if you have many items that have only slight variations. The description is used as the default Item description when the item is entered in Order Entry, Purchasing, and Inventory Control transactions. Example: "13 inch dell laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
poDescription | string <= 400 characters Use this field to provide a purchase transaction description that was used in a legacy accounting system during implementation or to provide additional item details for internal reporting. This description does not appear in any transactions and does not print on any documents. Example: "13 inch dell laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
soDescription | string <= 400 characters Use this field to provide a sales transaction description that was used in a legacy accounting system during implementation or to provide additional item details for internal reporting. This description does not appear in any transactions and does not print on any documents. Example: "13 inch dell laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Unit of measure group for the item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notes | string <= 1000 characters Notes or detailed information not captured elsewhere. Example: "Dell 13 inch laptop" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vsoeCategory | string or null Default: null Fair value category. Example: "software" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vsoeDefaultDeliveryStatus | string or null Default: "delivered" VSOE default delivery status. Example: "delivered" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vsoeDefaultDeferralStatus | string or null Default: "deferUntilItemIsDelivered" VSOE default deferral status. Example: "deferUntilItemIsDelivered" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
substituteItemId | string Substitute item ID Example: "Dell Laptop 14inch" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Provide information about if item is tracked by serial, lot, bin, expiration date, or any combination of those. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object These numbers override the default precision, or number of decimal places, for this item in the Inventory Control, Order Entry, and Purchasing applications. For example, an item with a cost of $0.00456 requires five decimal places. Depending on your needs, you can assign the item a different precision in each application. For example, you can enter 4 in Purchasing and Inventory and 2 in Sales. The default precision as shipped from Intacct is two decimal places for each application. However, for Order Entry and Purchasing, you can change this default to a precision of up to 10 decimal places in the application's configuration. While Sage Intacct uses the number of decimal places specified here for the item in transactions, it rounds values to 10 decimal places for costing calculations, to 2 decimal places for the General Ledger, and to 2 decimal places for reports. If your company is subscribed to Contracts, the value of Unit cost precision. Sales must either be blank or 10. In this scenario, the best practice is to leave this field blank. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Only for Inventory items. Provide the count, volume, and weight of the item expressed in the base unit of the unit of measure (UOM) so a landed cost is distributed proportionately to the item when a landed cost is distributed across multiple items. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object When replenishment is enabled on the Configure Inventory Control, use this section of fields to include the item in replenishment, which automates the process of identifying when to reorder items and generating purchase orders. The values you enter are used in the replenishment calculations and drive the reorder information displayed for the item on the Replenish Inventory. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The Item details gives wholesale distribution companies the ability to define an item with many more attributes that are unique for their operations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
defaultConversionType | string Default: "quantity" Option to select default conversion type either Quantity or Price Example: "quantity" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isEnabledForContracts | boolean Default: false Set this to true if you want to enable the item for contracts. Example: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kitRevenuePosting | string or null Default: "componentLevel" Kit revenue posting. Example: "componentLevel" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kitRevenuePrinting | string or null Default: "individualComponents" Kit revenue posting. Example: "individualComponents" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Contract Term section is enabled only if contracts is subscribed for item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The fields in this section allow you to set default templates to use for this item when the item is selected in a contract line or as an expense. The user can override these defaults on the contract line or expense. For Non-Inventory (Purchase only) items, only the Expense template fields are applicable. This section is not applicable to Kit and Stockable kit items; | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
OK
Bad Request
{- "description": "12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up to 4.40 GHz Turbo)",
- "itemLandedCost": [
- {
- "key": "74",
- "distributionMethod": "count",
- "landedCostValue": "1.000000000",
- "active": true
}
]
}
{- "ia::result": {
- "key": "2458",
- "id": "Dell_15_6_XPS_15_Multi_Touch",
- "href": "/objects/inventory-control/item/104"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an item.
key required | string System-assigned unique key for the item. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "inventory-control/item" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "inventory-control/item",
- "filters": [
- {
- "$eq": {
- "itemType": "kit"
}
}
], - "fields": [
- "key",
- "id",
- "name",
- "itemType"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "8",
- "id": "BND01-06",
- "name": "License and Maintenance 6 month Contract",
- "itemType": "kit"
}, - {
- "key": "7",
- "id": "BND01-12",
- "name": "License and Maintenance 12 month Contract",
- "itemType": "kit"
}, - {
- "key": "26",
- "id": "BND01-12 (2 License Prods)",
- "name": "License and Maintenance 24 month Contract",
- "itemType": "kit"
}, - {
- "key": "24",
- "id": "BND01-12 (3Prod)",
- "name": "License and Maintenance 30 month Contract",
- "itemType": "kit"
}, - {
- "key": "25",
- "id": "BND01-12 (4Prod)",
- "name": "License and Maintenance 36 month Contract",
- "itemType": "kit"
}, - {
- "key": "22",
- "id": "BND01-12-KIT Level Rev",
- "name": "LIcense and Maintenance 42 month Contract",
- "itemType": "kit"
}, - {
- "key": "9",
- "id": "BND02-12",
- "name": "License, Maintenance, Services, and Training 12 month Contract",
- "itemType": "kit"
}, - {
- "key": "75",
- "id": "FV-Kit-01",
- "name": "Software, Services, and Support",
- "itemType": "kit"
}
], - "ia::meta": {
- "totalCount": 8,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}