Struct square_api_client::models::OrderReturnServiceCharge

pub struct OrderReturnServiceCharge {

    pub uid: Option<String>,
    pub source_service_charge_uid: Option<String>,
    pub name: Option<String>,
    pub catalog_object_id: Option<String>,
    pub catalog_version: Option<i64>,
    pub percentage: Option<String>,
    pub amount_money: Option<Money>,
    pub applied_money: Option<Money>,
    pub total_money: Option<Money>,
    pub total_tax_money: Option<Money>,
    pub calculation_phase: Option<OrderServiceChargeCalculationPhase>,
    pub taxable: Option<bool>,
    pub applied_taxes: Option<Vec<OrderLineItemAppliedTax>>,
}

Represents the service charge applied to the original order.

Fields

uid: Option<String>

A unique ID that identifies the return service charge only within this order.

source_service_charge_uid: Option<String>

The service charge uid from the order containing the original service charge. source_service_charge_uid is None for unlinked returns.

name: Option<String>

The name of the service charge.

catalog_object_id: Option<String>

The catalog object ID of the associated [OrderServiceCharge].

catalog_version: Option<i64>

The version of the catalog object that this service charge references.

percentage: Option<String>

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

Either percentage or amount_money should be set, but not both.

amount_money: Option<Money>

The amount of a non-percentage-based service charge.

Either percentage or amount_money should be set, but not both.

applied_money: Option<Money>

Read only The amount of money applied to the order by the service charge, including any inclusive tax amounts, as calculated by Square.

• For fixed-amount service charges, applied_money is equal to amount_money.
• For percentage-based service charges, applied_money is the money calculated using the percentage.

total_money: Option<Money>

Read only The total amount of money to collect for the service charge.

NOTE: If an inclusive tax is applied to the service charge, total_money does not equal applied_money plus total_tax_money because the inclusive tax amount is already included in both applied_money and total_tax_money.

total_tax_money: Option<Money>

Read only The total amount of tax money to collect for the service charge.

calculation_phase: Option<OrderServiceChargeCalculationPhase>

Read only The calculation phase after which to apply the service charge.

taxable: Option<bool>

Indicates whether the surcharge can be taxed. Service charges calculated in the TOTAL_PHASE cannot be marked as taxable.

applied_taxes: Option<Vec<OrderLineItemAppliedTax>>

The list of references to OrderReturnTax entities applied to the OrderReturnServiceCharge. Each OrderLineItemAppliedTax has a tax_uid that references the uid of a top-level OrderReturnTax that is being applied to the OrderReturnServiceCharge. On reads, the applied amount is populated.

Trait Implementations

impl Clone for OrderReturnServiceCharge

fn clone(&self) -> OrderReturnServiceCharge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrderReturnServiceCharge

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

Formats the value using the given formatter.

impl Default for OrderReturnServiceCharge

fn default() -> OrderReturnServiceCharge

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderReturnServiceCharge

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<OrderReturnServiceCharge> for OrderReturnServiceCharge

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for OrderReturnServiceCharge

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 OrderReturnServiceCharge

impl StructuralEq for OrderReturnServiceCharge

impl StructuralPartialEq for OrderReturnServiceCharge