OpeningBalance Property

The opening balance of this account.

Syntax

 account.getOpeningBalance([callback])
 account.setOpeningBalance( openingBalance, [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 getOpeningBalance([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 setOpeningBalance([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 opening balance of this account (by default zero). Note that this property is only used when adding new accounts to QuickBooks, and will not be returned when retrieving account information from QuickBooks.

The amount should be formatted as a string in dollars.

Data Type

String