InvoiceDiscountAmount Property

The discount amount applied to the invoice.

Syntax

 invoice.getInvoiceDiscountAmount([callback])
 invoice.setInvoiceDiscountAmount( invoiceDiscountAmount, [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 getInvoiceDiscountAmount([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 setInvoiceDiscountAmount([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

The discount amount applied to the invoice.

If InvoiceDiscountPercent is provided, InvoiceDiscountAmount is ignored.

Data Type

String