SearchInvoiceNumber Property

The InvoiceNumber that was included in the original transaction.

Syntax

 globaltransactionsearch.getSearchInvoiceNumber([callback])
 globaltransactionsearch.setSearchInvoiceNumber( searchInvoiceNumber, [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 getSearchInvoiceNumber([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 setSearchInvoiceNumber([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 InvoiceNumber that was included in the original transaction. If provided, only those transactions with matching InvoiceNumber will be included in the search results. Wildcards are allowed.

This property is not applicable for Transaction Summaries.

Data Type

String