Items

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.

List items

get/objects/inventory-control/item

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.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "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
    }
}

Create an item

post/objects/inventory-control/item

Creates a new item.

SecurityOAuth2
Request
Request Body schema: application/json
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.

Enum: "inventory" "kit" "nonInventory" "purchaseOnlyNonInventory" "salesOnlyNonInventory" "stockableKit"
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.

Enum: "FIFO" "LIFO" "average" null "standard"
Example: "standard"
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
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.

key
string <= 8 characters

Record number of product line

Example: "59"
id
string <= 30 characters

ID of the product line to which the item belongs.

Example: "1233"
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.

key
string <= 8 characters

System-assigned key for the unit of measure group.

Example: "10"
id
string

Unique identifier for the unit of measure group.

Example: "10"
notes
string <= 1000 characters

Notes or detailed information not captured elsewhere.

Example: "Dell 13 inch laptop"
object
shippingWeight
number <= 10 characters

Total shipping weight for the item.

Example: 1233
autoPrintLabel
boolean
Default: false

Set to true if using a third-party label scanner to print barcode labels when processing the item in purchasing transactions. When set to true, this field triggers label printing for the received quantity. This field is used with scanner integrations and has no functionality within Sage Intacct. This field applies to inventory items and stockable kits only if the Integrated scanner product in use option is enabled during inventory control configuration.

Example: false
object

The GL group to which the item belongs.

id
string

Unique identifier for the GL group.

Example: "1501.0"
defaultRevenueRecognitionTemplate
string

Default revenue recognition template ID.

Example: "1232"
incomeGLAccount
string

Revenue GL account number.

Example: "12322"
inventoryGLAccount
string

Inventory GL account number

Example: "12322"
expenseGLAccount
string

Expense GL account number

Example: "12322"
cogsGLAccount
string

COGS GL account number

Example: "12322"
arGLAccountNumber
string

AR GL account number

Example: "12322"
apGLAccountNumber
string

AP GL account number

Example: "12322"
deferredRevenueGLAccountNumber
string

Deferred revenue GL account number

Example: "12322"
vsoeCategory
string or null
Default: null

Fair value category.

Enum: null "postContractSupport" "productSpecified" "productUnspecified" "services" "software" "upgradeSpecified" "upgradeUnspecified"
Example: "software"
vsoeDefaultDeliveryStatus
string or null
Default: "delivered"

VSOE default delivery status.

Enum: "delivered" null "undelivered"
Example: "delivered"
vsoeDefaultDeferralStatus
string or null
Default: "deferUntilItemIsDelivered"

VSOE default deferral status.

Enum: "deferBundleUntilItemIsDelivered" "deferUntilItemIsDelivered" null
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.

enableSerialNo
boolean
Default: false

Serial tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
serialMask
string <= 30 characters

Serial number mask to enforce a specific format. Applicable to inventory or stockable kit item types.

Example: "XXAS"
enableLotCategory
boolean
Default: false

Lot tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
lotCategory
string <= 30 characters

Lot category. Applicable to inventory or stockable kit item types.

Example: "Kitchen"
enableBins
boolean
Default: false

Bin tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
enableExpiration
boolean
Default: false

Expiration tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
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.

upc
string <= 40 characters

Universal Product Code (UPC) for the item.

Example: "23342"
inventoryPrecision
integer <= 2 characters

Inventory unit cost precision

Example: 2
salesPrecision
integer <= 2 characters

Sales unit cost precision

Example: 2
purchasingPrecision
integer <= 2 characters

Sales unit cost precision

Example: 2
object
enableLandedCost
boolean
Default: false

For inventory items set true to have Sage Intacct distribute landed costs to this item. For Non-inventory and Non-inventory (purchase only) set this field to to identify the item as a landed cost. These items are used to enter the actual landed cost amounts (such as for shipping, insurance, and customs) for which you’re invoiced after purchasing inventory items.

Example: false
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
distributionMethod
string

The distribution method for the item landed cost. The distribution method provides a fair distribution of landed costs across multiple items.

Enum: "count" "volume" "weight"
Example: "count"
landedCostValue
string <decimal-precision-9> >= 0

This field establishes how the landed cost is distributed for the associated item. This value should be appropriate for the unit of measure (UOM) for the item. For example, if the distribution method is weight and the base unit for the item is ounce, and the item weighs 1 pound, a value of 16 to represent 1 pound in ounces is appropriate.

Example: "16"
active
boolean
Default: false

If set to true, the landed cost value provided will be distributed for the item.

Example: true
object

Item associated with the landed cost.

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.

enableReplenishment
boolean
Default: false

Enable replenishment for this item in the Vendor history.

Example: false
unitOfMeasureDefault
string

Units of measure default for base units for inventory replenishment for this item in the Vendor history. For example, with the Count unit of measure group, you can specify each, dozen, or pair. See the information about unit of measure groups in the Sage Intacct product help.

Example: "Each"
safetyStock
integer <= 10 characters
Default: 0

Safety stock for this item in the Vendor history. Extra quantity held in inventory to reduce the risk of stock outs due to uncertainty in supply and demand.

Example: 2
maximumOrderQuantity
integer <= 10 characters
Default: 0

Maximum order quantity for this item in the Vendor history. Largest amount you can order in any one order. The provided may be affected by the economic order quantity and/or unit of measure set on the vendor.

Example: 10
replenishmentMethod
string
Default: ""

Replenishment method for this item in the Vendor history. Provide how the amount to reorder is calculated. Reorder point - base calculation on a specific reorder quantity and optional safety stock quantity Demand forecast by single value - base calculation on lead time for the vendor Demand forecast by statistical account - base calculation on statistical journal entries for a statistical account (statistical account must be configured for inventory) See the information about replenishment methods and calculations in the Sage Intacct product help.

Enum: "" "demandForecastByFluctuatingValues" "demandForecastBySingleValue" "reorderPoint"
Example: "reorderPoint"
reorderPoint
integer <= 10 characters >= 0

