InventoryQuantityOnHand Property

The quantity in stock for this inventory item.

Syntax

 item.getInventoryQuantityOnHand([callback])
 item.setInventoryQuantityOnHand( inventoryQuantityOnHand, [callback])

Default Value

"0"

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getInventoryQuantityOnHand([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setInventoryQuantityOnHand([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The total quantity you have on hand for this item.

If both InventoryQuantityOnHand and PurchaseCost are included, then InventoryTotalValue will be set to InventoryQuantityOnHand times PurchaseCost, regardless of what InventoryTotalValue is explicitly set to.

This property is only applicable for Inventory Items (ItemType = itInventory).

Data Type

String