User Guide

Invoicing Service API Guide May 2012 89
SearchInvoices API Operation
SearchInvoicesRequest Message
9
SearchParametersType Fields
page xs:integer
(Required) Page number of result set, starting with 1.
pageSize xs:integer
(Required) Number of results per page, between 1 and 100.
Field Description
email xs:string
(Optional) Email search string.
recipientName xs:string
(Optional) Recipient search string.
businessName xs:string
(Optional) Company search string.
invoiceNumber xs:integer
(Optional) Invoice number search string.
status inv:statusType
(Optional) Invoice status search.
lowerAmount xs:decimal
(Optional) Invoice amount search. It specifies the smallest amount to be
returned. If you pass a value for this field, you must also pass a
currencyCode value.
upperAmount xs:decimal
(Optional) Invoice amount search. It specifies the largest amount to be
returned. If you pass a value for this field, you must also pass a
currencyCode value.
currencyCode xs:string
(Optional) Currency used for lower and upper amounts. It is required when
you specify lowerAmount or upperAmount.
memo xs:string
(Optional) Invoice memo search string.
origin inv:originType
(Optional) Indicates whether the invoice was created by the website or by an
API call. It is one of the following values:
Web – The invoice was created on paypal.com.
API – The invoice was created by an Invoicing Service API call.
Field Description