Reorder point specifying the quantity of inventory that you don’t want to fall below. When the current net inventory falls to the reorder point plus the safety stock, the item is triggered for reorder. Use blank or positive integers. Applies when the replenishmentMethod is Reorder point

Example: 1
reorderQuantity
integer <= 10 characters
Default: 0

Reorder quantity for this item in the Vendor history. As an example, if 12 units are needed according to other replenishment calculations, a reorder quantity of 50 would cause the generated purchase order to be for 50. Applies when the replenishmentMethod is Reorder point

Example: 1
forecastDemandInLeadTime
integer <= 10 characters >= 0
Default: 1

Forecast demand in lead time. Provide the quantity of this item expected to be sold during the lead time. Valid values are blank, 0, and positive integers. Only applicable when the REPLENISHMENT_METHOD is Demand forecast by a single value. Only applicable when the replenishmentMethod is Demand forecast by a single value.

Example: 1
object

The Item details gives wholesale distribution companies the ability to define an item with many more attributes that are unique for their operations.

primaryCountryOfOrigin
string <= 30 characters

Primary country of origin.

Example: "China 75%"
condition
string <= 30 characters

Condition name or descriptor.

Example: "good"
engineeringAlert
string <= 30 characters

Engineering Alert name or descriptor.

Example: "Software Setup"
specification1
string <= 30 characters

Specification name/descriptor 1.

Example: "length 12 cm"
specification2
string <= 30 characters

Specification name/descriptor 2.

Example: "width 12 cm"
specification3
string <= 30 characters

Specification name/descriptor 3.

Example: "height 13 cm"
universalProductCode
integer <= 12 characters

UPC-12, the 12-digit Universal Product Code of the item.

Example: 123456789123
internationalArticleNumber
integer <= 13 characters

EAN-13, the 13-digit International Article Number of the item.

Example: 1234567891234
isSafetyItem
boolean
Default: false

Use true if item is classified as a Safety Item.

Example: true
isRestrictedItem
boolean
Default: false

Use true if item is classified as a Restricted Item.

Example: true
isCompliantItem
boolean
Default: false

Use true if item is classified as a Compliant Item.

Example: true
isApprovedByEngineering
boolean
Default: false

Use true if item is approved by engineering.

Example: true
isApprovedByQualityControl
boolean
Default: false

Use true if item is approved by quality control.

Example: true
isApprovedBySales
boolean
Default: false

Use true if item is approved by sales.

Example: true
object
object

Provide shipWeight without weightUnitOfMeasure or netWeight, but if you provide netWeight you must also specify the other two. weightUnitOfMeasure must be set to one of the values defined for the Weight unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "Grams"
key
string <= 8 characters

system generated key of unit of measure

Example: "25"
netWeight
number <= 13 characters

Net weight of item.

Example: 1.67
object

The size of the item, useful for calculating storage bin and shipping box size requirements. Specify the unit of measure and the length, width, and height. You must specify all four values or none. lengthWidthHeightUnitOfMeasure must be set to one of the values defined for the length unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "inches"
key
string <= 8 characters

system generated key of unit of measure

Example: "21"
length
number <= 13 characters

Length of item.

Example: 10
width
number <= 13 characters

Width of item.

Example: 23
height
number <= 13 characters

Height of item.

Example: 11.23
object

The thickness of the item, useful for calculating storage bin or shipping box size requirements. Specify the unit of measure, actual thickness, and minimum and maximum thickness. You must specify all four values or none. If the item thickness does not vary, set all three thickness fields to the same value. thicknessUnitOfMeasure must be set to one of the values defined for the length unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "inches"
key
string <= 8 characters

system generated key of unit of measure

Example: "21"
thickness
number <= 13 characters <= 99999999.99

Thickness of Item

Example: 10
minimumThickness
number <= 13 characters <= 99999999.99

Minimum thickness of Item

Example: 23
maximumThickness
number <= 13 characters <= 99999999.99

Maximum thickness of Item

Example: 11.23
object

The area of the item. You must specify both or neither. areaUnitOfMeasure must be set to one of the values defined for the Area unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "Square Feet"
key
string <= 8 characters

system generated key of unit of measure

Example: "22"
area
number <= 13 characters

Area of Item

Example: 0.567
object

The item unit of measure and total volume. You must specify both or neither. volumeUnitOfMeasure must be set to one of the values defined for the Volume unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "Cubic Meter"
key
string <= 8 characters

system generated key of unit of measure

Example: "24"
volume
number <= 13 characters

Volume of Item

Example: 0.789
densityUnitOfMeasure
string

The density of the item unit of measure and density value.

Example: "Cubic Meter"
density
number <= 13 characters

Density of Item

Example: 0.789
durometerUnitOfMeasure
string <= 10 characters

Durometer (hardness) measurement of the item.

Example: "10"
object

The diameter of the item Unit of measure, and inner and outer diameter. You must specify all three or none. DIAMETERUOM must be set to one of the values defined for the length unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "inches"
key
string <= 8 characters

system generated key of unit of measure

Example: "21"
innerDiameter
number <= 13 characters

Inner Diameter of Item

Example: 12
outerDiameter
number <= 13 characters

Outer Diameter of Item

Example: 13.5
object
brand
string <= 30 characters

Brand of the item.

Example: "Touch Screen"
subBrand
string <= 30 characters

Sub brand of the item.

Example: "Touch Screen with LED"
category
string <= 30 characters

Category of the item.

Example: "Touch Screen with LED"
subCategory
string <= 30 characters

Sub category of the item.

Example: "Touch Screen with LED"
catalogReference
string <= 30 characters

Catalog reference for the item.

Example: "Touch Screen with LED laptops"
color
string <= 30 characters

Catalog reference for the item.

Example: "black"
size1
string <= 30 characters

Size 1 of the item.

Example: "13"
size2
string <= 30 characters

Size 2 of the item.

Example: "12"
style
string <= 30 characters

Style of the item.

Example: "12"
webName
string <= 100 characters

Name of the item to appear on the web.

Example: "Dell Inspiration"
webShortDiscription
string <= 1000 characters

Short description for the web.

