com.squareup.square.models

Class OrderReturnLineItem

java.lang.Object

com.squareup.square.models.OrderReturnLineItem

public class OrderReturnLineItem
extends Object

This is a model class for OrderReturnLineItem type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderReturnLineItem.Builder Class to build instances of OrderReturnLineItem.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderReturnLineItem(String quantity, io.apimatic.core.types.OptionalNullable<String> uid, io.apimatic.core.types.OptionalNullable<String> sourceLineItemUid, io.apimatic.core.types.OptionalNullable<String> name, OrderQuantityUnit quantityUnit, io.apimatic.core.types.OptionalNullable<String> note, io.apimatic.core.types.OptionalNullable<String> catalogObjectId, io.apimatic.core.types.OptionalNullable<Long> catalogVersion, io.apimatic.core.types.OptionalNullable<String> variationName, String itemType, io.apimatic.core.types.OptionalNullable<List<OrderReturnLineItemModifier>> returnModifiers, io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>> appliedTaxes, io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedDiscount>> appliedDiscounts, Money basePriceMoney, Money variationTotalPriceMoney, Money grossReturnMoney, Money totalTaxMoney, Money totalDiscountMoney, Money totalMoney, io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedServiceCharge>> appliedServiceCharges, Money totalServiceChargeMoney) Internal initialization constructor.
	OrderReturnLineItem(String quantity, String uid, String sourceLineItemUid, String name, OrderQuantityUnit quantityUnit, String note, String catalogObjectId, Long catalogVersion, String variationName, String itemType, List<OrderReturnLineItemModifier> returnModifiers, List<OrderLineItemAppliedTax> appliedTaxes, List<OrderLineItemAppliedDiscount> appliedDiscounts, Money basePriceMoney, Money variationTotalPriceMoney, Money grossReturnMoney, Money totalTaxMoney, Money totalDiscountMoney, Money totalMoney, List<OrderLineItemAppliedServiceCharge> appliedServiceCharges, Money totalServiceChargeMoney) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<OrderLineItemAppliedDiscount>	getAppliedDiscounts() Getter for AppliedDiscounts.
List<OrderLineItemAppliedServiceCharge>	getAppliedServiceCharges() Getter for AppliedServiceCharges.
List<OrderLineItemAppliedTax>	getAppliedTaxes() Getter for AppliedTaxes.
Money	getBasePriceMoney() Getter for BasePriceMoney.
String	getCatalogObjectId() Getter for CatalogObjectId.
Long	getCatalogVersion() Getter for CatalogVersion.
Money	getGrossReturnMoney() Getter for GrossReturnMoney.
String	getItemType() Getter for ItemType.
String	getName() Getter for Name.
String	getNote() Getter for Note.
String	getQuantity() Getter for Quantity.
OrderQuantityUnit	getQuantityUnit() Getter for QuantityUnit.
List<OrderReturnLineItemModifier>	getReturnModifiers() Getter for ReturnModifiers.
String	getSourceLineItemUid() Getter for SourceLineItemUid.
Money	getTotalDiscountMoney() Getter for TotalDiscountMoney.
Money	getTotalMoney() Getter for TotalMoney.
Money	getTotalServiceChargeMoney() Getter for TotalServiceChargeMoney.
Money	getTotalTaxMoney() Getter for TotalTaxMoney.
String	getUid() Getter for Uid.
String	getVariationName() Getter for VariationName.
Money	getVariationTotalPriceMoney() Getter for VariationTotalPriceMoney.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedDiscount>>	internalGetAppliedDiscounts() Internal Getter for AppliedDiscounts.
protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedServiceCharge>>	internalGetAppliedServiceCharges() Internal Getter for AppliedServiceCharges.
protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>>	internalGetAppliedTaxes() Internal Getter for AppliedTaxes.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCatalogObjectId() Internal Getter for CatalogObjectId.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetCatalogVersion() Internal Getter for CatalogVersion.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetNote() Internal Getter for Note.
protected io.apimatic.core.types.OptionalNullable<List<OrderReturnLineItemModifier>>	internalGetReturnModifiers() Internal Getter for ReturnModifiers.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSourceLineItemUid() Internal Getter for SourceLineItemUid.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUid() Internal Getter for Uid.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetVariationName() Internal Getter for VariationName.
OrderReturnLineItem.Builder	toBuilder() Builds a new OrderReturnLineItem.Builder object.
String	toString() Converts this OrderReturnLineItem into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderReturnLineItem

