ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / keebchat.com / core / libs / paypal / vendor / paypal / rest-api-sdk-php / lib / PayPal / Api

<?php

namespace PayPal\Api;

use PayPal\Common\PayPalModel;

/**
 * Class Search
 *
 * Invoice search parameters.
 *
 * @package PayPal\Api
 *
 * @property string email
 * @property string recipient_first_name
 * @property string recipient_last_name
 * @property string recipient_business_name
 * @property string number
 * @property string status
 * @property \PayPal\Api\Currency lower_total_amount
 * @property \PayPal\Api\Currency upper_total_amount
 * @property string start_invoice_date
 * @property string end_invoice_date
 * @property string start_due_date
 * @property string end_due_date
 * @property string start_payment_date
 * @property string end_payment_date
 * @property string start_creation_date
 * @property string end_creation_date
 * @property \PayPal\Api\number page
 * @property \PayPal\Api\number page_size
 * @property bool total_count_required
 * @property bool archived
 */
class Search extends PayPalModel
{
    /**
     * The initial letters of the email address.
     *
     * @param string $email
     * 
     * @return $this
     */
    public function setEmail($email)
    {
        $this->email = $email;
        return $this;
    }

/**
     * The initial letters of the email address.
     *
     * @return string
     */
    public function getEmail()
    {
        return $this->email;
    }

/**
     * The initial letters of the recipient's first name.
     *
     * @param string $recipient_first_name
     * 
     * @return $this
     */
    public function setRecipientFirstName($recipient_first_name)
    {
        $this->recipient_first_name = $recipient_first_name;
        return $this;
    }

/**
     * The initial letters of the recipient's first name.
     *
     * @return string
     */
    public function getRecipientFirstName()
    {
        return $this->recipient_first_name;
    }

/**
     * The initial letters of the recipient's last name.
     *
     * @param string $recipient_last_name
     * 
     * @return $this
     */
    public function setRecipientLastName($recipient_last_name)
    {
        $this->recipient_last_name = $recipient_last_name;
        return $this;
    }

/**
     * The initial letters of the recipient's last name.
     *
     * @return string
     */
    public function getRecipientLastName()
    {
        return $this->recipient_last_name;
    }

/**
     * The initial letters of the recipient's business name.
     *
     * @param string $recipient_business_name
     * 
     * @return $this
     */
    public function setRecipientBusinessName($recipient_business_name)
    {
        $this->recipient_business_name = $recipient_business_name;
        return $this;
    }

/**
     * The initial letters of the recipient's business name.
     *
     * @return string
     */
    public function getRecipientBusinessName()
    {
        return $this->recipient_business_name;
    }

/**
     * The invoice number.
     *
     * @param string $number
     * 
     * @return $this
     */
    public function setNumber($number)
    {
        $this->number = $number;
        return $this;
    }

/**
     * The invoice number.
     *
     * @return string
     */
    public function getNumber()
    {
        return $this->number;
    }

/**
     * The invoice status.
     * Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED"]
     *
     * @param string $status
     * 
     * @return $this
     */
    public function setStatus($status)
    {
        $this->status = $status;
        return $this;
    }

/**
     * The invoice status.
     *
     * @return string
     */
    public function getStatus()
    {
        return $this->status;
    }

/**
     * The lower limit of the total amount.
     *
     * @param \PayPal\Api\Currency $lower_total_amount
     * 
     * @return $this
     */
    public function setLowerTotalAmount($lower_total_amount)
    {
        $this->lower_total_amount = $lower_total_amount;
        return $this;
    }

/**
     * The lower limit of the total amount.
     *
     * @return \PayPal\Api\Currency
     */
    public function getLowerTotalAmount()
    {
        return $this->lower_total_amount;
    }

/**
     * The upper limit of total amount.
     *
     * @param \PayPal\Api\Currency $upper_total_amount
     * 
     * @return $this
     */
    public function setUpperTotalAmount($upper_total_amount)
    {
        $this->upper_total_amount = $upper_total_amount;
        return $this;
    }

/**
     * The upper limit of total amount.
     *
     * @return \PayPal\Api\Currency
     */
    public function getUpperTotalAmount()
    {
        return $this->upper_total_amount;
    }

/**
     * 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).
     *
     * @param string $start_invoice_date
     * 
     * @return $this
     */
    public function setStartInvoiceDate($start_invoice_date)
    {
        $this->start_invoice_date = $start_invoice_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getStartInvoiceDate()
    {
        return $this->start_invoice_date;
    }

/**
     * 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).
     *
     * @param string $end_invoice_date
     * 
     * @return $this
     */
    public function setEndInvoiceDate($end_invoice_date)
    {
        $this->end_invoice_date = $end_invoice_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getEndInvoiceDate()
    {
        return $this->end_invoice_date;
    }

/**
     * 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).
     *
     * @param string $start_due_date
     * 
     * @return $this
     */
    public function setStartDueDate($start_due_date)
    {
        $this->start_due_date = $start_due_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getStartDueDate()
    {
        return $this->start_due_date;
    }

/**
     * 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).
     *
     * @param string $end_due_date
     * 
     * @return $this
     */
    public function setEndDueDate($end_due_date)
    {
        $this->end_due_date = $end_due_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getEndDueDate()
    {
        return $this->end_due_date;
    }

/**
     * 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).
     *
     * @param string $start_payment_date
     * 
     * @return $this
     */
    public function setStartPaymentDate($start_payment_date)
    {
        $this->start_payment_date = $start_payment_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getStartPaymentDate()
    {
        return $this->start_payment_date;
    }

/**
     * 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).
     *
     * @param string $end_payment_date
     * 
     * @return $this
     */
    public function setEndPaymentDate($end_payment_date)
    {
        $this->end_payment_date = $end_payment_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getEndPaymentDate()
    {
        return $this->end_payment_date;
    }

/**
     * 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).
     *
     * @param string $start_creation_date
     * 
     * @return $this
     */
    public function setStartCreationDate($start_creation_date)
    {
        $this->start_creation_date = $start_creation_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getStartCreationDate()
    {
        return $this->start_creation_date;
    }

/**
     * 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).
     *
     * @param string $end_creation_date
     * 
     * @return $this
     */
    public function setEndCreationDate($end_creation_date)
    {
        $this->end_creation_date = $end_creation_date;
        return $this;
    }

/**
     * 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).
     *
     * @return string
     */
    public function getEndCreationDate()
    {
        return $this->end_creation_date;
    }

/**
     * The offset for the search results.
     *
     * @param \PayPal\Api\number $page
     * 
     * @return $this
     */
    public function setPage($page)
    {
        $this->page = $page;
        return $this;
    }

/**
     * The offset for the search results.
     *
     * @return \PayPal\Api\number
     */
    public function getPage()
    {
        return $this->page;
    }

/**
     * The page size for the search results.
     *
     * @param \PayPal\Api\number $page_size
     * 
     * @return $this
     */
    public function setPageSize($page_size)
    {
        $this->page_size = $page_size;
        return $this;
    }

/**
     * The page size for the search results.
     *
     * @return \PayPal\Api\number
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

/**
     * Indicates whether the total count appears in the response. Default is `false`.
     *
     * @param bool $total_count_required
     * 
     * @return $this
     */
    public function setTotalCountRequired($total_count_required)
    {
        $this->total_count_required = $total_count_required;
        return $this;
    }

/**
     * Indicates whether the total count appears in the response. Default is `false`.
     *
     * @return bool
     */
    public function getTotalCountRequired()
    {
        return $this->total_count_required;
    }

/**
     * A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
     *
     * @param bool $archived
     * 
     * @return $this
     */
    public function setArchived($archived)
    {
        $this->archived = $archived;
        return $this;
    }

/**
     * A flag indicating whether search is on invoices archived by merchant. true - returns archived / false returns unarchived / null returns all.
     *
     * @return bool
     */
    public function getArchived()
    {
        return $this->archived;
    }

}

[-] PaymentTerm.php [edit]
[-] Patch.php [edit]
[-] AgreementTransaction.php [edit]
[-] OverrideChargeModel.php [edit]
[-] RefundDetail.php [edit]
[-] PaymentExecution.php [edit]
[-] CurrencyConversion.php [edit]
[-] InvoiceItem.php [edit]
[-] Terms.php [edit]
[-] PaymentDetail.php [edit]
[-] BillingInfo.php [edit]
[-] CreditCardList.php [edit]
[-] MerchantInfo.php [edit]
[-] Links.php [edit]
[-] Transactions.php [edit]
[-] PaymentDefinition.php [edit]
[+] ..
[-] PaymentSummary.php [edit]
[-] OpenIdError.php [edit]
[-] BillingAgreementToken.php [edit]
[-] Sale.php [edit]
[-] Item.php [edit]
[-] Address.php [edit]
[-] InvoiceNumber.php [edit]
[-] Payee.php [edit]
[-] TransactionBase.php [edit]
[-] ExtendedBankAccount.php [edit]
[-] AgreementStateDescriptor.php [edit]
[-] RecipientBankingInstruction.php [edit]
[-] WebProfile.php [edit]
[-] Payout.php [edit]
[-] FundingDetail.php [edit]
[-] CreditFinancingOffered.php [edit]
[-] PaymentCardToken.php [edit]
[-] ProcessorResponse.php [edit]
[-] OpenIdTokeninfo.php [edit]
[-] PotentialPayerInfo.php [edit]
[-] MerchantPreferences.php [edit]
[-] InstallmentInfo.php [edit]
[-] InvoiceSearchResponse.php [edit]
[-] FmfDetails.php [edit]
[-] Agreement.php [edit]
[-] Incentive.php [edit]
[-] OpenIdSession.php [edit]
[-] Plan.php [edit]
[-] Refund.php [edit]
[-] BaseAddress.php [edit]
[-] CreditCardToken.php [edit]
[-] Amount.php [edit]
[-] CreateProfileResponse.php [edit]
[-] AgreementDetails.php [edit]
[-] Order.php [edit]
[-] CarrierAccount.php [edit]
[-] FuturePayment.php [edit]
[-] FileAttachment.php [edit]
[-] Image.php [edit]
[-] Details.php [edit]
[-] RedirectUrls.php [edit]
[-] RelatedResources.php [edit]
[-] AlternatePayment.php [edit]
[-] PrivateLabelCard.php [edit]
[-] Tax.php [edit]
[-] Phone.php [edit]
[-] Measurement.php [edit]
[-] RefundRequest.php [edit]
[-] Payer.php [edit]
[-] FundingSource.php [edit]
[-] PayoutBatch.php [edit]
[-] VerifyWebhookSignatureResponse.php [edit]
[-] CarrierAccountToken.php [edit]
[-] PayoutItem.php [edit]
[-] Authorization.php [edit]
[-] CreditCardHistory.php [edit]
[-] WebhookEventTypeList.php [edit]
[-] TemplateSettingsMetadata.php [edit]
[-] Cost.php [edit]
[-] PayoutItemDetails.php [edit]
[-] NameValuePair.php [edit]
[-] CancelNotification.php [edit]
[-] WebhookEvent.php [edit]
[-] ShippingInfo.php [edit]
[-] FundingOption.php [edit]
[-] ShippingAddress.php [edit]
[-] HyperSchema.php [edit]
[-] CartBase.php [edit]
[-] PayerInfo.php [edit]
[-] Notification.php [edit]
[-] PaymentHistory.php [edit]
[-] CustomAmount.php [edit]
[-] WebhookList.php [edit]
[-] Credit.php [edit]
[-] PlanList.php [edit]
[-] Metadata.php [edit]
[-] ShippingCost.php [edit]
[-] TemplateData.php [edit]
[-] ChargeModel.php [edit]
[-] Capture.php [edit]
[-] Transaction.php [edit]
[-] InputFields.php [edit]
[-] OpenIdUserinfo.php [edit]
[-] PatchRequest.php [edit]
[-] DetailedRefund.php [edit]
[-] PaymentCard.php [edit]
[-] AgreementTransactions.php [edit]
[-] Currency.php [edit]
[-] Participant.php [edit]
[-] PaymentOptions.php [edit]
[-] VerifyWebhookSignature.php [edit]
[-] BankAccountsList.php [edit]
[-] Template.php [edit]
[-] CountryCode.php [edit]
[-] ErrorDetails.php [edit]
[-] PaymentInstruction.php [edit]
[-] TemplateSettings.php [edit]
[-] Payment.php [edit]
[-] Search.php [edit]
[-] InstallmentOption.php [edit]
[-] Invoice.php [edit]
[-] BankAccount.php [edit]
[-] FundingInstrument.php [edit]
[-] FlowConfig.php [edit]
[-] ItemList.php [edit]
[-] Templates.php [edit]
[-] BankToken.php [edit]
[-] PayoutSenderBatchHeader.php [edit]
[-] PayoutBatchHeader.php [edit]
[-] Presentation.php [edit]
[-] Billing.php [edit]
[-] WebhookEventType.php [edit]
[-] OpenIdAddress.php [edit]
[-] InvoiceAddress.php [edit]
[-] CreditCard.php [edit]
[-] Webhook.php [edit]
[-] ExternalFunding.php [edit]
[-] WebhookEventList.php [edit]
[-] Error.php [edit]