Example: "Dell Inspiration 13 inch LED"
webLongDescription
string <= 2000 characters

Long description for the web.

Example: "Dell Inspiration 13 inch LED touchscreen"
isGiftCard
boolean
Default: false

Use true if item is gift card.

Example: true
isWebEnabled
boolean
Default: false

Use true if item is web enabled.

Example: true
defaultConversionType
string
Default: "quantity"

Option to select default conversion type either Quantity or Price

Enum: "price" "quantity"
Example: "quantity"
object
standardCost
string <decimal-precision-10> <= 15 characters

Standard cost value for the item.

Example: "1501.04"
object
isTaxable
boolean
Default: false

Set to true if the sale of the item is taxable.

Example: true
basePrice
string <decimal-precision-10> <= 15 characters

Base price for the item.

Example: "1000"
isAvailableForDropShip
boolean
Default: false

Available for drop ship

Example: false
isAvailableForBuyToOrder
boolean
Default: false

Available for buy to order

Example: false
object

The tax group to assign the item to.

key
string

System-assigned key for the tax group.

Example: "1000"
id
string

Unique identifier for the tax group.

Example: "Acme Company Customers"
object

The tax solution to assign the item to.

key
string

System-assigned key for the tax solution.

Example: "1000"
id
string

Unique identifier for the tax solution.

Example: "Acme Company Customers"
allowMultipleTaxGroups
boolean
Default: false

Allow multiple item tax groups per item, which is needed when an item is taxed at different rates in different tax jurisdictions. Allow multiple item tax groups. When you set this to true and provide an itemTaxMap, the tax group at the header level is ignored and the mapping is used instead.

Example: false
Array of objects
Array
object

Inventory item.

object

Tax solution associated with the tax group.

object

The tax group to which the item is assigned.

Array of objects
Array
object

Details for the good, service, or kit that is purchased or sold.

object

Details for the warehouse or stocking location for the item.

storageArea
string

Location within the warehouse where the item is normally stored, such as Aisle 23, Row 12, Shelf 3, Bin 5.

Example: "Bin 5"
object

Inventory cycles are used to keep track of when to take physical inventory.

economicOrderQuantity
integer

The quantity that makes the cost of reordering this item the most economical by minimizing total holding costs and total ordering costs.

Example: 10
standardCost
string

The planned or expected costs. Used in situations where purchase costs remain relatively stable over time.

Example: "110"
reorderPoint
integer

Value used as the starting point to determine when the item needs to be replenished.

Example: 121
reorderQuantity
integer

When current net inventory falls to the reorder point plus the safety stock, the item is triggered for reorder with reorder quantity.

Example: 10
minOrderQuantity
integer

The minimum quantity to be reordered at one time.

Example: 10
maxOrderQuantity
integer

The maximum quantity to be reordered at one time.

Example: 100
maximumStock
integer

The quantity of the item you do not want to exceed in the inventory.

Example: 300
minimumStock
integer

The quantity of the item you do not want to fall below in the inventory.

Example: 50
object

Default bin details for the item.

safetyStock
integer

The extra quantity to have in inventory to avoid running out of stock.

Example: 20
replenishmentMethod
string or null
Default: null

Replenishment method to use to automatically identify and reorder items when inventory is low.

Enum: "demandForecastByFluctuatingValues" "demandForecastBySingleValue" null "reorderPoint"
Example: "reorderPoint"
enableReplenishment
boolean
Default: true

Set replenishment to true to replenish the items.

Example: true
Array of objects

Only required when override replenishment values on the enableReplenishment is set to true. Provide vendor information you want to use in the replenishment calculations for the item in this warehouse.

Array of objects

You can provide the standard cost of the item for the warehouse. You can use different standard costs for different date ranges.

Array of objects
Array
object

The item that can be ordered from the vendor.

object

The vendor the item can be ordered from.

stockNumber
string

The stock number that vendor uses for this item.

Example: "#5678901234"
leadTime
integer

The number of days it takes the vendor to deliver this item to you after receiving the order.

Example: 15
demandForecastDuringLeadTime
integer

The quantity of this item that's expected to be sold during the lead time.

Example: 5
economicalOrderQuantity
integer

The quantity that makes the cost of reordering this item the most economical.

Example: 10
vendorMinimumOrderQuantity
integer

The minimum quantity of this item the vendor is willing to sell.

Example: 10
object

The unit of measure the vendor sells this item in.

isPreferredVendor
boolean
Default: false

Identifies a preferred vendor for replenishing this item for warehouses that do not have a vendor specified.

Example: false
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.

Enum: "componentLevel" "kitLevel" null
Example: "componentLevel"
kitRevenuePrinting
string or null
Default: "individualComponents"

Kit revenue posting.

Enum: "individualComponents" "kit" null
Example: "individualComponents"
Array of objects
Array
object

Kit is item of type kit or stockable kit.

object

Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit).

numberOfUnits
number

Number of component units required in this kit.

Example: 1
revenuePercentage
number [ 0 .. 100 ]

When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage.

Example: 10
defaultDeliveryStatus
string
Default: "delivered"

Default that will indicate the most common delivery status of this item when it's sold.

Enum: "delivered" "undelivered"
Example: "delivered"
defaultDeferralStatus
string
Default: "deferUntilItemIsDelivered"

Choose whether to defer until this item is delivered or until the entire bundle is delivered.

Enum: "deferBundleUntilItemIsDelivered" "deferUntilItemIsDelivered"
Example: "deferUntilItemIsDelivered"
lineNumber
integer

Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers.

Example: 1
object

Contract Term section is enabled only if contracts is subscribed for item.

isStartDateAndEndDateEnabled
boolean
Default: false

Set this field to identify this item as having a default term. In Order Entry transactions, this also makes this item eligible for renewals and price proration. For Contracts, Set this to true if you want to set up automatic price proration for this item.

Example: false
periodsMeasuredIn
string or null
Default: "days"

Provide the period of duration to use to measure the item's term.

Enum: "days" "months" null "weeks" "years"
Example: "days"
numberOfPeriods
integer <= 4 characters

