Skip to content

Files

Latest commit

author
Francisco Rojas
Jun 22, 2017
e007ffd · Jun 22, 2017

History

History
35 lines (24 loc) · 2.17 KB

OrderLineItemDiscount.md

File metadata and controls

35 lines (24 loc) · 2.17 KB

Square.Connect.Model.OrderLineItemDiscount

Properties

Name Type Description Notes
Name string The discount's name. [optional]
Type TypeEnum 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 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]
AmountMoney 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]
AppliedMoney 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 ScopeEnum Indicates the level at which the discount applies. See OrderLineItemDiscountScope for possible values. [optional]

TypeEnum

Name Value
UNKNOWN "UNKNOWN"
FIXEDPERCENTAGE "FIXED_PERCENTAGE"
FIXEDAMOUNT "FIXED_AMOUNT"
VARIABLEPERCENTAGE "VARIABLE_PERCENTAGE"
VARIABLEAMOUNT "VARIABLE_AMOUNT"

ScopeEnum

Name Value
LINEITEM "LINE_ITEM"
ORDER "ORDER"

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