GetAddendum Method

Returns a Level III Purchasing card addendum based on the specified CardType .

Syntax

[VB.NET]
Public Function GetAddendum() As String

[C#]
public string GetAddendum();

Remarks

The type of addendum created by this component depends upon the value of the CardType property. Different addendums are created when the CardType is set to ctVisa or ctMasterCard, and different properties are required for the two different CardTypes.

The following fields are valid for both ctVisa and ctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• Description
• DiscountAmount
• ProductCode
• Quantity
• TaxAmount
• TaxRate
• Total
• Units

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• CommodityCode
• UnitCost

Additional fields for the ctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• DiscountRate
• TaxIncluded
• TaxType

The following example illustrates how to build a Level III addendum for the ctVisa CardType:

  // First authorize the credit card
  TSYSECommerce1.TransactionAmount = "53";
  TSYSECommerce.Authorize();
  
  // Then, put the result into the settlement component
  TSYSSettle.DetailRecords.Add(new TSYSRecordType());
	TSYSSettle.DetailRecords[0].DetailAggregate = TSYSECommerce.GetDetailAggregate();  

  // Now build the Level3 Extension. 
  // The following properties are required for a Visa Corporate Purchasing Card:
  TSYSLevel3.CardType = ctVisa;
  TSYSLevel3.LocalTax = "EXEMPT";
  TSYSLevel3.NationalTax = "0";
  TSYSLevel3.PurchaseOrder = "purchOrdNum";
  TSYSLevel3.MerchantTaxId = "merchantTaxId";
  TSYSLevel3.CustomerTaxId = "customerTaxId";
  TSYSLevel3.CommodityCode = "fake";
  TSYSLevel3.DiscountAmount = "0";
  TSYSLevel3.FreightAmount = "0";
  TSYSLevel3.DutyAmount = "0";
  TSYSLevel3.DestinationZip = "27709";
  TSYSLevel3.ShipFromZip = "27709";
  TSYSLevel3.DestinationCountry = "840";
  TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo";
  TSYSLevel3.OrderDate = "060526";
  TSYSLevel3.FreightTaxAmount = "0";
  TSYSLevel3.FreightTaxRate = "0";
  
  // Begin adding line items:  
  
	TSYSLevel3.LineItems.Add(new TSYSLineItem());
  TSYSLevel3.LineItems[0].CommodityCode = "fake";
  TSYSLevel3.LineItems[0].Description = "hardware";
  TSYSLevel3.LineItems[0].ProductCode = "productCode123";
  TSYSLevel3.LineItems[0].Quantity = 1;
  TSYSLevel3.LineItems[0].Units = "";
  TSYSLevel3.LineItems[0].UnitCost = "33";
  TSYSLevel3.LineItems[0].TaxAmount = "0";
  TSYSLevel3.LineItems[0].TaxRate = "0";
  TSYSLevel3.LineItems[0].DiscountAmount = "0";
  TSYSLevel3.LineItems[0].Total = "33";
  
	TSYSLevel3.LineItems.Add(new TSYSLineItem());
  TSYSLevel3.LineItems[1].CommodityCode = "fake";
  TSYSLevel3.LineItems[1].Description = "hardware";
  TSYSLevel3.LineItems[1].ProductCode = "productCode124";
  TSYSLevel3.LineItems[1].Quantity = 1;
  TSYSLevel3.LineItems[1].Units = "";
  TSYSLevel3.LineItems[1].UnitCost = "20";
  TSYSLevel3.LineItems[1].TaxAmount = "0";
  TSYSLevel3.LineItems[1].TaxRate = "0";
  TSYSLevel3.LineItems[1].DiscountAmount = "0";
  TSYSLevel3.LineItems[1].Total = "20";
  
  // Finally, add the Level3 addendum to the same index in the settlement.
	TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel3.GetAddendum();