Enter the default number of periods to include in the item's term. For example, if Periods measured in is Months and Number of periods is 6, then the item's default term is 6 months. Required if you set isStartDateAndEndDateEnabled to true.

Example: 2
isProratedPricingAllowed
boolean
Default: false

Set this field to true if you want the system to automatically prorate the price when the sales transaction line or contract line term is less than the item's default term. For Order Entry, this field prorates the fair value in a multiple-element arrangement (when also subscribed to Advanced Revenue Management). For Order Entry only, leave this checkbox cleared if you want the option to manually prorate the price using the prorate button in a sales transaction.

Example: false
object

Provide the default renewal instruction set for this item in sales transactions. Only displays if your company is subscribed to Revenue Recognition for Order Entry. This field is not applicable to the Contracts application.

key
string

System-assigned key for the renewal template.

Example: "22"
id
string

Unique identifier for the renewal template.

Example: "Sales Renewal Template US"
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;

object

Provide billing template that would most often be associated with this item.

key
string

System-assigned key for the billing template

Example: "31"
id
string

Unique identifier for the billing template

Example: "Monthly Billing"
object

Provide the default revenue template for the applicable journals. Your Contracts configuration may use one or two sets of revenue journals.

key
string

System-assigned key for the Rev Rec template

Example: "32"
id
string

Unique identifier for the Rev Rec template

Example: "Monthly Billing"
object

Provide the default revenue template for the applicable journals. Your Contracts configuration may use one or two sets of revenue journals. Different from RevRecTemplate1 and RevRecTemplate2 is used for ASC606 standards.

key
string

System-assigned key for the Rev Rec template

Example: "33"
id
string

Unique identifier for the Rev Rec template

Example: "Half Cycle"
object

Provide the default expense template for the applicable journals. Your Contracts configuration may use one or two expense journals.

key
string

System-assigned key for the contract expense template

Example: "33"
id
string

Unique identifier for the contract expense template

Example: "Full Cycle Month Expense 2"
object

Provide the default expense template for the applicable journals. Your Contracts configuration may use one or two expense journals. Different from expenseTemplate1 and expenseTemplate2 is used for ASC606 standards.

key
string

System-assigned key for the contract expense template

Example: "34"
id
string

Unique identifier for the contract expense template

Example: "Half Cycle Month Expense 2"
object

Sage Intacct uses fair value categories to distinguish products or services included in an MEA that will be used in the algorithm that determines another item's estimated standalone selling price. If the item can be sold as part of a multiple-element arrangement, Provide the category that identifies the performance obligation. Learn more about fair value categories in contracts. This field is only applicable if your company is subscribed to Contract Advanced Revenue Recognition.

key
string

System-assigned key for Contract Fair Value Category

Example: "37"
id
string

Unique identifier for the Contract Fair Value Category

Example: "Half Cycle Month Expense 2"
defaultContractDeliveryStatus
string or null
Default: "delivered"

Options are Delivered the contract line's recognition event has occurred Undelivered the contract line's recognition event has not occurred

Enum: "delivered" null "undelivered"
Example: "delivered"
defaultContractDeferralStatus
string or null
Default: "deferRevenueUntilItemIsDelivered"

Defer revenue until item is delivered the revenue schedule for this item will not start until this item has Delivery status = 'Delivered'. Defer revenue until all items are delivered the revenue schedule for this item will not start until all contract lines in the contract have Delivery status = 'Delivered'.

Enum: "deferRevenueUntilAllItemsAreDelivered" "deferRevenueUntilItemIsDelivered" null
Example: "deferRevenueUntilItemIsDelivered"
isDefaultBundle
boolean
Default: false

Set this to true if item is to be included in the default bundle when an MEA allocation that includes this item is created. Users can choose to exclude the item when they create the MEA allocation. This field is only applicable if your company is subscribed to Contract Advanced Revenue Recognition.

Example: true
Array of objects
Array
referenceType
string

Reference type. Use vendor or customer for an external cross reference. Use substitute, upgrade, downgrade, or complement for an internal cross reference.

Enum: "complement" "customer" "downgrade" "substitute" "upgrade" "vendor"
Example: "substitute"
itemAliasId
string or null <= 100 characters
Default: null

Required for an external cross reference. Identifier for the item as understood by the given vendor or customer. Must be unique for the combination of vendor/item or customer/item.

Example: "Logitech - MK825"
itemAliasDescription
string or null <= 50 characters
Default: null

Description of the item alias for the cross reference.

Example: "Logitech - MK825 Wireless Keyboard and Mouse"
object

Valid unit of measure for the item.

object

An alternate item. This field is required when using an internal referenceType, such as substitute or upgrade.

object

The customer ID is required if referenceType is customer.

object

Inventory item to create the cross reference for.

object

The vendor ID is required if referenceType is vendor.

Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "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": {
        },
      • "stockNumber": "#5678901234",
      • "leadTime": 15,
      • "demandForecastDuringLeadTime": 5,
      • "economicalOrderQuantity": 10,
      • "vendorMinimumOrderQuantity": 10,
      • "isPreferredVendor": true
      }
    ],
  • "warehouseInfo": [
    • {
      • "warehouse": {
        },
      • "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
    }
}
Response samples
application/json
{
  • "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
    }
}

Get an item

get/objects/inventory-control/item/{key}

