Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 2.38 KB

OrderLineItemDiscount.md

File metadata and controls

17 lines (13 loc) · 2.38 KB

OrderLineItemDiscount

Properties

Name Getter Setter Type Description Notes
catalog_object_id getCatalogObjectId() setCatalogObjectId($value) string The catalog object id referencing CatalogDiscount. [optional]
name getName() setName($value) string The discount's name. [optional]
type getType() setType($value) string The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See OrderLineItemDiscountType for possible values. [optional]
percentage getPercentage() setPercentage($value) string 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%. The percentage won't be set for an amount-based discount. [optional]
amount_money getAmountMoney() setAmountMoney($value) \SquareConnect\Model\Money The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount. The amount_money won't be set for a percentage-based discount. [optional]
applied_money getAppliedMoney() setAppliedMoney($value) \SquareConnect\Model\Money The amount of discount actually applied to this line item. Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items. [optional]
scope getScope() setScope($value) string Indicates the level at which the discount applies. See OrderLineItemDiscountScope for possible values. [optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]