OrderLineItem (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.OrderLineItem

```
public class OrderLineItem
extends Object
```
This is a model class for OrderLineItem type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OrderLineItem.Builder
Class to build instances of OrderLineItem.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrderLineItem.Builder` Class to build instances of `OrderLineItem`.

Constructor Summary

Constructors
Constructor and Description
OrderLineItem(String quantity, String uid, String name, OrderQuantityUnit quantityUnit, String note, String catalogObjectId, Long catalogVersion, String variationName, String itemType, Map<String,String> metadata, List<OrderLineItemModifier> modifiers, List<OrderLineItemAppliedTax> appliedTaxes, List<OrderLineItemAppliedDiscount> appliedDiscounts, Money basePriceMoney, Money variationTotalPriceMoney, Money grossSalesMoney, Money totalTaxMoney, Money totalDiscountMoney, Money totalMoney, OrderLineItemPricingBlocklists pricingBlocklists) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<OrderLineItemAppliedDiscount>`	`getAppliedDiscounts()` Getter for AppliedDiscounts.
`List<OrderLineItemAppliedTax>`	`getAppliedTaxes()` Getter for AppliedTaxes.
`Money`	`getBasePriceMoney()` Getter for BasePriceMoney.
`String`	`getCatalogObjectId()` Getter for CatalogObjectId.
`Long`	`getCatalogVersion()` Getter for CatalogVersion.
`Money`	`getGrossSalesMoney()` Getter for GrossSalesMoney.
`String`	`getItemType()` Getter for ItemType.
`Map<String,String>`	`getMetadata()` Getter for Metadata.
`List<OrderLineItemModifier>`	`getModifiers()` Getter for Modifiers.
`String`	`getName()` Getter for Name.
`String`	`getNote()` Getter for Note.
`OrderLineItemPricingBlocklists`	`getPricingBlocklists()` Getter for PricingBlocklists.
`String`	`getQuantity()` Getter for Quantity.
`OrderQuantityUnit`	`getQuantityUnit()` Getter for QuantityUnit.
`Money`	`getTotalDiscountMoney()` Getter for TotalDiscountMoney.
`Money`	`getTotalMoney()` Getter for TotalMoney.
`Money`	`getTotalTaxMoney()` Getter for TotalTaxMoney.
`String`	`getUid()` Getter for Uid.
`String`	`getVariationName()` Getter for VariationName.
`Money`	`getVariationTotalPriceMoney()` Getter for VariationTotalPriceMoney.
`int`	`hashCode()`
`OrderLineItem.Builder`	`toBuilder()` Builds a new `OrderLineItem.Builder` object.
`String`	`toString()` Converts this OrderLineItem into string format.

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

- Constructor Detail
  - OrderLineItem
```
public OrderLineItem(String quantity,
                     String uid,
                     String name,
                     OrderQuantityUnit quantityUnit,
                     String note,
                     String catalogObjectId,
                     Long catalogVersion,
                     String variationName,
                     String itemType,
                     Map<String,String> metadata,
                     List<OrderLineItemModifier> modifiers,
                     List<OrderLineItemAppliedTax> appliedTaxes,
                     List<OrderLineItemAppliedDiscount> appliedDiscounts,
                     Money basePriceMoney,
                     Money variationTotalPriceMoney,
                     Money grossSalesMoney,
                     Money totalTaxMoney,
                     Money totalDiscountMoney,
                     Money totalMoney,
                     OrderLineItemPricingBlocklists pricingBlocklists)
```
    Initialization constructor.
    
    Parameters:
    
    quantity - String value for quantity.
    
    uid - String value for uid.
    
    name - String value for name.
    
    quantityUnit - OrderQuantityUnit value for quantityUnit.
    
    note - String value for note.
    
    catalogObjectId - String value for catalogObjectId.
    
    catalogVersion - Long value for catalogVersion.
    
    variationName - String value for variationName.
    
    itemType - String value for itemType.
    
    metadata - Map of String, value for metadata.
    
    modifiers - List of OrderLineItemModifier value for modifiers.
    
    appliedTaxes - List of OrderLineItemAppliedTax value for appliedTaxes.
    
    appliedDiscounts - List of OrderLineItemAppliedDiscount value for appliedDiscounts.
    
    basePriceMoney - Money value for basePriceMoney.
    
    variationTotalPriceMoney - Money value for variationTotalPriceMoney.
    
    grossSalesMoney - Money value for grossSalesMoney.
    
    totalTaxMoney - Money value for totalTaxMoney.
    
    totalDiscountMoney - Money value for totalDiscountMoney.
    
    totalMoney - Money value for totalMoney.
    
    pricingBlocklists - OrderLineItemPricingBlocklists value for pricingBlocklists.
- Method Detail
  - getUid
```
public String getUid()
```
    Getter for Uid. A unique ID that identifies the line item only within this order.
    
    Returns:
    
    Returns the String
  - getName
```
public String getName()
```
    Getter for Name. The name of the line item.
    
    Returns:
    
    Returns the String
  - getQuantity
```
public String getQuantity()
```
    Getter for Quantity. The quantity purchased, formatted as a decimal number. For example, `"3"`. Line items with a quantity of `"0"` are automatically removed when paying for or otherwise completing the order. Line items with a `quantity_unit` can have non-integer quantities. For example, `"1.70000"`.
    
    Returns:
    
    Returns the String
  - getQuantityUnit
```
public OrderQuantityUnit getQuantityUnit()
```
    Getter for QuantityUnit. Contains the measurement unit for a quantity and a precision that specifies the number of digits after the decimal point for decimal quantities.
    
    Returns:
    
    Returns the OrderQuantityUnit
  - getNote
```
public String getNote()
```
    Getter for Note. The note of the line item.
    
    Returns:
    
    Returns the String
  - getCatalogObjectId
```
public String getCatalogObjectId()
```
    Getter for CatalogObjectId. The [CatalogItemVariation]($m/CatalogItemVariation) ID applied to this line item.
    
    Returns:
    
    Returns the String
  - getCatalogVersion
```
public Long getCatalogVersion()
```
    Getter for CatalogVersion. The version of the catalog object that this line item references.
    
    Returns:
    
    Returns the Long
  - getVariationName
```
public String getVariationName()
```
    Getter for VariationName. The name of the variation applied to this line item.
    
    Returns:
    
    Returns the String
  - getItemType
```
public String getItemType()
```
    Getter for ItemType. Represents the line item type.
    
    Returns:
    
    Returns the String
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Getter for Metadata. Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
    
    Returns:
    
    Returns the Map of String, String
  - getModifiers
```
public List<OrderLineItemModifier> getModifiers()
```
    Getter for Modifiers. The [CatalogModifier]($m/CatalogModifier)s applied to this line item.
    
    Returns:
    
    Returns the List of OrderLineItemModifier
  - getAppliedTaxes
```
public List<OrderLineItemAppliedTax> getAppliedTaxes()
```
    Getter for AppliedTaxes. The list of references to taxes applied to this line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` is automatically created on every line item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any line items. To change the amount of a tax, modify the referenced top-level tax.
    
    Returns:
    
    Returns the List of OrderLineItemAppliedTax
  - getAppliedDiscounts
```
public List<OrderLineItemAppliedDiscount> getAppliedDiscounts()
```
    Getter for AppliedDiscounts. The list of references to discounts applied to this line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderLineItemDiscounts` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedDiscount` is automatically created on every line item for all `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any line items. To change the amount of a discount, modify the referenced top-level discount.
    
    Returns:
    
    Returns the List of OrderLineItemAppliedDiscount
  - getBasePriceMoney
```
public Money getBasePriceMoney()
```
    Getter for BasePriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getVariationTotalPriceMoney
```
public Money getVariationTotalPriceMoney()
```
    Getter for VariationTotalPriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getGrossSalesMoney
```
public Money getGrossSalesMoney()
```
    Getter for GrossSalesMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalTaxMoney
```
public Money getTotalTaxMoney()
```
    Getter for TotalTaxMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalDiscountMoney
```
public Money getTotalDiscountMoney()
```
    Getter for TotalDiscountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalMoney
```
public Money getTotalMoney()
```
    Getter for TotalMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getPricingBlocklists
```
public OrderLineItemPricingBlocklists getPricingBlocklists()
```
    Getter for PricingBlocklists. Describes pricing adjustments that are blocked from manual and automatic application to a line item. For more information, see [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).
    
    Returns:
    
    Returns the OrderLineItemPricingBlocklists
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this OrderLineItem into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public OrderLineItem.Builder toBuilder()
```
    Builds a new OrderLineItem.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new OrderLineItem.Builder object

Class OrderLineItem

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderLineItem

Method Detail

getUid

getName

getQuantity

getQuantityUnit

getNote

getCatalogObjectId

getCatalogVersion

getVariationName

getItemType

getMetadata

getModifiers

getAppliedTaxes

getAppliedDiscounts

getBasePriceMoney

getVariationTotalPriceMoney

getGrossSalesMoney

getTotalTaxMoney

getTotalDiscountMoney

getTotalMoney

getPricingBlocklists

hashCode

equals

toString

toBuilder