Returns detailed information for a specified item.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the item.

Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "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": {
        },
      • "revRecTemplate1": {
        },
      • "revRecTemplate2": {
        },
      • "expenseTemplate1": {
        },
      • "expenseTemplate2": {
        },
      • "isDefaultBundle": false,
      • "contractFairValueCategory": {
        },
      • "defaultContractDeliveryStatus": "delivered",
      • "defaultContractDeferralStatus": "deferRevenueUntilItemIsDelivered"
      },
    • "substituteItemId": "",
    • "inventory": {
      • "shippingWeight": 120,
      • "glGroup": {
        },
      • "autoPrintLabel": false
      },
    • "dateLastSold": "2023-12-15",
    • "dateLastReceived": "2023-12-16",
    • "sales": {
      • "isTaxable": true,
      • "taxGroup": {
        },
      • "taxSolution": {
        },
      • "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": {
        }
      },
    • "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": {
        },
      • "netWeight": 500,
      • "lengthWidthHeightUnitOfMeasure": {
        },
      • "length": 12.4554,
      • "width": 12,
      • "height": 12,
      • "thicknessUnitOfMeasure": {
        },
      • "thickness": 2,
      • "minimumThickness": 1,
      • "maximumThickness": 3,
      • "areaUnitOfMeasure": {
        },
      • "area": 12,
      • "volumeUnitOfMeasure": {
        },
      • "volume": 22,
      • "diameterUnitOfMeasure": {
        },
      • "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": [
      • {
        }
      ],
    • "warehouseInfo": [
      • {
        }
      ],
    • "kitComponents": [ ],
    • "itemLandedCost": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "href": "/objects/inventory-control/item/2458"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an item

patch/objects/inventory-control/item/{key}

Updates an existing item by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the item.

Request Body schema: application/json
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.

Enum: "active" "inactive"
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.

key
string <= 8 characters

Record number of product line

Example: "59"
id
string <= 30 characters

ID of the product line to which the item belongs.

Example: "1233"
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.

key
string <= 8 characters

System-assigned key for the unit of measure group.

Example: "10"
id
string

Unique identifier for the unit of measure group.

Example: "10"
notes
string <= 1000 characters

Notes or detailed information not captured elsewhere.

Example: "Dell 13 inch laptop"
object
shippingWeight
number <= 10 characters

Total shipping weight for the item.

Example: 1233
autoPrintLabel
boolean
Default: false

Set to true if using a third-party label scanner to print barcode labels when processing the item in purchasing transactions. When set to true, this field triggers label printing for the received quantity. This field is used with scanner integrations and has no functionality within Sage Intacct. This field applies to inventory items and stockable kits only if the Integrated scanner product in use option is enabled during inventory control configuration.

Example: false
object

The GL group to which the item belongs.

id
string

Unique identifier for the GL group.

Example: "1501.0"
defaultRevenueRecognitionTemplate
string

Default revenue recognition template ID.

Example: "1232"
incomeGLAccount
string

Revenue GL account number.

Example: "12322"
inventoryGLAccount
string

Inventory GL account number

Example: "12322"
expenseGLAccount
string

Expense GL account number

Example: "12322"
cogsGLAccount
string

COGS GL account number

Example: "12322"
arGLAccountNumber
string

AR GL account number

Example: "12322"
apGLAccountNumber
string

AP GL account number

Example: "12322"
deferredRevenueGLAccountNumber
string

Deferred revenue GL account number

Example: "12322"
vsoeCategory
string or null
Default: null

Fair value category.

Enum: null "postContractSupport" "productSpecified" "productUnspecified" "services" "software" "upgradeSpecified" "upgradeUnspecified"
Example: "software"
vsoeDefaultDeliveryStatus
string or null
Default: "delivered"

VSOE default delivery status.

Enum: "delivered" null "undelivered"
Example: "delivered"
vsoeDefaultDeferralStatus
string or null
Default: "deferUntilItemIsDelivered"

VSOE default deferral status.

Enum: "deferBundleUntilItemIsDelivered" "deferUntilItemIsDelivered" null
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.

enableSerialNo
boolean
Default: false

Serial tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
serialMask
string <= 30 characters

Serial number mask to enforce a specific format. Applicable to inventory or stockable kit item types.

Example: "XXAS"
enableLotCategory
boolean
Default: false

Lot tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
lotCategory
string <= 30 characters

Lot category. Applicable to inventory or stockable kit item types.

Example: "Kitchen"
enableBins
boolean
Default: false

Bin tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
enableExpiration
boolean
Default: false

Expiration tracking enabled. Applicable to inventory or stockable kit item types.

Example: false
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.

upc
string <= 40 characters

Universal Product Code (UPC) for the item.

Example: "23342"
inventoryPrecision
integer <= 2 characters

Inventory unit cost precision

Example: 2
salesPrecision
integer <= 2 characters

Sales unit cost precision

Example: 2
purchasingPrecision
integer <= 2 characters

Sales unit cost precision

Example: 2
object
enableLandedCost
boolean
Default: false

For inventory items set true to have Sage Intacct distribute landed costs to this item. For Non-inventory and Non-inventory (purchase only) set this field to to identify the item as a landed cost. These items are used to enter the actual landed cost amounts (such as for shipping, insurance, and customs) for which you’re invoiced after purchasing inventory items.

Example: false
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
distributionMethod
string

The distribution method for the item landed cost. The distribution method provides a fair distribution of landed costs across multiple items.

Enum: "count" "volume" "weight"
Example: "count"
landedCostValue
string <decimal-precision-9> >= 0

This field establishes how the landed cost is distributed for the associated item. This value should be appropriate for the unit of measure (UOM) for the item. For example, if the distribution method is weight and the base unit for the item is ounce, and the item weighs 1 pound, a value of 16 to represent 1 pound in ounces is appropriate.

Example: "16"
active
boolean
Default: false

If set to true, the landed cost value provided will be distributed for the item.

Example: true
object

Item associated with the landed cost.

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.

enableReplenishment
boolean
Default: false

Enable replenishment for this item in the Vendor history.

Example: false
unitOfMeasureDefault
string

Units of measure default for base units for inventory replenishment for this item in the Vendor history. For example, with the Count unit of measure group, you can specify each, dozen, or pair. See the information about unit of measure groups in the Sage Intacct product help.

Example: "Each"
safetyStock
integer <= 10 characters
Default: 0

Safety stock for this item in the Vendor history. Extra quantity held in inventory to reduce the risk of stock outs due to uncertainty in supply and demand.

Example: 2
maximumOrderQuantity
integer <= 10 characters
Default: 0

Maximum order quantity for this item in the Vendor history. Largest amount you can order in any one order. The provided may be affected by the economic order quantity and/or unit of measure set on the vendor.

