TotalBalanceMinimum Property
A minimum balance which returned records should have.
Syntax
objsearch.getTotalBalanceMinimum([callback]) objsearch.setTotalBalanceMinimum( totalBalanceMinimum, [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 getTotalBalanceMinimum([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 setTotalBalanceMinimum([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
A minimum balance which returned records should have. Limits the search to records with balances greater than or equal to TotalBalanceMinimum.
If TotalBalanceMinimum is specified TotalBalanceMaximum may not be (this limitation is imposed by the QBXML interface).
The amount should be formatted as a string in dollars.
Only applicable to searches for entity objects.
Data Type
String