PPRetailInvoiceItem Class Reference

Inherits from	PPRetailObject : NSObject
Declared in	PPRetailInvoiceItem.h

Overview

A line item on an invoice. Can be positive, negative, or zero total/unit price. See https://cms.paypal.com/cms_content/US/en_US/files/developer/PP_InvoicingAPIGuide.pdf for details on field length restrictions and formats.

`name`

The name of this item

@property (nonatomic, strong, nullable) NSString *name

Discussion

The name of this item

Declared In

PPRetailInvoiceItem.h

`itemDescription`

A description for this line item

@property (nonatomic, strong, nullable) NSString *itemDescription

Discussion

A description for this line item

Declared In

PPRetailInvoiceItem.h

`quantity`

The quantity of this item - up to three decimals

@property (nonatomic, strong, nullable) NSDecimalNumber *quantity

Discussion

The quantity of this item - up to three decimals

Declared In

PPRetailInvoiceItem.h

`unitPrice`

The price of 1 unit of this item

@property (nonatomic, strong, nullable) NSDecimalNumber *unitPrice

Discussion

The price of 1 unit of this item

Declared In

PPRetailInvoiceItem.h

`itemId`

A unique identifier for this item - not currently saved to the server but used for local uniqueness such that one line item per itemId.detailId pair will be stored on an invoice @readonly

@property (nonatomic, assign, readonly) int itemId

Discussion

A unique identifier for this item - not currently saved to the server but used for local uniqueness such that one line item per itemId.detailId pair will be stored on an invoice @readonly

Declared In

PPRetailInvoiceItem.h

`detailId`

A secondary unique identifier (e.g. for item options or sizes, or to create multiple items on the same invoice with a single detailId) @readonly

@property (nonatomic, strong, nullable, readonly) NSString *detailId

Discussion

A secondary unique identifier (e.g. for item options or sizes, or to create multiple items on the same invoice with a single detailId) @readonly

Declared In

PPRetailInvoiceItem.h

`taxName`

The name for the tax rate applied to this item, if any

@property (nonatomic, strong, nullable) NSString *taxName

Discussion

The name for the tax rate applied to this item, if any

Declared In

PPRetailInvoiceItem.h

`taxRate`

The tax rate to be applied to this item. If non-zero, the taxName must also be set.

@property (nonatomic, strong, nullable) NSDecimalNumber *taxRate

Discussion

The tax rate to be applied to this item. If non-zero, the taxName must also be set.

Declared In

PPRetailInvoiceItem.h

`discountPercentage`

A percentage discount for this line item

@property (nonatomic, strong, nullable) NSDecimalNumber *discountPercentage

Discussion

A percentage discount for this line item

Declared In

PPRetailInvoiceItem.h

`discountAmount`

A flat amount discount for this line item

@property (nonatomic, strong, nullable) NSDecimalNumber *discountAmount

Discussion

A flat amount discount for this line item

Declared In

PPRetailInvoiceItem.h

`date`

Date on which the item or service was provided

@property (nonatomic, strong, nullable) NSDate *date

Discussion

Date on which the item or service was provided

Declared In

PPRetailInvoiceItem.h

`imageURL`

Image url of the item. 4000 characters max.

@property (nonatomic, strong, nullable) NSString *imageURL

Discussion

Image url of the item. 4000 characters max.

Declared In

PPRetailInvoiceItem.h

`unitOfMeasure`

Unit of measure of the item being invoiced. *

@property (nonatomic, strong, nullable) NSString *unitOfMeasure

Discussion

Unit of measure of the item being invoiced. *

Declared In

PPRetailInvoiceItem.h

`– duplicate`

Create a true copy / duplicate of an item. This is named duplicate instead of copy to avoid code gen issues on iOS

- (PPRetailInvoiceItem *_Nullable)duplicate

Discussion

Create a true copy / duplicate of an item. This is named duplicate instead of copy to avoid code gen issues on iOS

Declared In

PPRetailInvoiceItem.h

`– discountAmountForDisplay`

Returns a decimal for the discount amount for this item, regardless of if it’s specified as an amount or percentage.

- (NSDecimalNumber *_Nullable)discountAmountForDisplay

Discussion

Returns a decimal for the discount amount for this item, regardless of if it’s specified as an amount or percentage.

Declared In

PPRetailInvoiceItem.h

`– isEqualToItem:`

check if an item is equal to this

- (BOOL)isEqualToItem:(PPRetailInvoiceItem *_Nullable)item

Discussion

check if an item is equal to this

Declared In

PPRetailInvoiceItem.h