public OrderReturnLineItem(String quantity,
                           String uid,
                           String sourceLineItemUid,
                           String name,
                           OrderQuantityUnit quantityUnit,
                           String note,
                           String catalogObjectId,
                           Long catalogVersion,
                           String variationName,
                           String itemType,
                           List<OrderReturnLineItemModifier> returnModifiers,
                           List<OrderLineItemAppliedTax> appliedTaxes,
                           List<OrderLineItemAppliedDiscount> appliedDiscounts,
                           Money basePriceMoney,
                           Money variationTotalPriceMoney,
                           Money grossReturnMoney,
                           Money totalTaxMoney,
                           Money totalDiscountMoney,
                           Money totalMoney,
                           List<OrderLineItemAppliedServiceCharge> appliedServiceCharges,
                           Money totalServiceChargeMoney)

Initialization constructor.

Parameters:

quantity - String value for quantity.

uid - String value for uid.

sourceLineItemUid - String value for sourceLineItemUid.

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.

returnModifiers - List of OrderReturnLineItemModifier value for returnModifiers.

appliedTaxes - List of OrderLineItemAppliedTax value for appliedTaxes.

appliedDiscounts - List of OrderLineItemAppliedDiscount value for appliedDiscounts.

basePriceMoney - Money value for basePriceMoney.

variationTotalPriceMoney - Money value for variationTotalPriceMoney.

grossReturnMoney - Money value for grossReturnMoney.

totalTaxMoney - Money value for totalTaxMoney.

totalDiscountMoney - Money value for totalDiscountMoney.

totalMoney - Money value for totalMoney.

appliedServiceCharges - List of OrderLineItemAppliedServiceCharge value for appliedServiceCharges.

totalServiceChargeMoney - Money value for totalServiceChargeMoney.

OrderReturnLineItem

protected OrderReturnLineItem(String quantity,
                              io.apimatic.core.types.OptionalNullable<String> uid,
                              io.apimatic.core.types.OptionalNullable<String> sourceLineItemUid,
                              io.apimatic.core.types.OptionalNullable<String> name,
                              OrderQuantityUnit quantityUnit,
                              io.apimatic.core.types.OptionalNullable<String> note,
                              io.apimatic.core.types.OptionalNullable<String> catalogObjectId,
                              io.apimatic.core.types.OptionalNullable<Long> catalogVersion,
                              io.apimatic.core.types.OptionalNullable<String> variationName,
                              String itemType,
                              io.apimatic.core.types.OptionalNullable<List<OrderReturnLineItemModifier>> returnModifiers,
                              io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>> appliedTaxes,
                              io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedDiscount>> appliedDiscounts,
                              Money basePriceMoney,
                              Money variationTotalPriceMoney,
                              Money grossReturnMoney,
                              Money totalTaxMoney,
                              Money totalDiscountMoney,
                              Money totalMoney,
                              io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedServiceCharge>> appliedServiceCharges,
                              Money totalServiceChargeMoney)

Internal initialization constructor.

Method Detail

internalGetUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()

Internal Getter for Uid. A unique ID for this return line-item entry.

Returns:

Returns the Internal String

getUid

public String getUid()

Getter for Uid. A unique ID for this return line-item entry.

Returns:

Returns the String

internalGetSourceLineItemUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetSourceLineItemUid()

Internal Getter for SourceLineItemUid. The `uid` of the line item in the original sale order.

Returns:

Returns the Internal String

getSourceLineItemUid

public String getSourceLineItemUid()

Getter for SourceLineItemUid. The `uid` of the line item in the original sale order.

Returns:

Returns the String

internalGetName

protected io.apimatic.core.types.OptionalNullable<String> internalGetName()

Internal Getter for Name. The name of the line item.

Returns:

Returns the Internal 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 returned, formatted as a decimal number. For example, `"3"`. 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

internalGetNote

protected io.apimatic.core.types.OptionalNullable<String> internalGetNote()

Internal Getter for Note. The note of the return line item.

Returns:

