RefNumber Property
Exact RefNumber to search for.
Syntax
objsearch.getRefNumber([callback]) objsearch.setRefNumber( refNumber, [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 getRefNumber([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 setRefNumber([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
Exact RefNumber to search for. Limits the search to records with RefNumbers identical to RefNumber.
If RefNumber is specified, no other search criteria will be sent in the query. If you wish to narrow your results based on the RefNumber and other criteria such as ModifiedDateStart or EntityName, you will need to use the RefNumberContains, RefNumberStartsWith, RefNumberEndsWith, RefNumberRangeStart, or RefNumberRangeEnd properties.
Only applicable to searches for transaction objects.
Data Type
String