DepositLinePaymentId Property

The PaymentTxnId for this deposit line item For any given deposit there are many line items properties, such as AccountId , PaymentMethodId , Amount , etc.

Syntax

 deposit.getDepositLinePaymentId(index, [callback])
 deposit.setDepositLinePaymentId(index,  depositLinePaymentId, [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 getDepositLinePaymentId([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 setDepositLinePaymentId([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 PaymentTxnId for this deposit line item

For any given deposit there are many line items properties, such as DepositLineAccountId, DepositLinePaymentMethodId, DepositLineAmount, etc. All of these properties may be replaced by referencing a transaction already stored in quickbooks. Just set the DepositLinePaymentId property, and no other Deposit Line Item properties need be set.

When this property is set, you may also specify a DepositLinePaymentLineId to indicate which payment line in the transaction referenced by DepositLinePaymentId is to be added. If specified, the DepositLineMemo, DepositLineCheckNumber, and DepositLineClassName/DepositLineClassId properties will override those from the original transaction. All other properties are ignored when DepositLinePaymentId has a value.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String