RefNumberRangeStart Property

Starting point of a RefNumber range.

Syntax

 objsearch.getRefNumberRangeStart([callback])
 objsearch.setRefNumberRangeStart( refNumberRangeStart, [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 getRefNumberRangeStart([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 setRefNumberRangeStart([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

Starting point of a RefNumber range. Limits the search to records with RefNumbers lexicographically higher than or equal to RefNumberRangeStart.

May be combined with RefNumberRangeEnd, but not with RefNumberContains, RefNumberStartsWith, or RefNumberEndsWith.

Only applicable to searches for transaction objects.

Data Type

String