InventoryTotalValue Property

The total value of this inventory item.

Syntax

 item.getInventoryTotalValue([callback])
 item.setInventoryTotalValue( inventoryTotalValue, [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 getInventoryTotalValue([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 setInventoryTotalValue([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 dollar value for the number of items specified by InventoryQuantityOnHand. If InventoryTotalValue is included, InventoryQuantityOnHand must be non-zero.

If both InventoryQuantityOnHand and PurchaseCost are included, then total value in QuickBooks will be set to InventoryQuantityOnHand times PurchaseCost, regardless of what InventoryTotalValue is explicitly set to (ie: The contents of InventoryTotalValue are ignored).

Please note that this is a write-only property, and it's value will not be returned after a Get. Add, or Modify.

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

The amount should be formatted as a string in dollars.

Data Type

String