Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
18 lines (13 loc) · 2.34 KB

CatalogDiscount.md

File metadata and controls

18 lines (13 loc) · 2.34 KB

SquareConnect.CatalogDiscount

Description

A discount applicable to items.

Properties

Name Type Description Notes
name String The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. [optional]
discount_type String Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See CatalogDiscountType for possible values [optional]
percentage String The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not use this field for amount-based or variable discounts. [optional]
amount_money Money The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. Do not use this field for percentage-based or variable discounts. [optional]
pin_required Boolean Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app. [optional]
label_color String The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. [optional]
modify_tax_basis String Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See CatalogDiscountModifyTaxBasis for possible values [optional]