Example: 10
replenishmentMethod
string
Default: ""

Replenishment method for this item in the Vendor history. Provide how the amount to reorder is calculated. Reorder point - base calculation on a specific reorder quantity and optional safety stock quantity Demand forecast by single value - base calculation on lead time for the vendor Demand forecast by statistical account - base calculation on statistical journal entries for a statistical account (statistical account must be configured for inventory) See the information about replenishment methods and calculations in the Sage Intacct product help.

Enum: "" "demandForecastByFluctuatingValues" "demandForecastBySingleValue" "reorderPoint"
Example: "reorderPoint"
reorderPoint
integer <= 10 characters >= 0

Reorder point specifying the quantity of inventory that you don’t want to fall below. When the current net inventory falls to the reorder point plus the safety stock, the item is triggered for reorder. Use blank or positive integers. Applies when the replenishmentMethod is Reorder point

Example: 1
reorderQuantity
integer <= 10 characters
Default: 0

Reorder quantity for this item in the Vendor history. As an example, if 12 units are needed according to other replenishment calculations, a reorder quantity of 50 would cause the generated purchase order to be for 50. Applies when the replenishmentMethod is Reorder point

Example: 1
forecastDemandInLeadTime
integer <= 10 characters >= 0
Default: 1

Forecast demand in lead time. Provide the quantity of this item expected to be sold during the lead time. Valid values are blank, 0, and positive integers. Only applicable when the REPLENISHMENT_METHOD is Demand forecast by a single value. Only applicable when the replenishmentMethod is Demand forecast by a single value.

Example: 1
object

The Item details gives wholesale distribution companies the ability to define an item with many more attributes that are unique for their operations.

primaryCountryOfOrigin
string <= 30 characters

Primary country of origin.

Example: "China 75%"
condition
string <= 30 characters

Condition name or descriptor.

Example: "good"
engineeringAlert
string <= 30 characters

Engineering Alert name or descriptor.

Example: "Software Setup"
specification1
string <= 30 characters

Specification name/descriptor 1.

Example: "length 12 cm"
specification2
string <= 30 characters

Specification name/descriptor 2.

Example: "width 12 cm"
specification3
string <= 30 characters

Specification name/descriptor 3.

Example: "height 13 cm"
universalProductCode
integer <= 12 characters

UPC-12, the 12-digit Universal Product Code of the item.

Example: 123456789123
internationalArticleNumber
integer <= 13 characters

EAN-13, the 13-digit International Article Number of the item.

Example: 1234567891234
isSafetyItem
boolean
Default: false

Use true if item is classified as a Safety Item.

Example: true
isRestrictedItem
boolean
Default: false

Use true if item is classified as a Restricted Item.

Example: true
isCompliantItem
boolean
Default: false

Use true if item is classified as a Compliant Item.

Example: true
isApprovedByEngineering
boolean
Default: false

Use true if item is approved by engineering.

Example: true
isApprovedByQualityControl
boolean
Default: false

Use true if item is approved by quality control.

Example: true
isApprovedBySales
boolean
Default: false

Use true if item is approved by sales.

Example: true
object
object

Provide shipWeight without weightUnitOfMeasure or netWeight, but if you provide netWeight you must also specify the other two. weightUnitOfMeasure must be set to one of the values defined for the Weight unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "Grams"
key
string <= 8 characters

system generated key of unit of measure

Example: "25"
netWeight
number <= 13 characters

Net weight of item.

Example: 1.67
object

The size of the item, useful for calculating storage bin and shipping box size requirements. Specify the unit of measure and the length, width, and height. You must specify all four values or none. lengthWidthHeightUnitOfMeasure must be set to one of the values defined for the length unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "inches"
key
string <= 8 characters

system generated key of unit of measure

Example: "21"
length
number <= 13 characters

Length of item.

Example: 10
width
number <= 13 characters

Width of item.

Example: 23
height
number <= 13 characters

Height of item.

Example: 11.23
object

The thickness of the item, useful for calculating storage bin or shipping box size requirements. Specify the unit of measure, actual thickness, and minimum and maximum thickness. You must specify all four values or none. If the item thickness does not vary, set all three thickness fields to the same value. thicknessUnitOfMeasure must be set to one of the values defined for the length unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "inches"
key
string <= 8 characters

system generated key of unit of measure

Example: "21"
thickness
number <= 13 characters <= 99999999.99

Thickness of Item

Example: 10
minimumThickness
number <= 13 characters <= 99999999.99

Minimum thickness of Item

Example: 23
maximumThickness
number <= 13 characters <= 99999999.99

Maximum thickness of Item

Example: 11.23
object

The area of the item. You must specify both or neither. areaUnitOfMeasure must be set to one of the values defined for the Area unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "Square Feet"
key
string <= 8 characters

system generated key of unit of measure

Example: "22"
area
number <= 13 characters

Area of Item

Example: 0.567
object

The item unit of measure and total volume. You must specify both or neither. volumeUnitOfMeasure must be set to one of the values defined for the Volume unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "Cubic Meter"
key
string <= 8 characters

system generated key of unit of measure

Example: "24"
volume
number <= 13 characters

Volume of Item

Example: 0.789
densityUnitOfMeasure
string

The density of the item unit of measure and density value.

Example: "Cubic Meter"
density
number <= 13 characters

Density of Item

Example: 0.789
durometerUnitOfMeasure
string <= 10 characters

Durometer (hardness) measurement of the item.

Example: "10"
object

The diameter of the item Unit of measure, and inner and outer diameter. You must specify all three or none. DIAMETERUOM must be set to one of the values defined for the length unit of measure.

id
string <= 50 characters

Id of unit of measure

Example: "inches"
key
string <= 8 characters

system generated key of unit of measure

Example: "21"
innerDiameter
number <= 13 characters

Inner Diameter of Item

Example: 12
outerDiameter
number <= 13 characters

Outer Diameter of Item

Example: 13.5
object
brand
string <= 30 characters

Brand of the item.

Example: "Touch Screen"
subBrand
string <= 30 characters

Sub brand of the item.

