Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

LineItemTotal Property

Total cost of this line item.

Syntax

 tsyshclevel3.getLineItemTotal(index, [callback])
 tsyshclevel3.setLineItemTotal(index,  lineItemTotal, [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 getLineItemTotal([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 setLineItemTotal([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

Total cost of this line item.

This property contains the total amount of the individual item, typically calculated as LineItemUnitCost multiplied by LineItemQuantity, with any LineItemTaxAmount and LineItemDiscountAmount taken into account. For example, if your customer purchased 3 T-Shirts at $13.99 each, then:

  TSYSLevel3.LineItemCount = 1
  TSYSLevel3.LineItemQuantity(0) = 3
  TSYSLevel3.LineItemUnitCost(0) = "1399"
  TSYSLevel3.LineItemUnits(0) = "each"
  TSYSLevel3.LineItemTotal(0) = "4197" '$13.99 x 3 = $41.97

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This property may not contain a negative number.

Note: This property is 12 digits in length for Visa, but only 9 for MasterCard. All properties associated with a specific Line Item must be set with an identical ItemIndex index. This index must be incremented for each Line Item that is added. The ItemIdx ranges from 0 to LineItemCount - 1.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

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

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0