IsToBePrinted Property

Whether this transaction is to be printed.

Syntax

 purchaseorder.getIsToBePrinted([callback])
 purchaseorder.setIsToBePrinted( isToBePrinted, [callback])

Default Value

TRUE

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 getIsToBePrinted([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 setIsToBePrinted([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

Indicates whether or not the transaction is to be printed. If set to true, the "To Be Printed" box in the QuickBooks user interface will be checked.

Note that the default value is true for PurchaseOrder transactions only.

Data Type

Boolean