RefNumberEndsWith Property

String which RefNumbers are to end with.

Syntax

 objsearch.getRefNumberEndsWith([callback])
 objsearch.setRefNumberEndsWith( refNumberEndsWith, [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 getRefNumberEndsWith([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 setRefNumberEndsWith([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

String which RefNumbers are to end with. Limits the search to records with RefNumbers which end with the string specified by RefNumberEndsWith.

If RefNumberEndsWith is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

Data Type

String