PHP Class PayPal\Api\InvoiceItem

Information about a single line item.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getDate ( ) : string The date when the item or service was provided. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
getDescription ( ) : string Description of the item. 1000 characters max.
getDiscount ( ) : Cost The item discount, as a percent or an amount value.
getImageUrl ( ) : string The image URL. Maximum length is 4000 characters.
getName ( ) : string Name of the item. 200 characters max.
getQuantity ( ) : string Quantity of the item. Range of -10000 to 10000.
getTax ( ) : Tax Tax associated with the item.
getUnitOfMeasure ( ) : string The unit of measure of the item being invoiced.
getUnitPrice ( ) : PayPal\Api\Currency Unit price of the item. Range of -1,000,000 to 1,000,000.
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.
setDescription ( string $description ) Description of the item. 1000 characters max.
setDiscount ( Cost $discount ) The item discount, as a percent or an amount value.
setImageUrl ( string $image_url ) The image URL. Maximum length is 4000 characters.
setName ( string $name ) Name of the item. 200 characters max.
setQuantity ( string | double $quantity ) Quantity of the item. Range of -10000 to 10000.
setTax ( Tax $tax ) Tax associated with the item.
setUnitOfMeasure ( string $unit_of_measure ) The unit of measure of the item being invoiced.
setUnitPrice ( PayPal\Api\Currency $unit_price ) Unit price of the item. Range of -1,000,000 to 1,000,000.

Method Details

getDate() public method

The date when the item or service was provided. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
public getDate ( ) : string
return string

getDescription() public method

Description of the item. 1000 characters max.
public getDescription ( ) : string
return string

getDiscount() public method

The item discount, as a percent or an amount value.
public getDiscount ( ) : Cost
return Cost

getImageUrl() public method

The image URL. Maximum length is 4000 characters.
Deprecation: Not publicly available
public getImageUrl ( ) : string
return string

getName() public method

Name of the item. 200 characters max.
public getName ( ) : string
return string

getQuantity() public method

Quantity of the item. Range of -10000 to 10000.
public getQuantity ( ) : string
return string

getTax() public method

Tax associated with the item.
public getTax ( ) : Tax
return Tax

getUnitOfMeasure() public method

The unit of measure of the item being invoiced.
public getUnitOfMeasure ( ) : string
return string

getUnitPrice() public method

Unit price of the item. Range of -1,000,000 to 1,000,000.
public getUnitPrice ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

setDate() public method

The date when the item or service was provided. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
public setDate ( string $date )
$date string

setDescription() public method

Description of the item. 1000 characters max.
public setDescription ( string $description )
$description string

setDiscount() public method

The item discount, as a percent or an amount value.
public setDiscount ( Cost $discount )
$discount Cost

setImageUrl() public method

The image URL. Maximum length is 4000 characters.
Deprecation: Not publicly available
public setImageUrl ( string $image_url )
$image_url string

setName() public method

Name of the item. 200 characters max.
public setName ( string $name )
$name string

setQuantity() public method

Quantity of the item. Range of -10000 to 10000.
public setQuantity ( string | double $quantity )
$quantity string | double

setTax() public method

Tax associated with the item.
public setTax ( Tax $tax )
$tax Tax

setUnitOfMeasure() public method

Valid Values: ["QUANTITY", "HOURS", "AMOUNT"]
public setUnitOfMeasure ( string $unit_of_measure )
$unit_of_measure string

setUnitPrice() public method

Unit price of the item. Range of -1,000,000 to 1,000,000.
public setUnitPrice ( PayPal\Api\Currency $unit_price )
$unit_price PayPal\Api\Currency