Returns the Internal String

getNote

public String getNote()

Getter for Note. The note of the return line item.

Returns:

Returns the String

internalGetCatalogObjectId

protected io.apimatic.core.types.OptionalNullable<String> internalGetCatalogObjectId()

Internal Getter for CatalogObjectId. The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.

Returns:

Returns the Internal String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.

Returns:

Returns the String

internalGetCatalogVersion

protected io.apimatic.core.types.OptionalNullable<Long> internalGetCatalogVersion()

Internal Getter for CatalogVersion. The version of the catalog object that this line item references.

Returns:

Returns the Internal Long

getCatalogVersion

public Long getCatalogVersion()

Getter for CatalogVersion. The version of the catalog object that this line item references.

Returns:

Returns the Long

internalGetVariationName

protected io.apimatic.core.types.OptionalNullable<String> internalGetVariationName()

Internal Getter for VariationName. The name of the variation applied to this return line item.

Returns:

Returns the Internal String

getVariationName

public String getVariationName()

Getter for VariationName. The name of the variation applied to this return line item.

Returns:

Returns the String

getItemType

public String getItemType()

Getter for ItemType. Represents the line item type.

Returns:

Returns the String

internalGetReturnModifiers

protected io.apimatic.core.types.OptionalNullable<List<OrderReturnLineItemModifier>> internalGetReturnModifiers()

Internal Getter for ReturnModifiers. The [CatalogModifier](entity:CatalogModifier)s applied to this line item.

Returns:

Returns the Internal List of OrderReturnLineItemModifier

getReturnModifiers

public List<OrderReturnLineItemModifier> getReturnModifiers()

Getter for ReturnModifiers. The [CatalogModifier](entity:CatalogModifier)s applied to this line item.

Returns:

Returns the List of OrderReturnLineItemModifier

internalGetAppliedTaxes

protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>> internalGetAppliedTaxes()

Internal Getter for AppliedTaxes. The list of references to `OrderReturnTax` entities applied to the return line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the return line item. On reads, the applied amount is populated.

Returns:

Returns the Internal List of OrderLineItemAppliedTax

getAppliedTaxes

public List<OrderLineItemAppliedTax> getAppliedTaxes()

Getter for AppliedTaxes. The list of references to `OrderReturnTax` entities applied to the return line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the return line item. On reads, the applied amount is populated.

Returns:

Returns the List of OrderLineItemAppliedTax

internalGetAppliedDiscounts

protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedDiscount>> internalGetAppliedDiscounts()

Internal Getter for AppliedDiscounts. The list of references to `OrderReturnDiscount` entities applied to the return line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderReturnDiscount` applied to the return line item. On reads, the applied amount is populated.

Returns:

Returns the Internal List of OrderLineItemAppliedDiscount

getAppliedDiscounts

public List<OrderLineItemAppliedDiscount> getAppliedDiscounts()

Getter for AppliedDiscounts. The list of references to `OrderReturnDiscount` entities applied to the return line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderReturnDiscount` applied to the return line item. On reads, the applied amount is populated.

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

getGrossReturnMoney

public Money getGrossReturnMoney()

Getter for GrossReturnMoney. 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

internalGetAppliedServiceCharges

protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedServiceCharge>> internalGetAppliedServiceCharges()

Internal Getter for AppliedServiceCharges. The list of references to `OrderReturnServiceCharge` entities applied to the return line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that references the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line item. On reads, the applied amount is populated.

Returns:

Returns the Internal List of OrderLineItemAppliedServiceCharge

getAppliedServiceCharges

public List<OrderLineItemAppliedServiceCharge> getAppliedServiceCharges()

Getter for AppliedServiceCharges. The list of references to `OrderReturnServiceCharge` entities applied to the return line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that references the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line item. On reads, the applied amount is populated.

Returns:

Returns the List of OrderLineItemAppliedServiceCharge

getTotalServiceChargeMoney

public Money getTotalServiceChargeMoney()

Getter for TotalServiceChargeMoney. 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

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 OrderReturnLineItem into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderReturnLineItem.Builder toBuilder()

Builds a new OrderReturnLineItem.Builder object. Creates the instance with the state of the current model.

Returns:

a new OrderReturnLineItem.Builder object