FinanceCharge Property

If true, this invoice includes a finance charge.

Syntax

 invoice.getFinanceCharge([callback])
 invoice.setFinanceCharge( financeCharge, [callback])

Possible Values

  0 (fcNotSet), 
  1 (fcIsFinanceCharge), 
  2 (fcNotFinanceCharge)

Default Value

0

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 getFinanceCharge([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 setFinanceCharge([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

Indicates whether a finance-charge item has been added to this invoice. This property is determined by QuickBooks and is read-only when QBXMLVersion is less than "8.0".

Data Type

Integer