com.squareup.square.models

Class OrderReturnDiscount

java.lang.Object

com.squareup.square.models.OrderReturnDiscount

public class OrderReturnDiscount
extends Object

This is a model class for OrderReturnDiscount type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OrderReturnDiscount(String uid, String sourceDiscountUid, String catalogObjectId, Long catalogVersion, String name, String type, String percentage, Money amountMoney, Money appliedMoney, String scope) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
Money	getAppliedMoney() Getter for AppliedMoney.
String	getCatalogObjectId() Getter for CatalogObjectId.
Long	getCatalogVersion() Getter for CatalogVersion.
String	getName() Getter for Name.
String	getPercentage() Getter for Percentage.
String	getScope() Getter for Scope.
String	getSourceDiscountUid() Getter for SourceDiscountUid.
String	getType() Getter for Type.
String	getUid() Getter for Uid.
int	hashCode()
OrderReturnDiscount.Builder	toBuilder() Builds a new OrderReturnDiscount.Builder object.
String	toString() Converts this OrderReturnDiscount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderReturnDiscount

public OrderReturnDiscount(String uid,
                           String sourceDiscountUid,
                           String catalogObjectId,
                           Long catalogVersion,
                           String name,
                           String type,
                           String percentage,
                           Money amountMoney,
                           Money appliedMoney,
                           String scope)

Initialization constructor.

Parameters:

uid - String value for uid.

sourceDiscountUid - String value for sourceDiscountUid.

catalogObjectId - String value for catalogObjectId.

catalogVersion - Long value for catalogVersion.

name - String value for name.

type - String value for type.

percentage - String value for percentage.

amountMoney - Money value for amountMoney.

appliedMoney - Money value for appliedMoney.

scope - String value for scope.

Method Detail

getUid

public String getUid()

Getter for Uid. A unique ID that identifies the returned discount only within this order.

Returns:

Returns the String

getSourceDiscountUid

public String getSourceDiscountUid()

Getter for SourceDiscountUid. The discount `uid` from the order that contains the original application of this discount.

Returns:

Returns the String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The catalog object ID referencing [CatalogDiscount]($m/CatalogDiscount).

Returns:

Returns the String

getCatalogVersion

public Long getCatalogVersion()

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

Returns:

Returns the Long

getName

public String getName()

Getter for Name. The discount's name.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Indicates how the discount is applied to the associated line item or order.

Returns:

Returns the String

getPercentage

public String getPercentage()

Getter for Percentage. The percentage of the tax, as a string representation of a decimal number. A value of `"7.25"` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts.

Returns:

Returns the String

getAmountMoney

public Money getAmountMoney()

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

getAppliedMoney

public Money getAppliedMoney()

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

getScope

public String getScope()

Getter for Scope. Indicates whether this is a line-item or order-level discount.

Returns:

Returns the String

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderReturnDiscount.Builder toBuilder()

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

Returns:

a new OrderReturnDiscount.Builder object