Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

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

Class InvoiceItem

Class InvoiceItem

Information about a single line item.

PayPal\Common\PayPalModel
Extended by PayPal\Api\InvoiceItem
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/InvoiceItem.php

Methods summary

public
# setName( string $name )

Name of the item. 200 characters max.

Name of the item. 200 characters max.

Parameters

$name

Returns


$this
public string
# getName( )

Name of the item. 200 characters max.

Name of the item. 200 characters max.

Returns

string
public
# setDescription( string $description )

Description of the item. 1000 characters max.

Description of the item. 1000 characters max.

Parameters

$description

Returns


$this
public string
# getDescription( )

Description of the item. 1000 characters max.

Description of the item. 1000 characters max.

Returns

string
public
# setQuantity( string|float $quantity )

Quantity of the item. Range of -10000 to 10000.

Quantity of the item. Range of -10000 to 10000.

Parameters

$quantity

Returns


$this
public string
# getQuantity( )

Quantity of the item. Range of -10000 to 10000.

Quantity of the item. Range of -10000 to 10000.

Returns

string
public
# setUnitPrice( PayPal\Api\Currency $unit_price )

Unit price of the item. Range of -1,000,000 to 1,000,000.

Unit price of the item. Range of -1,000,000 to 1,000,000.

Parameters

$unit_price

Returns


$this
public PayPal\Api\Currency
# getUnitPrice( )

Unit price of the item. Range of -1,000,000 to 1,000,000.

Unit price of the item. Range of -1,000,000 to 1,000,000.

Returns

PayPal\Api\Currency
public
# setTax( PayPal\Api\Tax $tax )

Tax associated with the item.

Tax associated with the item.

Parameters

$tax

Returns


$this
public PayPal\Api\Tax
# getTax( )

Tax associated with the item.

Tax associated with the item.

Returns

PayPal\Api\Tax
public
# setDate( string $date )

The date when the item or service was provided. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format.

The date when the item or service was provided. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format.

Parameters

$date

Returns


$this
public string
# getDate( )

The date when the item or service was provided. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format.

The date when the item or service was provided. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format.

Returns

string
public
# setDiscount( PayPal\Api\Cost $discount )

The item discount, as a percent or an amount value.

The item discount, as a percent or an amount value.

Parameters

$discount

Returns


$this
public PayPal\Api\Cost
# getDiscount( )

The item discount, as a percent or an amount value.

The item discount, as a percent or an amount value.

Returns

PayPal\Api\Cost
public
# setImageUrl( string $image_url )

The image URL. Maximum length is 4000 characters.

The image URL. Maximum length is 4000 characters.

Deprecated

Not publicly available

Parameters

$image_url

Returns


$this

Throws

InvalidArgumentException
public string
# getImageUrl( )

The image URL. Maximum length is 4000 characters.

The image URL. Maximum length is 4000 characters.

Deprecated

Not publicly available

Returns

string
public
# setUnitOfMeasure( string $unit_of_measure )

The unit of measure of the item being invoiced. Valid Values: ["QUANTITY", "HOURS", "AMOUNT"]

The unit of measure of the item being invoiced. Valid Values: ["QUANTITY", "HOURS", "AMOUNT"]

Parameters

$unit_of_measure

Returns


$this
public string
# getUnitOfMeasure( )

The unit of measure of the item being invoiced.

The unit of measure of the item being invoiced.

Returns

string

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

API documentation generated by ApiGen