AutoApply Property

How the payment should be applied.

Syntax

 receivepayment.getAutoApply([callback])
 receivepayment.setAutoApply( autoApply, [callback])

Possible Values

  0 (aaNotSet), 
  1 (aaFutureTransactions), 
  2 (aaExistingTransactions), 
  3 (aaCustom)

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 getAutoApply([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 setAutoApply([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

How the payment should be applied. The following values are permitted:


aaCustom (3)	Manually specify how the payment should be applied. Use the AppliedTo property to specify each transaction this Receive Payment applies to.
aaExistingTransactions (2)	Apply the payment to existing customer transactions (e.g., invoices). QuickBooks will automatically apply the payment to appropriate transactions, which will be reported in the AppliedToTransactions special field after Add is invoked.
aaFutureTransactions (1)	Apply the payment to future transactions; i.e., set a credit for the customer.
aaNotSet (0)	The default value. You must change the value of AutoApply before it is used in Add transactions.

Data Type

Integer