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>,
}
Expand description
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§
Source§impl Clone for CatalogDiscount
impl Clone for CatalogDiscount
Source§fn clone(&self) -> CatalogDiscount
fn clone(&self) -> CatalogDiscount
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CatalogDiscount
impl Debug for CatalogDiscount
Source§impl Default for CatalogDiscount
impl Default for CatalogDiscount
Source§fn default() -> CatalogDiscount
fn default() -> CatalogDiscount
Source§impl<'de> Deserialize<'de> for CatalogDiscount
impl<'de> Deserialize<'de> for CatalogDiscount
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for CatalogDiscount
impl PartialEq for CatalogDiscount
Source§impl Serialize for CatalogDiscount
impl Serialize for CatalogDiscount
impl Eq for CatalogDiscount
impl StructuralPartialEq for CatalogDiscount
Auto Trait Implementations§
impl Freeze for CatalogDiscount
impl RefUnwindSafe for CatalogDiscount
impl Send for CatalogDiscount
impl Sync for CatalogDiscount
impl Unpin for CatalogDiscount
impl UnwindSafe for CatalogDiscount
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.