InventoryStockedItemsAdd

This entity enables you to increase inventory counts associated with the InventoryProducts entity.

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: InventoryStockedItemsAdd

Entity Path:

/atservicesrest/v1.0/InventoryStockedItemsAdd
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 InventoryStockedItemsAdd (POST)
InventoryStockedItemsAdd/entityInformation (GET)
InventoryStockedItemsAdd/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

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

  • 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
determineCostUsing

The following options are available for this field:

1. Average Cost for this Product

2. Cost of last instance of this product received

3. Catalog Cost for this Product

4. Manual Entry
deterimeNewPriceUsing

This field will be required if returnTypeID is not equal to NULL. The following options are available for this field:

1. Cost of Items

2. Percentage of Cost of items

3. Catalog Price for this Product

4. Percentage of catalog price for this Product

5. Manual Entry
pricePercentage

If options 2 or 4 are selected for determineNewPriceUsing, this field is required.
quantityBeingAdded

This field must be non-zero for non-serialized items. For serialized items, it must contain a value of 1.
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.
returnPrice If determineNewPriceUsing equals "Manual Entry," this field is required.
vendorInvoiceNumber This field is required if the system setting "Require Vendor Invoice Number on received purchase order items and when manually adding stocked items to inventory" is enabled.
returnPrice If determineNewPriceUsing equals "Manual Entry," this field is required.
serialNumber If serialNumber contains data, only one string is allowed (no comma or other delimiters). If the product is serialized, this field will be required, and its quantity must be set to 1.
vendorInvoiceNumber This field is required if the system setting "Require Vendor Invoice Number on received purchase order items and when manually adding stocked items to inventory" is enabled.

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
determineCostUsing integer    
determineNewPriceUsing integer      
id long    
inventoryProductID integer   InventoryProducts  
pricePercentage decimal        
quantityBeingAdded integer      
reasonForUpdate string (500)        
returnPrice decimal        
returnTypeID integer      
serialNumber string (50)        
unitCost decimal        
vendorID integer      
vendorInvoiceNumber string (50)     Companies  

Additional resources