SquareConnect::OrderReturnDiscount

June 12, 2019 ยท View on GitHub

Description

The line item discount being returned.

Properties

NameTypeDescriptionNotes
uidStringUnique ID that identifies the return discount only within this order. This field is read-only.[optional]
source_discount_uidString`uid` of the Discount from the Order which contains the original application of this discount.[optional]
catalog_object_idStringThe catalog object id referencing CatalogDiscount.[optional]
nameStringThe discount's name.[optional]
typeStringThe 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]
percentageStringThe 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_moneyMoneyThe 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_moneyMoneyThe amount of discount actually applied to this line item. 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]
scopeStringIndicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See OrderLineItemDiscountScope for possible values[optional]