ServiceAccountTotalDiscount Property

Total discount amount applied to the shipment for a ServiceType .

Syntax

 canadapostrates.getServiceAccountTotalDiscount(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 getServiceAccountTotalDiscount([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 setServiceAccountTotalDiscount([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 discount amount applied to the shipment for a ServiceType. This is for FedEx only and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountTotalDiscount will be filled with the value of total discount applied, which is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this property will contain the total amount of discounts.

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

This property is read-only and not available at design time.

Data Type

String