Example: "Touch Screen with LED"
category
string <= 30 characters

Category of the item.

Example: "Touch Screen with LED"
subCategory
string <= 30 characters

Sub category of the item.

Example: "Touch Screen with LED"
catalogReference
string <= 30 characters

Catalog reference for the item.

Example: "Touch Screen with LED laptops"
color
string <= 30 characters

Catalog reference for the item.

Example: "black"
size1
string <= 30 characters

Size 1 of the item.

Example: "13"
size2
string <= 30 characters

Size 2 of the item.

Example: "12"
style
string <= 30 characters

Style of the item.

Example: "12"
webName
string <= 100 characters

Name of the item to appear on the web.

Example: "Dell Inspiration"
webShortDiscription
string <= 1000 characters

Short description for the web.

Example: "Dell Inspiration 13 inch LED"
webLongDescription
string <= 2000 characters

Long description for the web.

Example: "Dell Inspiration 13 inch LED touchscreen"
isGiftCard
boolean
Default: false

Use true if item is gift card.

Example: true
isWebEnabled
boolean
Default: false

Use true if item is web enabled.

Example: true
defaultConversionType
string
Default: "quantity"

Option to select default conversion type either Quantity or Price

Enum: "price" "quantity"
Example: "quantity"
object
standardCost
string <decimal-precision-10> <= 15 characters

Standard cost value for the item.

Example: "1501.04"
object
isTaxable
boolean
Default: false

Set to true if the sale of the item is taxable.

Example: true
basePrice
string <decimal-precision-10> <= 15 characters

Base price for the item.

Example: "1000"
isAvailableForDropShip
boolean
Default: false

Available for drop ship

Example: false
isAvailableForBuyToOrder
boolean
Default: false

Available for buy to order

Example: false
object

The tax group to assign the item to.

key
string

System-assigned key for the tax group.

Example: "1000"
id
string

Unique identifier for the tax group.

Example: "Acme Company Customers"
object

The tax solution to assign the item to.

key
string

System-assigned key for the tax solution.

Example: "1000"
id
string

Unique identifier for the tax solution.

Example: "Acme Company Customers"
allowMultipleTaxGroups
boolean
Default: false

Allow multiple item tax groups per item, which is needed when an item is taxed at different rates in different tax jurisdictions. Allow multiple item tax groups. When you set this to true and provide an itemTaxMap, the tax group at the header level is ignored and the mapping is used instead.

Example: false
Array of objects
Array
object

Inventory item.

object

Tax solution associated with the tax group.

object

The tax group to which the item is assigned.

Array of objects
Array
object

Details for the good, service, or kit that is purchased or sold.

object

Details for the warehouse or stocking location for the item.

storageArea
string

Location within the warehouse where the item is normally stored, such as Aisle 23, Row 12, Shelf 3, Bin 5.

Example: "Bin 5"
object

Inventory cycles are used to keep track of when to take physical inventory.

economicOrderQuantity
integer

The quantity that makes the cost of reordering this item the most economical by minimizing total holding costs and total ordering costs.

Example: 10
standardCost
string

The planned or expected costs. Used in situations where purchase costs remain relatively stable over time.

Example: "110"
reorderPoint
integer

Value used as the starting point to determine when the item needs to be replenished.

Example: 121
reorderQuantity
integer

When current net inventory falls to the reorder point plus the safety stock, the item is triggered for reorder with reorder quantity.

Example: 10
minOrderQuantity
integer

The minimum quantity to be reordered at one time.

Example: 10
maxOrderQuantity
integer

The maximum quantity to be reordered at one time.

Example: 100
maximumStock
integer

The quantity of the item you do not want to exceed in the inventory.

Example: 300
minimumStock
integer

The quantity of the item you do not want to fall below in the inventory.

Example: 50
object

Default bin details for the item.

safetyStock
integer

The extra quantity to have in inventory to avoid running out of stock.

Example: 20
replenishmentMethod
string or null
Default: null

Replenishment method to use to automatically identify and reorder items when inventory is low.

Enum: "demandForecastByFluctuatingValues" "demandForecastBySingleValue" null "reorderPoint"
Example: "reorderPoint"
enableReplenishment
boolean
Default: true

Set replenishment to true to replenish the items.

Example: true
Array of objects

Only required when override replenishment values on the enableReplenishment is set to true. Provide vendor information you want to use in the replenishment calculations for the item in this warehouse.

Array of objects

You can provide the standard cost of the item for the warehouse. You can use different standard costs for different date ranges.

Array of objects
Array
object

The item that can be ordered from the vendor.

object

The vendor the item can be ordered from.

stockNumber
string

The stock number that vendor uses for this item.

Example: "#5678901234"
leadTime
integer

The number of days it takes the vendor to deliver this item to you after receiving the order.

Example: 15
demandForecastDuringLeadTime
integer

The quantity of this item that's expected to be sold during the lead time.

Example: 5
economicalOrderQuantity
integer

The quantity that makes the cost of reordering this item the most economical.

Example: 10
vendorMinimumOrderQuantity
integer

The minimum quantity of this item the vendor is willing to sell.

Example: 10
object

The unit of measure the vendor sells this item in.

isPreferredVendor
boolean
Default: false

Identifies a preferred vendor for replenishing this item for warehouses that do not have a vendor specified.

Example: false
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.

Enum: "componentLevel" "kitLevel" null
Example: "componentLevel"
kitRevenuePrinting
string or null
Default: "individualComponents"

Kit revenue posting.

Enum: "individualComponents" "kit" null
Example: "individualComponents"
Array of objects
Array
object

Kit is item of type kit or stockable kit.

object

Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit).

numberOfUnits
number

Number of component units required in this kit.

Example: 1
revenuePercentage
number [ 0 .. 100 ]

When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage.

Example: 10
defaultDeliveryStatus
string
Default: "delivered"

Default that will indicate the most common delivery status of this item when it's sold.

Enum: "delivered" "undelivered"
Example: "delivered"
defaultDeferralStatus
string
Default: "deferUntilItemIsDelivered"

