Struct OrderReturnServiceCharge

Source
pub struct OrderReturnServiceCharge {
Show 13 fields 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>>,
}
Expand description

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§

Source§

impl Clone for OrderReturnServiceCharge

Source§

fn clone(&self) -> OrderReturnServiceCharge

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OrderReturnServiceCharge

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OrderReturnServiceCharge

Source§

fn default() -> OrderReturnServiceCharge

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OrderReturnServiceCharge

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for OrderReturnServiceCharge

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for OrderReturnServiceCharge

Source§

impl StructuralPartialEq for OrderReturnServiceCharge

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,