InventoryStockedItemsTransfer

This entity describes a transaction where a specified quantity of an InventoryProducts or an InventoryStockedItems entity is transferred from the item’s current InventoryLocation to a different InventoryLocation.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: InventoryStockedItemsTransfer

Entity Path:

/atservicesrest/v1.0/InventoryStockedItemsTransfer
Can Create:
Can Update:  
Can Query:  
Can Delete:  
Can Have UDFs:  

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Parent InventoryProducts
Children None
URLs InventoryStockedItemsTransfer (POST)
InventoryStockedItemsTransfer/entityInformation (GET)
InventoryStockedItemsTransfer/entityInformation/fields (GET)

Fields that cannot be queried

This entity supports Create requests only. All fields will return errors if queried.

Conditions and requirements

General

  • Create actions will cause the inventoryStockedItems.onHandUnits value to be recalculated.

  • On Create, serialized items must be added one at a time.

  • Changes to serialized items do not create new entries in InventoryStockedItems.

  • inventoryProducts cannot be deleted if the reservedUnits or pickedUnits values are greater than 0.

  • Following the release of Autotask 2022.1, it is no longer possible to update the quantity on hand of an inventory product. The field is now calculated based on the stocked items as follows:

    • To increase the quantity on hand of a product in inventory, you'll need to send a Create request to the InventoryStockedItemsAdd endpoint for the product to increase.

      • For serialized items, each serial number requires a new Create request against InventoryStockedItemsAdd. Only one serial number can exist per row.

    • To decrease the quantity on hand of a product in inventory, you'll need to send an Update request to the InventoryStockedItemsRemove endpoint for the product to decrease.

      • If the product is serialized, you'll need to query InventoryStockedItems for the serial number. Set the quantityOnHand value to 0 and the quantityRemoved value to 1. If required, reasonForUpdate must also be included.

      • If the product is not serialized, query InventoryStockedItems for the product associated with the inventory location. The query may return multiple rows. Decide which of the resulting rows will be updated. We recommend reducing the quantity from the oldest item.

    • For serialized items, the sum of onHandUnits, reservedUnits, transferredUnits, removedUnits, pickedUnits, and deliveredUnits will always equal 1.

    • For non-serialized items, the sum of onHandUnits, reservedUnits, transferredUnits, removedUnits, pickedUnits, and deliveredUnits is always equal to the value of the purchaseOrderItemReceiving.quantityPreviouslyReceived field.

  • To determine the original received quantity, query the PurchaseOrderItemReceiving entity.

Special field attributes

Field Conditions and Requirements
reasonForUpdate This field is required if the system setting "Require/prompt users to enter a reason when manually updating an inventory item’s On Hand quantity, or when canceling receipt of a purchase order item" is enabled.
inventoryProductID and inventoryStockedItemID

Only one of these fields can have a value at a time, and one of them is required. You can decide to remove from inventory product level or a specific stock item.

  • If inventoryStockItemID is used, then the quantityBeingRemoved can not be more than availableUnits.

  • If inventoryProductID is used, then the quantityBeingRemoved can not be greater than the availableUnits in inventoryProduct. The quantiyBeingRemoved will deduct units from multiple inventoryStockedParentItems (oldest first) until the total quantity is removed.
inventoryStockedItemID A transfer of non-serialized products performs a "remove" action from the inventoryStockedItemID and then performs an "add" for the quantity being transferred. It uses the ID of the InventoryStockedItems as the inventoryStockedItems.parentInventoryStockedItemID value for the new entry being created

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
id long    
inventoryProductID integer     InventoryProducts  
inventoryStockedItemID integer     InventoryStockedItems  
newInventoryLocationID integer   InventoryLocations  
quantityBeingTransfered integer      
reasonForUpdate string (500)        

Additional resources