Struct OrderReturnTax

pub struct OrderReturnTax {
    pub uid: Option<String>,
    pub source_tax_id: Option<String>,
    pub catalog_object_id: Option<String>,
    pub catalog_version: Option<i64>,
    pub name: Option<String>,
    pub type: Option<OrderLineItemTaxType>,
    pub percentage: Option<String>,
    pub applied_money: Option<Money>,
    pub scope: Option<OrderLineItemTaxScope>,
}

Represents a tax being returned that applies to one or more return line items in an order.

Fixed-amount, order-scoped taxes are distributed across all non-zero return line item totals. The amount distributed to each return line item is relative to that item’s contribution to the order subtotal.

Fields

uid: Option<String>

A unique ID that identifies the returned tax only within this order.

source_tax_id: Option<String>

The tax uid from the order that contains the original tax charge.

catalog_object_id: Option<String>

The catalog object ID referencing [CatalogTax].

catalog_version: Option<i64>

The version of the catalog object that this tax references.

name: Option<String>

The tax’s name.

type: Option<OrderLineItemTaxType>

Indicates the calculation method used to apply the tax.

percentage: Option<String>

The percentage of the tax, as a string representation of a decimal number. For example, a value of “7.25” corresponds to a percentage of 7.25%.

applied_money: Option<Money>

The amount of money applied by the tax in an order.

scope: Option<OrderLineItemTaxScope>

Indicates the level at which the OrderReturnTax applies. For ORDER scoped taxes, Square generates references in applied_taxes on all OrderReturnLineItems. For LINE_ITEM scoped taxes, the tax is only applied to OrderReturnLineItems with references in their applied_discounts field.

Trait Implementations

impl Clone for OrderReturnTax

fn clone(&self) -> OrderReturnTax

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderReturnTax

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

Formats the value using the given formatter.

impl Default for OrderReturnTax

fn default() -> OrderReturnTax

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderReturnTax

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderReturnTax

fn eq(&self, other: &OrderReturnTax) -> 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 OrderReturnTax

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 OrderReturnTax

impl StructuralPartialEq for OrderReturnTax