PurchaseDescription Property

The purchase description for this item.

Syntax

 item.getPurchaseDescription([callback])
 item.setPurchaseDescription( purchaseDescription, [callback])

Default Value

""

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 getPurchaseDescription([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 setPurchaseDescription([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 purchase description for this item.

Used for service, non-inventory, inventory, and other charge items. You should specify this property in case the item is both purchased and sold. In case the item is purchased but not sold, it is recommended that you specify Price, Description, and Account instead. QuickBooks will use the type of account to distinguish between purchased items and sold items.

Data Type

String