Choose whether to defer until this item is delivered or until the entire bundle is delivered.

Enum: "deferBundleUntilItemIsDelivered" "deferUntilItemIsDelivered"
Example: "deferUntilItemIsDelivered"
lineNumber
integer

Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers.

Example: 1
object

Contract Term section is enabled only if contracts is subscribed for item.

isStartDateAndEndDateEnabled
boolean
Default: false

Set this field to identify this item as having a default term. In Order Entry transactions, this also makes this item eligible for renewals and price proration. For Contracts, Set this to true if you want to set up automatic price proration for this item.

Example: false
periodsMeasuredIn
string or null
Default: "days"

Provide the period of duration to use to measure the item's term.

Enum: "days" "months" null "weeks" "years"
Example: "days"
numberOfPeriods
integer <= 4 characters

Enter the default number of periods to include in the item's term. For example, if Periods measured in is Months and Number of periods is 6, then the item's default term is 6 months. Required if you set isStartDateAndEndDateEnabled to true.

Example: 2
isProratedPricingAllowed
boolean
Default: false

Set this field to true if you want the system to automatically prorate the price when the sales transaction line or contract line term is less than the item's default term. For Order Entry, this field prorates the fair value in a multiple-element arrangement (when also subscribed to Advanced Revenue Management). For Order Entry only, leave this checkbox cleared if you want the option to manually prorate the price using the prorate button in a sales transaction.

Example: false
object

Provide the default renewal instruction set for this item in sales transactions. Only displays if your company is subscribed to Revenue Recognition for Order Entry. This field is not applicable to the Contracts application.

key
string

System-assigned key for the renewal template.

Example: "22"
id
string

Unique identifier for the renewal template.

Example: "Sales Renewal Template US"
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;

object

Provide billing template that would most often be associated with this item.

key
string

System-assigned key for the billing template

Example: "31"
id
string

Unique identifier for the billing template

Example: "Monthly Billing"
object

Provide the default revenue template for the applicable journals. Your Contracts configuration may use one or two sets of revenue journals.

key
string

System-assigned key for the Rev Rec template

Example: "32"
id
string

Unique identifier for the Rev Rec template

Example: "Monthly Billing"
object

Provide the default revenue template for the applicable journals. Your Contracts configuration may use one or two sets of revenue journals. Different from RevRecTemplate1 and RevRecTemplate2 is used for ASC606 standards.

key
string

System-assigned key for the Rev Rec template

Example: "33"
id
string

Unique identifier for the Rev Rec template

Example: "Half Cycle"
object

Provide the default expense template for the applicable journals. Your Contracts configuration may use one or two expense journals.

key
string

System-assigned key for the contract expense template

Example: "33"
id
string

Unique identifier for the contract expense template

Example: "Full Cycle Month Expense 2"
object

Provide the default expense template for the applicable journals. Your Contracts configuration may use one or two expense journals. Different from expenseTemplate1 and expenseTemplate2 is used for ASC606 standards.

key
string

System-assigned key for the contract expense template

Example: "34"
id
string

Unique identifier for the contract expense template

Example: "Half Cycle Month Expense 2"
object

Sage Intacct uses fair value categories to distinguish products or services included in an MEA that will be used in the algorithm that determines another item's estimated standalone selling price. If the item can be sold as part of a multiple-element arrangement, Provide the category that identifies the performance obligation. Learn more about fair value categories in contracts. This field is only applicable if your company is subscribed to Contract Advanced Revenue Recognition.

key
string

System-assigned key for Contract Fair Value Category

Example: "37"
id
string

Unique identifier for the Contract Fair Value Category

Example: "Half Cycle Month Expense 2"
defaultContractDeliveryStatus
string or null
Default: "delivered"

Options are Delivered the contract line's recognition event has occurred Undelivered the contract line's recognition event has not occurred

Enum: "delivered" null "undelivered"
Example: "delivered"
defaultContractDeferralStatus
string or null
Default: "deferRevenueUntilItemIsDelivered"

Defer revenue until item is delivered the revenue schedule for this item will not start until this item has Delivery status = 'Delivered'. Defer revenue until all items are delivered the revenue schedule for this item will not start until all contract lines in the contract have Delivery status = 'Delivered'.

Enum: "deferRevenueUntilAllItemsAreDelivered" "deferRevenueUntilItemIsDelivered" null
Example: "deferRevenueUntilItemIsDelivered"
isDefaultBundle
boolean
Default: false

Set this to true if item is to be included in the default bundle when an MEA allocation that includes this item is created. Users can choose to exclude the item when they create the MEA allocation. This field is only applicable if your company is subscribed to Contract Advanced Revenue Recognition.

Example: true
Array of objects
Array
referenceType
string

Reference type. Use vendor or customer for an external cross reference. Use substitute, upgrade, downgrade, or complement for an internal cross reference.

Enum: "complement" "customer" "downgrade" "substitute" "upgrade" "vendor"
Example: "substitute"
itemAliasId
string or null <= 100 characters
Default: null

Required for an external cross reference. Identifier for the item as understood by the given vendor or customer. Must be unique for the combination of vendor/item or customer/item.

Example: "Logitech - MK825"
itemAliasDescription
string or null <= 50 characters
Default: null

Description of the item alias for the cross reference.

Example: "Logitech - MK825 Wireless Keyboard and Mouse"
object

Valid unit of measure for the item.

object

An alternate item. This field is required when using an internal referenceType, such as substitute or upgrade.

object

The customer ID is required if referenceType is customer.

object

Inventory item to create the cross reference for.

object

The vendor ID is required if referenceType is vendor.

Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "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
      }
    ]
}
Response samples
application/json
{
  • "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
    }
}

Delete an item

delete/objects/inventory-control/item/{key}

Deletes an item.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the item.

Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}

Query items

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "inventory-control/item"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

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 asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

  • and by itself means that all conditions must be true.
  • or by itself means that at least one condition must be true.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
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
property name*
additional property
string
Enum: "asc" "desc"
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
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "inventory-control/item",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "itemType"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "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
    }
}