DetailRecordAddendum Property

Optional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the FDMSECOMMERCE , FDMSRETAIL , or FDMSDETAILRECORD component's GetDetailAggregate method.

Syntax

 fdmssettle.getDetailRecordAddendum(index, [callback])
 fdmssettle.setDetailRecordAddendum(index,  detailRecordAddendum, [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 getDetailRecordAddendum([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 setDetailRecordAddendum([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

Optional Detail Record Addendum data (such as Level2 or Level3 data)

The DetailRecordDetailAggregate property contains an xml aggregate of the transaction retrieved from the FDMSECommerce, FDMSRetail, or FDMSDetailRecord class's GetDetailAggregate method. If you wish to accept corporate purchasing cards you will also need to send Level2, and possibly Level3 addendum data along with the DetailRecordDetailAggregate. The DetailRecordAddendumAggregate property takes an xml aggregate containing either Level2 or Level2 plus Level3 addendum data, which will be added to the DetailRecordDetailAggregate when sending the settlement. The DetailRecordAddendumAggregate may be created with either the FDMSLevel2 or FDMSLevel3 classs, and then returned via those class's GetAddendum method.

For example:

  'First, authorize the credit card
  FDMSECommerce.TransactionAmount = "2720" '$27.20
  FDMSECommerce.Authorize()

  'Then, put the result into the settlement component
  FDMSSettle.DetailRecordCount = 1
  FDMSSettle.DetailRecordAggregate(0) = FDMSECommerce.GetDetailAggregate()

  'Then build the Level 2 portion
  FDMSLevel2.CardType = ctVisa
  FDMSLevel2.CommercialCardType = FDMSECommerce.ResponseCommercialCard  
  FDMSLevel2.OrderDate = "060828" 'September 28th, 2006
  FDMSLevel2.FreightTaxAmount = "0"
  FDMSLevel2.FreightAmount = "600"
  FDMSLevel2.PurchaseIdentifier = "123456PURCHID"
  FDMSLevel2.ShippedToZip = "90210"
  FDMSLevel2.ShippedFromZip = "90210"
  FDMSLevel2.TaxAmount = "120"
  
  'Now build the Level 3 portion

  FDMSLevel3.CardType = ctVisa
  FDMSLevel3.LineItemCount = 2

  FDMSLevel3.ItemCommodityCode(0) = "4900" ' Books and printed materials
  FDMSLevel3.ItemDescription(0) = "Reference manual"
  FDMSLevel3.ItemDiscountAmount(0) = "" ' No discount
  FDMSLevel3.ItemProductCode(0) = "ISBN123456"
  FDMSLevel3.ItemQuantity(0) = "2"
  FDMSLevel3.ItemTaxAmount(0) = "60"
  FDMSLevel3.ItemTaxRate(0) = "600" ' 6.00 percent
  FDMSLevel3.ItemTotal(0) = "1060"
  FDMSLevel3.ItemUnitCost(0) = "500"
  FDMSLevel3.ItemUnits(0) = "each"

  FDMSLevel3.ItemCommodityCode(1) = "4900"
  FDMSLevel3.ItemDescription(1) = "Quick Start manual"
  FDMSLevel3.ItemDiscountAmount(1) = ""
  FDMSLevel3.ItemProductCode(1) = "ISBN654321"
  FDMSLevel3.ItemQuantity(1) = "1"
  FDMSLevel3.ItemTaxAmount(1) = "60"
  FDMSLevel3.ItemTaxRate(1) = "600" ' 6.00 percent
  FDMSLevel3.ItemTotal(1) = "1060"
  FDMSLevel3.ItemUnitCost(1) = "1000"
  FDMSLevel3.ItemUnits(1) = "each"

  'Finally, add the Level 2 and Level 3 addendum data to the settlement at the same index
  'as the associated transaction.
  FDMSSettle.DetailRecordAddendum(0) = FDMSLevel2.GetAddendum() & FDMSLevel3.GetAddendum()

Note that you may mix corporate and non-corporate card transactions in the same settlement. It is not necessary that all DetailRecordDetailAggregates have a corresponding DetailRecordAddendumAggregate.

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

This property is not available at design time.

Data Type

String