Class Search

Invoice search parameters.

PayPal\Api\Search

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Search.php

Methods summary

`public`	# `setEmail( string $email )` The initial letters of the email address. The initial letters of the email address. Parameters `$email` Returns $this
`public string`	# `getEmail( )` The initial letters of the email address. The initial letters of the email address. Returns string
`public`	# `setRecipientFirstName( string $recipient_first_name )` The initial letters of the recipient's first name. The initial letters of the recipient's first name. Parameters `$recipient_first_name` Returns $this
`public string`	# `getRecipientFirstName( )` The initial letters of the recipient's first name. The initial letters of the recipient's first name. Returns string
`public`	# `setRecipientLastName( string $recipient_last_name )` The initial letters of the recipient's last name. The initial letters of the recipient's last name. Parameters `$recipient_last_name` Returns $this
`public string`	# `getRecipientLastName( )` The initial letters of the recipient's last name. The initial letters of the recipient's last name. Returns string
`public`	# `setRecipientBusinessName( string $recipient_business_name )` The initial letters of the recipient's business name. The initial letters of the recipient's business name. Parameters `$recipient_business_name` Returns $this
`public string`	# `getRecipientBusinessName( )` The initial letters of the recipient's business name. The initial letters of the recipient's business name. Returns string
`public`	# `setNumber( string $number )` The invoice number. The invoice number. Parameters `$number` Returns $this
`public string`	# `getNumber( )` The invoice number. The invoice number. Returns string
`public`	# `setStatus( string $status )` The invoice status. Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"] The invoice status. Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"] Parameters `$status` Returns $this
`public string`	# `getStatus( )` The invoice status. The invoice status. Returns string
`public`	# `setLowerTotalAmount( PayPal\Api\Currency $lower_total_amount )` The lower limit of the total amount. The lower limit of the total amount. Parameters `$lower_total_amount` Returns $this
`public PayPal\Api\Currency`	# `getLowerTotalAmount( )` The lower limit of the total amount. The lower limit of the total amount. Returns `PayPal\Api\Currency`
`public`	# `setUpperTotalAmount( PayPal\Api\Currency $upper_total_amount )` The upper limit of total amount. The upper limit of total amount. Parameters `$upper_total_amount` Returns $this
`public PayPal\Api\Currency`	# `getUpperTotalAmount( )` The upper limit of total amount. The upper limit of total amount. Returns `PayPal\Api\Currency`
`public`	# `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. The start date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$start_invoice_date` Returns $this
`public string`	# `getStartInvoiceDate( )` The start date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The start date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The end date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$end_invoice_date` Returns $this
`public string`	# `getEndInvoiceDate( )` The end date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The end date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The start due date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$start_due_date` Returns $this
`public string`	# `getStartDueDate( )` The start due date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The start due date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The end due date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$end_due_date` Returns $this
`public string`	# `getEndDueDate( )` The end due date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The end due date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The start payment date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$start_payment_date` Returns $this
`public string`	# `getStartPaymentDate( )` The start payment date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The start payment date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The end payment date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$end_payment_date` Returns $this
`public string`	# `getEndPaymentDate( )` The end payment date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The end payment date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The start creation date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$start_creation_date` Returns $this
`public string`	# `getStartCreationDate( )` The start creation date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The start creation date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `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. The end creation date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Parameters `$end_creation_date` Returns $this
`public string`	# `getEndCreationDate( )` The end creation date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. The end creation date for the invoice. Date format is yyyy-MM-dd z, as defined in Internet Date/Time Format. Returns string
`public`	# `setPage( PayPal\Api\number $page )` The offset for the search results. The offset for the search results. Parameters `$page` Returns $this
`public PayPal\Api\number`	# `getPage( )` The offset for the search results. The offset for the search results. Returns PayPal\Api\number
`public`	# `setPageSize( PayPal\Api\number $page_size )` The page size for the search results. The page size for the search results. Parameters `$page_size` Returns $this
`public PayPal\Api\number`	# `getPageSize( )` The page size for the search results. The page size for the search results. Returns PayPal\Api\number
`public`	# `setTotalCountRequired( boolean $total_count_required )` Indicates whether the total count appears in the response. Default is `false`. Indicates whether the total count appears in the response. Default is `false`. Parameters `$total_count_required` Returns $this
`public boolean`	# `getTotalCountRequired( )` Indicates whether the total count appears in the response. Default is `false`. Indicates whether the total count appears in the response. Default is `false`. Returns boolean
`public`	# `setArchived( boolean $archived )` A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all. A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all. Parameters `$archived` Returns $this
`public boolean`	# `getArchived( )` A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all. A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all. Returns boolean

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

Namespaces

Classes

Class Search

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel