LineItem (postfinancecheckout-java-sdk 8.2.1 API)

java.lang.Object
- ch.postfinance.sdk.model.LineItem

```
public class LineItem
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`aggregatedTaxRate`
`protected BigDecimal`	`amountExcludingTax`
`protected BigDecimal`	`amountIncludingTax`
`protected Map<String,LineItemAttribute>`	`attributes`
`protected BigDecimal`	`discountExcludingTax`
`protected BigDecimal`	`discountIncludingTax`
`protected String`	`name`
`protected BigDecimal`	`quantity`
`protected Boolean`	`shippingRequired`
`protected String`	`sku`
`protected BigDecimal`	`taxAmount`
`protected BigDecimal`	`taxAmountPerUnit`
`protected List<Tax>`	`taxes`
`protected LineItemType`	`type`
`protected BigDecimal`	`undiscountedAmountExcludingTax`
`protected BigDecimal`	`undiscountedAmountIncludingTax`
`protected BigDecimal`	`undiscountedUnitPriceExcludingTax`
`protected BigDecimal`	`undiscountedUnitPriceIncludingTax`
`protected String`	`uniqueId`
`protected BigDecimal`	`unitPriceExcludingTax`
`protected BigDecimal`	`unitPriceIncludingTax`

Constructor Summary

Constructors
Constructor and Description

LineItem()

Constructors
Constructor and Description
`LineItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`BigDecimal`	`getAggregatedTaxRate()` The total tax rate applied to the item, calculated from the rates of all tax lines.
`BigDecimal`	`getAmountExcludingTax()` The line item price with discounts applied, excluding taxes.
`BigDecimal`	`getAmountIncludingTax()` The line item price with discounts applied, including taxes.
`Map<String,LineItemAttribute>`	`getAttributes()` A map of custom information for the item.
`BigDecimal`	`getDiscountExcludingTax()` The discount allocated to the item, excluding taxes.
`BigDecimal`	`getDiscountIncludingTax()` The discount allocated to the item, including taxes.
`String`	`getName()` The name of the product, ideally in the customer's language.
`BigDecimal`	`getQuantity()` The number of items that were purchased.
`String`	`getSku()` The SKU (stock-keeping unit) of the product.
`BigDecimal`	`getTaxAmount()` The sum of all taxes applied to the item.
`BigDecimal`	`getTaxAmountPerUnit()` The calculated tax amount per unit.
`List<Tax>`	`getTaxes()` A set of tax lines, each of which specifies a tax applied to the item.
`LineItemType`	`getType()` The type of the line item.
`BigDecimal`	`getUndiscountedAmountExcludingTax()` The line item price with discounts not applied, excluding taxes.
`BigDecimal`	`getUndiscountedAmountIncludingTax()` The line item price with discounts not applied, including taxes.
`BigDecimal`	`getUndiscountedUnitPriceExcludingTax()` The calculated price per unit with discounts not applied, excluding taxes.
`BigDecimal`	`getUndiscountedUnitPriceIncludingTax()` The calculated price per unit with discounts not applied, including taxes.
`String`	`getUniqueId()` The unique identifier of the line item within the set of line items.
`BigDecimal`	`getUnitPriceExcludingTax()` The calculated price per unit with discounts applied, excluding taxes.
`BigDecimal`	`getUnitPriceIncludingTax()` The calculated price per unit with discounts applied, including taxes.
`int`	`hashCode()`
`Boolean`	`isShippingRequired()` Whether the item required shipping.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - aggregatedTaxRate
```
protected BigDecimal aggregatedTaxRate
```
  - amountExcludingTax
```
protected BigDecimal amountExcludingTax
```
  - amountIncludingTax
```
protected BigDecimal amountIncludingTax
```
  - attributes
```
protected Map<String,LineItemAttribute> attributes
```
  - discountExcludingTax
```
protected BigDecimal discountExcludingTax
```
  - discountIncludingTax
```
protected BigDecimal discountIncludingTax
```
  - name
```
protected String name
```
  - quantity
```
protected BigDecimal quantity
```
  - shippingRequired
```
protected Boolean shippingRequired
```
  - sku
```
protected String sku
```
  - taxAmount
```
protected BigDecimal taxAmount
```
  - taxAmountPerUnit
```
protected BigDecimal taxAmountPerUnit
```
  - taxes
```
protected List<Tax> taxes
```
  - type
```
protected LineItemType type
```
  - undiscountedAmountExcludingTax
```
protected BigDecimal undiscountedAmountExcludingTax
```
  - undiscountedAmountIncludingTax
```
protected BigDecimal undiscountedAmountIncludingTax
```
  - undiscountedUnitPriceExcludingTax
```
protected BigDecimal undiscountedUnitPriceExcludingTax
```
  - undiscountedUnitPriceIncludingTax
```
protected BigDecimal undiscountedUnitPriceIncludingTax
```
  - uniqueId
```
protected String uniqueId
```
  - unitPriceExcludingTax
```
protected BigDecimal unitPriceExcludingTax
```
  - unitPriceIncludingTax
