InventoryItem

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity describes an Autotask product that is associated with an Inventory Location in the Autotask Inventory module. Once an InventoryItem entity has been created, you can track quantities for that item (quantity on hand, quantity on order) and provide a value for minimum and maximum quantity for use with the Auto-Fill Order feature. You can assign serial numbers to instances of InventoryItems, add them to purchase orders, and "receive" them. You can also transfer them between inventory locations or associate them with an account. Inventory items are added and managed in Autotask through the Inventory module.

NOTE   Please review the Conditions and Requirements listed below before creating or updating InventoryItems.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: InventoryItem
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

  • Inventory Add/Edit Item permission is required to Add or Edit an Inventory Item.
  • To query, you must have View permission and Inventory access (site installed module access and security level feature/section access)
  • To create/update, you must have View and Create permission and Inventory access (site installed module access and security level feature/section access)
  • Each InventoryItem requires a unique combination of InventoryItem.ProductID and InventoryItem.InventoryLocationID.

Special field attributes

Field Conditions and Requirements
InventoryLocationID InventoryLocationID must reference an Active inventory location.
QuantityMinimum QuantityMinimum must be >= 0.
QuantityMaximum QuantityMaximum must be >= QuantityMinimum.

QuantityOnHand

 

QuantityOnHand must be >= the quantity Picked + quantity Reserved.

  • For serialized products (that is, products that track a serial number):
    • On create(), QuantityOnHand must = 0 (quantity for these inventory items is increased by creating InventoryItemSerialNumber entities).
    • On update(), QuantityOnHand is Read Only

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
BackOrder Back Order integer      
Bin Bin string (50)        
id Inventory Item ID long    
ImpersonatorCreatorResourceID Impersonator Creator Resource ID integer   Resource

 
InventoryLocationID Inventory Location ID integer InventoryLocation  
OnOrder On Order integer      
Picked Picked integer      
ProductID Product ID integer Product  
QuantityMaximum Quantity Maximum integer      
QuantityMinimum Quantity Minimum integer      
QuantityOnHand Quantity On Hand integer      
ReferenceNumber Reference Number string (50)        
Reserved Reserved integer