QuickBooks Integrator 2020 Node.js Edition

Questions / Feedback?

LinkedTxnType Property

This property indicates which type of linked transaction has been returned.

Syntax

 invoice.getLinkedTxnType(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 getLinkedTxnType([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 setLinkedTxnType([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

This property indicates which type of linked transaction has been returned. The LinkedTxnTxnType returned will tell you which class to use to retrieve the original transaction. Use the LinkedTxnTxnId as the Id parameter in the indicated class's Get method to return the original transaction details.

Valid values include:

Bill(Bill class)
BillPaymentCheck(n/a)
BillPaymentCreditCard(n/a)
BuildAssembly(n/a)
Charge(StatementCharge class)
Check(Check class)
CreditCardCharge(CCCredit class)
CreditCardCredit(CCCharge class)
CreditMemo(CreditMemo class)
Deposit(Deposit class)
Estimate(Estimate class)
InventoryAdjustment (AdjustInventory class)
Invoice(Invoice class)
ItemReceipt (ItemReceipt class)
JournalEntry(JournalEntry class)
LiabilityAdjustment(n/a)
Paycheck(n/a)
PayrollLiabilityCheck(n/a)
PurchaseOrder(PurchaseOrder class)
ReceivePayment(ReceivePayment class)
SalesOrder(SalesOrder class)
SalesReceipt(SalesReceipt class)
SalesTaxPaymentCheck(n/a)
Transfer(n/a)
VendorCredit(VendorCredit class)
YTDAdjustment(n/a)

Note: Not all of the above values are available in the QuickBooks API. Some are only available within the QuickBooks application itself. If the value above is available in the API, the corresponding class is indicated in parenthesis.

The index parameter specifies the index of the item in the array. 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

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Node.js Edition - Version 20.0 [Build 7941]