ItemLinkToTxnLineId Property

A link to a specific line of an existing SALESORDER transaction.

Syntax

 invoice.getItemLinkToTxnLineId(index, [callback])
 invoice.setItemLinkToTxnLineId(index,  itemLinkToTxnLineId, [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 getItemLinkToTxnLineId([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 setItemLinkToTxnLineId([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

A link to a specific line of an existing SalesOrder transaction.

The ItemLinkToTxnId property links this invoice line with a SalesOrder transaction. The ItemLinkToTxnLineId property links to a specific line item in that SalesOrder. Both of these properties must be present if you wish to link to a sales order line.

Note that if you set ItemLinkToTxnId and ItemLinkToTxnLineId in an invoice line, you may not set the ItemName or ItemId properties. ItemLinkToTxnId and ItemLinkToTxnLineId bring in all the item information you need. (You can however specify whatever ItemQuantity or ItemRate that you want, or any other item line element other than ItemName and ItemId).

You may use this property in conjunction with the Invoice class's LinkToTxnId property, as long as these do NOT link to the same transaction id.

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

This property is not available at design time.

Data Type

String