OrderLineItemDiscount (Square 37.0.0.20240118 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	OrderLineItemDiscount(io.apimatic.core.types.OptionalNullable<String> uid, 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, io.apimatic.core.types.OptionalNullable<Map<String,String>> metadata, String scope, List<String> rewardIds, String pricingRuleId) Initialization constructor.
	`OrderLineItemDiscount(String uid, String catalogObjectId, Long catalogVersion, String name, String type, String percentage, Money amountMoney, Money appliedMoney, Map<String,String> metadata, String scope, List<String> rewardIds, String pricingRuleId)` 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.
`Map<String,String>`	`getMetadata()` Getter for Metadata.
`String`	`getName()` Getter for Name.
`String`	`getPercentage()` Getter for Percentage.
`String`	`getPricingRuleId()` Getter for PricingRuleId.
`List<String>`	`getRewardIds()` Getter for RewardIds.
`String`	`getScope()` Getter for Scope.
`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<Map<String,String>>`	`internalGetMetadata()` Internal Getter for Metadata.
`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>`	`internalGetUid()` Internal Getter for Uid.
`OrderLineItemDiscount.Builder`	`toBuilder()` Builds a new `OrderLineItemDiscount.Builder` object.
`String`	`toString()` Converts this OrderLineItemDiscount into string format.

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

- Constructor Detail
  - OrderLineItemDiscount
```
public OrderLineItemDiscount(String uid,
                             String catalogObjectId,
                             Long catalogVersion,
                             String name,
                             String type,
                             String percentage,
                             Money amountMoney,
                             Money appliedMoney,
                             Map<String,String> metadata,
                             String scope,
                             List<String> rewardIds,
                             String pricingRuleId)
```
    Initialization constructor.
    
    Parameters:
    
    uid - String value for uid.
    
    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.
    
    metadata - Map of String, value for metadata.
    
    scope - String value for scope.
    
    rewardIds - List of String value for rewardIds.
    
    pricingRuleId - String value for pricingRuleId.
  - OrderLineItemDiscount
```
protected OrderLineItemDiscount(io.apimatic.core.types.OptionalNullable<String> uid,
                                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,
                                io.apimatic.core.types.OptionalNullable<Map<String,String>> metadata,
                                String scope,
                                List<String> rewardIds,
                                String pricingRuleId)
```
    Initialization constructor.
    
    Parameters:
    
    uid - String value for uid.
    
    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.
    
    metadata - Map of String, value for metadata.
    
    scope - String value for scope.
    
    rewardIds - List of String value for rewardIds.
    
    pricingRuleId - String value for pricingRuleId.
- Method Detail
  - internalGetUid
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()
```
    Internal Getter for Uid. A unique ID that identifies the discount only within this order.
    
    Returns:
    
    Returns the Internal String
  - getUid
```
public String getUid()
```
    Getter for Uid. A unique ID that identifies the discount only within this order.
    
    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 discount, 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 discount, 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
  - internalGetMetadata
```
protected io.apimatic.core.types.OptionalNullable<Map<String,String>> internalGetMetadata()
```
    Internal Getter for Metadata. Application-defined data attached to this discount. 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 Internal Map of String, String
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Getter for Metadata. Application-defined data attached to this discount. 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
  - getScope
```
public String getScope()
```
    Getter for Scope. Indicates whether this is a line-item or order-level discount.
    
    Returns:
    
    Returns the String
  - getRewardIds
```
public List<String> getRewardIds()
```
    Getter for RewardIds. The reward IDs corresponding to this discount. The application and specification of discounts that have `reward_ids` are completely controlled by the backing criteria corresponding to the reward tiers of the rewards that are added to the order through the Loyalty API. To manually unapply discounts that are the result of added rewards, the rewards must be removed from the order through the Loyalty API.
    
    Returns:
    
    Returns the List of String
  - getPricingRuleId
```
public String getPricingRuleId()
```
    Getter for PricingRuleId. The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied automatically to this discount. The specification and application of the discounts, to which a `pricing_rule_id` is assigned, are completely controlled by the corresponding pricing rule.
    
    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 OrderLineItemDiscount into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public OrderLineItemDiscount.Builder toBuilder()
```
    Builds a new OrderLineItemDiscount.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new OrderLineItemDiscount.Builder object

Class OrderLineItemDiscount

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderLineItemDiscount

OrderLineItemDiscount

Method Detail

internalGetUid

getUid

internalGetCatalogObjectId

getCatalogObjectId

internalGetCatalogVersion

getCatalogVersion

internalGetName

getName

getType

internalGetPercentage

getPercentage

getAmountMoney

getAppliedMoney

internalGetMetadata

getMetadata

getScope

getRewardIds

getPricingRuleId

hashCode

equals

toString

toBuilder