OrderReturnDiscount (Square 30.0.1.20230608 API)

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.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`OrderReturnDiscount(io.apimatic.core.types.OptionalNullable<String> uid, io.apimatic.core.types.OptionalNullable<String> sourceDiscountUid, io.apimatic.core.types.OptionalNullable<String> catalogObjectId, io.apimatic.core.types.OptionalNullable<Long> catalogVersion, io.apimatic.core.types.OptionalNullable<String> name, String type, io.apimatic.core.types.OptionalNullable<String> percentage, Money amountMoney, Money appliedMoney, String scope)` Internal initialization constructor.
	`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

All Methods Instance Methods Concrete Methods
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()`
`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>`	`internalGetPercentage()` Internal Getter for Percentage.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetSourceDiscountUid()` Internal Getter for SourceDiscountUid.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetUid()` Internal Getter for Uid.
`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.
  - OrderReturnDiscount
```
protected OrderReturnDiscount(io.apimatic.core.types.OptionalNullable<String> uid,
                              io.apimatic.core.types.OptionalNullable<String> sourceDiscountUid,
                              io.apimatic.core.types.OptionalNullable<String> catalogObjectId,
                              io.apimatic.core.types.OptionalNullable<Long> catalogVersion,
                              io.apimatic.core.types.OptionalNullable<String> name,
                              String type,
                              io.apimatic.core.types.OptionalNullable<String> percentage,
                              Money amountMoney,
                              Money appliedMoney,
                              String scope)
```
    Internal initialization constructor.
- Method Detail
  - internalGetUid
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()
```
    Internal Getter for Uid. A unique ID that identifies the returned discount only within this order.
    
    Returns:
    
    Returns the Internal String
  - getUid
```
public String getUid()
```
    Getter for Uid. A unique ID that identifies the returned discount only within this order.
    
    Returns:
    
    Returns the String
  - internalGetSourceDiscountUid
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetSourceDiscountUid()
```
    Internal Getter for SourceDiscountUid. The discount `uid` from the order that contains the original application of this discount.
    
    Returns:
    
    Returns the Internal 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
  - internalGetCatalogObjectId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCatalogObjectId()
```
    Internal Getter for CatalogObjectId. The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
    
    Returns:
    
    Returns the Internal String
  - getCatalogObjectId
```
public String getCatalogObjectId()
```
    Getter for CatalogObjectId. The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
    
    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 discount references.
    
    Returns:
    
    Returns the Internal Long
  - getCatalogVersion
```
public Long getCatalogVersion()
```
    Getter for CatalogVersion. The version of the catalog object that this discount references.
    
    Returns:
    
    Returns the Long
  - internalGetName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetName()
```
    Internal Getter for Name. The discount's name.
    
    Returns:
    
    Returns the Internal String
  - 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
  - internalGetPercentage
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPercentage()
```
    Internal 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 Internal 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

Class OrderReturnDiscount

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderReturnDiscount

OrderReturnDiscount

Method Detail

internalGetUid

getUid

internalGetSourceDiscountUid

getSourceDiscountUid

internalGetCatalogObjectId

getCatalogObjectId

internalGetCatalogVersion

getCatalogVersion

internalGetName

getName

getType

internalGetPercentage

getPercentage

getAmountMoney

getAppliedMoney

getScope

hashCode

equals

toString

toBuilder