PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

SearchCriteriaOrigin Property

Search an invoice by its origin of creation.

Syntax

 invoice.getSearchCriteriaOrigin([callback])
 invoice.setSearchCriteriaOrigin( searchCriteriaOrigin, [callback])

Possible Values

  0 (coNotSpecified), 
  1 (coWeb), 
  2 (coAPI)

Default Value

1


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 getSearchCriteriaOrigin([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 setSearchCriteriaOrigin([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

Search an invoice by its origin of creation.

coNotSpecified (0) The creation of the invoice is not specified (search results can return invoices created on the Web or using the API).
coWeb (1) The invoice was created on paypal.com
coAPI (2) The invoice was created by an Invoicing Service API call.

This property is not available at design time.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0