Search (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.api.payments.Search

```
public class Search
extends PayPalModel
```

Constructor Summary

Constructors
Constructor and Description

Search()
Default Constructor

Constructors
Constructor and Description
`Search()` Default Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Boolean`	`getArchived()` A flag indicating whether search is on invoices archived by merchant.
`java.lang.String`	`getEmail()` The initial letters of the email address.
`java.lang.String`	`getEndCreationDate()` The end creation date for the invoice.
`java.lang.String`	`getEndDueDate()` The end due date for the invoice.
`java.lang.String`	`getEndInvoiceDate()` The end date for the invoice.
`java.lang.String`	`getEndPaymentDate()` The end payment date for the invoice.
`Currency`	`getLowerTotalAmount()` The lower limit of the total amount.
`java.lang.String`	`getNumber()` The invoice number.
`float`	`getPage()` The offset for the search results.
`float`	`getPageSize()` The page size for the search results.
`java.lang.String`	`getRecipientBusinessName()` The initial letters of the recipient's business name.
`java.lang.String`	`getRecipientFirstName()` The initial letters of the recipient's first name.
`java.lang.String`	`getRecipientLastName()` The initial letters of the recipient's last name.
`java.lang.String`	`getStartCreationDate()` The start creation date for the invoice.
`java.lang.String`	`getStartDueDate()` The start due date for the invoice.
`java.lang.String`	`getStartInvoiceDate()` The start date for the invoice.
`java.lang.String`	`getStartPaymentDate()` The start payment date for the invoice.
`java.lang.String`	`getStatus()` The invoice status.
`java.lang.Boolean`	`getTotalCountRequired()` Indicates whether the total count appears in the response.
`Currency`	`getUpperTotalAmount()` The upper limit of total amount.
`int`	`hashCode()`
`Search`	`setArchived(java.lang.Boolean archived)` A flag indicating whether search is on invoices archived by merchant.
`Search`	`setEmail(java.lang.String email)` The initial letters of the email address.
`Search`	`setEndCreationDate(java.lang.String endCreationDate)` The end creation date for the invoice.
`Search`	`setEndDueDate(java.lang.String endDueDate)` The end due date for the invoice.
`Search`	`setEndInvoiceDate(java.lang.String endInvoiceDate)` The end date for the invoice.
`Search`	`setEndPaymentDate(java.lang.String endPaymentDate)` The end payment date for the invoice.
`Search`	`setLowerTotalAmount(Currency lowerTotalAmount)` The lower limit of the total amount.
`Search`	`setNumber(java.lang.String number)` The invoice number.
`Search`	`setPage(float page)` The offset for the search results.
`Search`	`setPageSize(float pageSize)` The page size for the search results.
`Search`	`setRecipientBusinessName(java.lang.String recipientBusinessName)` The initial letters of the recipient's business name.
`Search`	`setRecipientFirstName(java.lang.String recipientFirstName)` The initial letters of the recipient's first name.
`Search`	`setRecipientLastName(java.lang.String recipientLastName)` The initial letters of the recipient's last name.
`Search`	`setStartCreationDate(java.lang.String startCreationDate)` The start creation date for the invoice.
`Search`	`setStartDueDate(java.lang.String startDueDate)` The start due date for the invoice.
`Search`	`setStartInvoiceDate(java.lang.String startInvoiceDate)` The start date for the invoice.
`Search`	`setStartPaymentDate(java.lang.String startPaymentDate)` The start payment date for the invoice.
`Search`	`setStatus(java.lang.String status)` The invoice status.
`Search`	`setTotalCountRequired(java.lang.Boolean totalCountRequired)` Indicates whether the total count appears in the response.
`Search`	`setUpperTotalAmount(Currency upperTotalAmount)` The upper limit of total amount.

Methods inherited from class com.paypal.base.rest.PayPalModel
toJSON, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Search
```
public Search()
```
    Default Constructor
- Method Detail
  - getEmail
```
public java.lang.String getEmail()
```
    The initial letters of the email address.
  - getRecipientFirstName
```
public java.lang.String getRecipientFirstName()
```
    The initial letters of the recipient's first name.
  - getRecipientLastName
```
public java.lang.String getRecipientLastName()
```
    The initial letters of the recipient's last name.
  - getRecipientBusinessName
```
public java.lang.String getRecipientBusinessName()
```
    The initial letters of the recipient's business name.
  - getNumber
```
public java.lang.String getNumber()
```
    The invoice number.
  - getStatus
```
public java.lang.String getStatus()
```
    The invoice status.
  - getLowerTotalAmount
```
public Currency getLowerTotalAmount()
```
    The lower limit of the total amount.
  - getUpperTotalAmount
```
public Currency getUpperTotalAmount()
```
    The upper limit of total amount.
  - getStartInvoiceDate
```
public java.lang.String getStartInvoiceDate()
```
    The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getEndInvoiceDate
```
public java.lang.String getEndInvoiceDate()
```
    The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getStartDueDate
```
public java.lang.String getStartDueDate()
```
    The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getEndDueDate
```
public java.lang.String getEndDueDate()
```
    The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getStartPaymentDate
```
public java.lang.String getStartPaymentDate()
```
    The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getEndPaymentDate
```
public java.lang.String getEndPaymentDate()
```
    The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getStartCreationDate
```
public java.lang.String getStartCreationDate()
```
    The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getEndCreationDate
```
public java.lang.String getEndCreationDate()
```
    The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getPage
```
public float getPage()
```
    The offset for the search results.
  - getPageSize
```
public float getPageSize()
```
    The page size for the search results.
  - getTotalCountRequired
```
public java.lang.Boolean getTotalCountRequired()
```
    Indicates whether the total count appears in the response. Default is `false`.
  - getArchived
```
public java.lang.Boolean getArchived()
```
    A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
  - setEmail
```
public Search setEmail(java.lang.String email)
```
    The initial letters of the email address.
    
    Returns:
    
    this
  - setRecipientFirstName
```
public Search setRecipientFirstName(java.lang.String recipientFirstName)
```
    The initial letters of the recipient's first name.
    
    Returns:
    
    this
  - setRecipientLastName
```
public Search setRecipientLastName(java.lang.String recipientLastName)
```
    The initial letters of the recipient's last name.
    
    Returns:
    
    this
  - setRecipientBusinessName
```
public Search setRecipientBusinessName(java.lang.String recipientBusinessName)
```
    The initial letters of the recipient's business name.
    
    Returns:
    
    this
  - setNumber
```
public Search setNumber(java.lang.String number)
```
    The invoice number.
    
    Returns:
    
    this
  - setStatus
```
public Search setStatus(java.lang.String status)
```
    The invoice status.
    
    Returns:
    
    this
  - setLowerTotalAmount
```
public Search setLowerTotalAmount(Currency lowerTotalAmount)
```
    The lower limit of the total amount.
    
    Returns:
    
    this
  - setUpperTotalAmount
```
public Search setUpperTotalAmount(Currency upperTotalAmount)
```
    The upper limit of total amount.
    
    Returns:
    
    this
  - setStartInvoiceDate
```
public Search setStartInvoiceDate(java.lang.String startInvoiceDate)
```
    The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setEndInvoiceDate
```
public Search setEndInvoiceDate(java.lang.String endInvoiceDate)
```
    The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setStartDueDate
```
public Search setStartDueDate(java.lang.String startDueDate)
```
    The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setEndDueDate
```
public Search setEndDueDate(java.lang.String endDueDate)
```
    The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setStartPaymentDate
```
public Search setStartPaymentDate(java.lang.String startPaymentDate)
```
    The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setEndPaymentDate
```
public Search setEndPaymentDate(java.lang.String endPaymentDate)
```
    The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setStartCreationDate
```
public Search setStartCreationDate(java.lang.String startCreationDate)
```
    The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setEndCreationDate
```
public Search setEndCreationDate(java.lang.String endCreationDate)
```
    The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setPage
```
public Search setPage(float page)
```
    The offset for the search results.
    
    Returns:
    
    this
  - setPageSize
```
public Search setPageSize(float pageSize)
```
    The page size for the search results.
    
    Returns:
    
    this
  - setTotalCountRequired
```
public Search setTotalCountRequired(java.lang.Boolean totalCountRequired)
```
    Indicates whether the total count appears in the response. Default is `false`.
    
    Returns:
    
    this
  - setArchived
```
public Search setArchived(java.lang.Boolean archived)
```
    A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
    
    Returns:
    
    this
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class PayPalModel
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
    Overrides:
    
    canEqual in class PayPalModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PayPalModel

Class Search

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

Search

Method Detail

getEmail

getRecipientFirstName

getRecipientLastName

getRecipientBusinessName

getNumber

getStatus

getLowerTotalAmount

getUpperTotalAmount

getStartInvoiceDate

getEndInvoiceDate

getStartDueDate

getEndDueDate

getStartPaymentDate

getEndPaymentDate

getStartCreationDate

getEndCreationDate

getPage

getPageSize

getTotalCountRequired

getArchived

setEmail

setRecipientFirstName

setRecipientLastName

setRecipientBusinessName

setNumber

setStatus

setLowerTotalAmount

setUpperTotalAmount

setStartInvoiceDate

setEndInvoiceDate

setStartDueDate

setEndDueDate

setStartPaymentDate

setEndPaymentDate

setStartCreationDate

setEndCreationDate

setPage

setPageSize

setTotalCountRequired

setArchived

equals

canEqual

hashCode