GetAddendum Method

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

Syntax

fdmslevel3.getAddendum([callback])

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 this 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.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The type of addendum created by this class 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.

List of valid Line Item properties for Visa:

• LineItemQuantity (required)
• LineItemUnitCost (required)
• LineItemCommodityCode (optional)
• LineItemDescription (optional)
• LineItemDiscountAmount (optional)
• LineItemProductCode (optional)
• LineItemTaxAmount (optional)
• LineItemTaxRate (optional)
• LineItemTotal (optional)
• LineItemUnits (optional)

List of valid Line Item properties for Mastercard:

• LineItemDescription (required)
• LineItemProductCode (required)
• LineItemQuantity (required)
• LineItemUnits (required)
• LineItemUnitCost (optional)
• LineItemTotal (required)
• LineItemDiscountAmount (optional)
• LineItemTaxIncluded (required)
• LineItemTaxRate (required)
• LineItemTaxAmount (required)
• LineItemTaxType (required)

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