SearchHasPreviousPage Property

Indicates if a previous page of invoice summary results exists.

Syntax

 invoice.getSearchHasPreviousPage([callback])

Default Value

FALSE

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 getSearchHasPreviousPage([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 setSearchHasPreviousPage([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

This property will be populated after a call to Search is made. If this property is True, a previous page of invoice summary results exists. To retrieve the previous page, you can decrement SearchCriteriaPage by 1 and call Search.

This property is read-only.

Data Type

Boolean