InvoiceSearchCriteria Type

This type describes the criteria for the current invoice search.

Remarks

Use this type to specify what search parameters should be sent to PayPal in the next Search.

Fields

Search by the Business's name.

Invoice creation end date filter. This field can be used along with CreationStartDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

CreationStartDate
String

Invoice creation start date filter. This field can be used along with CreationEndDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

CurrencyCode
String

Search by currency code.

This field is required when LowerAmount or UpperAmount is specified.

DueEndDate
String

Invoice due end date filter. This field can be used along with DueStartDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

DueStartDate
String

Invoice due start date filter. This field can be used along with DueEndDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

Email
String

Search by an email address.

InvoiceEndDate
String

Invoice end date filter (the date in which the invoice was enabled). This field can be used along with InvoiceStartDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

InvoiceNumber
String

Search by the invoice number.

InvoiceStartDate
String

Invoice start date filter (the date in which the invoice was enabled). This field can be used along with InvoiceEndDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

LowerAmount
String

Search by transaction invoice amount. This field is used to specify the smallest amount to be returned.

If you specify a value for this $field;, you must also specify CurrencyCode.

Memo
String

Search by the invoice memo.

Origin
int

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.

Page
int

The page number of the result set. This field is required to be set and the default value is '1'.

PageSize
int

The specifies the number of results per page that should be returned. This field is required to be set (valid values are between 1 and 100). The default value is '20'.

PaymentEndDate
String

Invoice payment end date filter. This field can be used along with PaymentStartDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

PaymentStartDate
String

Invoice payment start date filter. This field can be used along with PaymentEndDate to specify a date range.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

RecipientName
String

Search by the Recipient's name.

Status
String

Search by the invoice status.

UpperAmount
String

Search by transaction invoice amount. This field is used to specify the largest amount to be returned.

If you specify a value for this field, you must also specify CurrencyCode.

Constructors

public InvoiceSearchCriteria();