Struct CatalogDiscount

pub struct CatalogDiscount {
    pub name: Option<String>,
    pub discount_type: Option<CatalogDiscountType>,
    pub percentage: Option<String>,
    pub amount_money: Option<Money>,
    pub pin_required: Option<bool>,
    pub label_color: Option<String>,
    pub modify_tax_basis: Option<CatalogDiscountModifyTaxBasis>,
    pub maximum_amount_money: Option<Money>,
}

A discount applicable to items.

Fields

name: Option<String>

The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

discount_type: Option<CatalogDiscountType>

Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale.

percentage: Option<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.

amount_money: Option<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.

pin_required: Option<bool>

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.

label_color: Option<String>

The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.

modify_tax_basis: Option<CatalogDiscountModifyTaxBasis>

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.

maximum_amount_money: Option<Money>

For a percentage discount, the maximum absolute value of the discount. For example, if a 50% discount has a maximum_amount_money of $20, a $100 purchase will yield a $20 discount, not a $50 discount.

Trait Implementations

impl Clone for CatalogDiscount

fn clone(&self) -> CatalogDiscount

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogDiscount

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogDiscount

fn default() -> CatalogDiscount

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogDiscount

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogDiscount

fn eq(&self, other: &CatalogDiscount) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CatalogDiscount

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CatalogDiscount

impl StructuralPartialEq for CatalogDiscount