LinkedTxnLinkType Property

Indicates the nature of the link between the transactions.

Syntax

 creditmemo.getLinkedTxnLinkType(index, [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 getLinkedTxnLinkType([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 setLinkedTxnLinkType([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 the nature of the link between the transactions. Possible responses include:


AMTTYPE	The two transactions are linked based on an amount value (for example an invoice linked to a payment).
QUANTYPE	The two transactions are linked based on a quantity. This affects transactions that are linked to sales orders, estimates and purchase orders. For example, an invoice might be created from a sales order, based on the quantity of items received.

The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String