PHP Class PayPal\Api\Search

Invoice search parameters.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getArchived ( ) : boolean A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
getEmail ( ) : string The initial letters of the email address.
getEndCreationDate ( ) : string The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getEndDueDate ( ) : string The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getEndInvoiceDate ( ) : string The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getEndPaymentDate ( ) : string The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getLowerTotalAmount ( ) : PayPal\Api\Currency The lower limit of the total amount.
getNumber ( ) : string The invoice number.
getPage ( ) : PayPal\Api\number The offset for the search results.
getPageSize ( ) : PayPal\Api\number The page size for the search results.
getRecipientBusinessName ( ) : string The initial letters of the recipient's business name.
getRecipientFirstName ( ) : string The initial letters of the recipient's first name.
getRecipientLastName ( ) : string The initial letters of the recipient's last name.
getStartCreationDate ( ) : string The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getStartDueDate ( ) : string The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getStartInvoiceDate ( ) : string The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getStartPaymentDate ( ) : string The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
getStatus ( ) : string The invoice status.
getTotalCountRequired ( ) : boolean Indicates whether the total count appears in the response. Default is false.
getUpperTotalAmount ( ) : PayPal\Api\Currency The upper limit of total amount.
setArchived ( boolean $archived ) A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
setEmail ( string $email ) The initial letters of the email address.
setEndCreationDate ( string $end_creation_date ) The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setEndDueDate ( string $end_due_date ) The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setEndInvoiceDate ( string $end_invoice_date ) The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setEndPaymentDate ( string $end_payment_date ) The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setLowerTotalAmount ( PayPal\Api\Currency $lower_total_amount ) The lower limit of the total amount.
setNumber ( string $number ) The invoice number.
setPage ( PayPal\Api\number $page ) The offset for the search results.
setPageSize ( PayPal\Api\number $page_size ) The page size for the search results.
setRecipientBusinessName ( string $recipient_business_name ) The initial letters of the recipient's business name.
setRecipientFirstName ( string $recipient_first_name ) The initial letters of the recipient's first name.
setRecipientLastName ( string $recipient_last_name ) The initial letters of the recipient's last name.
setStartCreationDate ( string $start_creation_date ) The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setStartDueDate ( string $start_due_date ) The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setStartInvoiceDate ( string $start_invoice_date ) The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setStartPaymentDate ( string $start_payment_date ) The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
setStatus ( string $status ) The invoice status.
setTotalCountRequired ( boolean $total_count_required ) Indicates whether the total count appears in the response. Default is false.
setUpperTotalAmount ( PayPal\Api\Currency $upper_total_amount ) The upper limit of total amount.

Method Details

getArchived() public method

A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
public getArchived ( ) : boolean
return boolean

getEmail() public method

The initial letters of the email address.
public getEmail ( ) : string
return string

getEndCreationDate() public method

The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getEndCreationDate ( ) : string
return string

getEndDueDate() public method

The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getEndDueDate ( ) : string
return string

getEndInvoiceDate() public method

The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getEndInvoiceDate ( ) : string
return string

getEndPaymentDate() public method

The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getEndPaymentDate ( ) : string
return string

getLowerTotalAmount() public method

The lower limit of the total amount.
public getLowerTotalAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getNumber() public method

The invoice number.
public getNumber ( ) : string
return string

getPage() public method

The offset for the search results.
public getPage ( ) : PayPal\Api\number
return PayPal\Api\number

getPageSize() public method

The page size for the search results.
public getPageSize ( ) : PayPal\Api\number
return PayPal\Api\number

getRecipientBusinessName() public method

The initial letters of the recipient's business name.
public getRecipientBusinessName ( ) : string
return string

getRecipientFirstName() public method

The initial letters of the recipient's first name.
public getRecipientFirstName ( ) : string
return string

getRecipientLastName() public method

The initial letters of the recipient's last name.
public getRecipientLastName ( ) : string
return string

getStartCreationDate() public method

The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getStartCreationDate ( ) : string
return string

getStartDueDate() public method

The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getStartDueDate ( ) : string
return string

getStartInvoiceDate() public method

The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getStartInvoiceDate ( ) : string
return string

getStartPaymentDate() public method

The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public getStartPaymentDate ( ) : string
return string

getStatus() public method

The invoice status.
public getStatus ( ) : string
return string

getTotalCountRequired() public method

Indicates whether the total count appears in the response. Default is false.
public getTotalCountRequired ( ) : boolean
return boolean

getUpperTotalAmount() public method

The upper limit of total amount.
public getUpperTotalAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

setArchived() public method

A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
public setArchived ( boolean $archived )
$archived boolean

setEmail() public method

The initial letters of the email address.
public setEmail ( string $email )
$email string

setEndCreationDate() public method

The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setEndCreationDate ( string $end_creation_date )
$end_creation_date string

setEndDueDate() public method

The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setEndDueDate ( string $end_due_date )
$end_due_date string

setEndInvoiceDate() public method

The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setEndInvoiceDate ( string $end_invoice_date )
$end_invoice_date string

setEndPaymentDate() public method

The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setEndPaymentDate ( string $end_payment_date )
$end_payment_date string

setLowerTotalAmount() public method

The lower limit of the total amount.
public setLowerTotalAmount ( PayPal\Api\Currency $lower_total_amount )
$lower_total_amount PayPal\Api\Currency

setNumber() public method

The invoice number.
public setNumber ( string $number )
$number string

setPage() public method

The offset for the search results.
public setPage ( PayPal\Api\number $page )
$page PayPal\Api\number

setPageSize() public method

The page size for the search results.
public setPageSize ( PayPal\Api\number $page_size )
$page_size PayPal\Api\number

setRecipientBusinessName() public method

The initial letters of the recipient's business name.
public setRecipientBusinessName ( string $recipient_business_name )
$recipient_business_name string

setRecipientFirstName() public method

The initial letters of the recipient's first name.
public setRecipientFirstName ( string $recipient_first_name )
$recipient_first_name string

setRecipientLastName() public method

The initial letters of the recipient's last name.
public setRecipientLastName ( string $recipient_last_name )
$recipient_last_name string

setStartCreationDate() public method

The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setStartCreationDate ( string $start_creation_date )
$start_creation_date string

setStartDueDate() public method

The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setStartDueDate ( string $start_due_date )
$start_due_date string

setStartInvoiceDate() public method

The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setStartInvoiceDate ( string $start_invoice_date )
$start_invoice_date string

setStartPaymentDate() public method

The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in Internet Date/Time Format.
public setStartPaymentDate ( string $start_payment_date )
$start_payment_date string

setStatus() public method

Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"]
public setStatus ( string $status )
$status string

setTotalCountRequired() public method

Indicates whether the total count appears in the response. Default is false.
public setTotalCountRequired ( boolean $total_count_required )
$total_count_required boolean

setUpperTotalAmount() public method

The upper limit of total amount.
public setUpperTotalAmount ( PayPal\Api\Currency $upper_total_amount )
$upper_total_amount PayPal\Api\Currency