```
protected BigDecimal unitPriceIncludingTax
```
- Constructor Detail
  - LineItem
```
public LineItem()
```
- Method Detail
  - getAggregatedTaxRate
```
public BigDecimal getAggregatedTaxRate()
```
    The total tax rate applied to the item, calculated from the rates of all tax lines.
    
    Returns:
    
    aggregatedTaxRate
  - getAmountExcludingTax
```
public BigDecimal getAmountExcludingTax()
```
    The line item price with discounts applied, excluding taxes.
    
    Returns:
    
    amountExcludingTax
  - getAmountIncludingTax
```
public BigDecimal getAmountIncludingTax()
```
    The line item price with discounts applied, including taxes.
    
    Returns:
    
    amountIncludingTax
  - getAttributes
```
public Map<String,LineItemAttribute> getAttributes()
```
    A map of custom information for the item.
    
    Returns:
    
    attributes
  - getDiscountExcludingTax
```
public BigDecimal getDiscountExcludingTax()
```
    The discount allocated to the item, excluding taxes.
    
    Returns:
    
    discountExcludingTax
  - getDiscountIncludingTax
```
public BigDecimal getDiscountIncludingTax()
```
    The discount allocated to the item, including taxes.
    
    Returns:
    
    discountIncludingTax
  - getName
```
public String getName()
```
    The name of the product, ideally in the customer's language.
    
    Returns:
    
    name
  - getQuantity
```
public BigDecimal getQuantity()
```
    The number of items that were purchased.
    
    Returns:
    
    quantity
  - isShippingRequired
```
public Boolean isShippingRequired()
```
    Whether the item required shipping.
    
    Returns:
    
    shippingRequired
  - getSku
```
public String getSku()
```
    The SKU (stock-keeping unit) of the product.
    
    Returns:
    
    sku
  - getTaxAmount
```
public BigDecimal getTaxAmount()
```
    The sum of all taxes applied to the item.
    
    Returns:
    
    taxAmount
  - getTaxAmountPerUnit
```
public BigDecimal getTaxAmountPerUnit()
```
    The calculated tax amount per unit.
    
    Returns:
    
    taxAmountPerUnit
  - getTaxes
```
public List<Tax> getTaxes()
```
    A set of tax lines, each of which specifies a tax applied to the item.
    
    Returns:
    
    taxes
  - getType
```
public LineItemType getType()
```
    The type of the line item.
    
    Returns:
    
    type
  - getUndiscountedAmountExcludingTax
```
public BigDecimal getUndiscountedAmountExcludingTax()
```
    The line item price with discounts not applied, excluding taxes.
    
    Returns:
    
    undiscountedAmountExcludingTax
  - getUndiscountedAmountIncludingTax
```
public BigDecimal getUndiscountedAmountIncludingTax()
```
    The line item price with discounts not applied, including taxes.
    
    Returns:
    
    undiscountedAmountIncludingTax
  - getUndiscountedUnitPriceExcludingTax
```
public BigDecimal getUndiscountedUnitPriceExcludingTax()
```
    The calculated price per unit with discounts not applied, excluding taxes.
    
    Returns:
    
    undiscountedUnitPriceExcludingTax
  - getUndiscountedUnitPriceIncludingTax
```
public BigDecimal getUndiscountedUnitPriceIncludingTax()
```
    The calculated price per unit with discounts not applied, including taxes.
    
    Returns:
    
    undiscountedUnitPriceIncludingTax
  - getUniqueId
```
public String getUniqueId()
```
    The unique identifier of the line item within the set of line items.
    
    Returns:
    
    uniqueId
  - getUnitPriceExcludingTax
```
public BigDecimal getUnitPriceExcludingTax()
```
    The calculated price per unit with discounts applied, excluding taxes.
    
    Returns:
    
    unitPriceExcludingTax
  - getUnitPriceIncludingTax
```
public BigDecimal getUnitPriceIncludingTax()
```
    The calculated price per unit with discounts applied, including taxes.
    
    Returns:
    
    unitPriceIncludingTax
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LineItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

aggregatedTaxRate

amountExcludingTax

amountIncludingTax

attributes

discountExcludingTax

discountIncludingTax

name

quantity

shippingRequired

sku

taxAmount

taxAmountPerUnit

taxes

type

undiscountedAmountExcludingTax

undiscountedAmountIncludingTax

undiscountedUnitPriceExcludingTax

undiscountedUnitPriceIncludingTax

uniqueId

unitPriceExcludingTax

unitPriceIncludingTax

Constructor Detail

LineItem

Method Detail

getAggregatedTaxRate

getAmountExcludingTax

getAmountIncludingTax

getAttributes

getDiscountExcludingTax

getDiscountIncludingTax

getName

getQuantity

isShippingRequired

getSku

getTaxAmount

getTaxAmountPerUnit

getTaxes

getType

getUndiscountedAmountExcludingTax

getUndiscountedAmountIncludingTax

getUndiscountedUnitPriceExcludingTax

getUndiscountedUnitPriceIncludingTax

getUniqueId

getUnitPriceExcludingTax

getUnitPriceIncludingTax

equals

hashCode

toString