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 toamount_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
impl Clone for OrderReturnServiceCharge
Source§fn clone(&self) -> OrderReturnServiceCharge
fn clone(&self) -> OrderReturnServiceCharge
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 OrderReturnServiceCharge
impl Debug for OrderReturnServiceCharge
Source§impl Default for OrderReturnServiceCharge
impl Default for OrderReturnServiceCharge
Source§fn default() -> OrderReturnServiceCharge
fn default() -> OrderReturnServiceCharge
Source§impl<'de> Deserialize<'de> for OrderReturnServiceCharge
impl<'de> Deserialize<'de> for OrderReturnServiceCharge
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 OrderReturnServiceCharge
impl PartialEq for OrderReturnServiceCharge
Source§impl Serialize for OrderReturnServiceCharge
impl Serialize for OrderReturnServiceCharge
impl Eq for OrderReturnServiceCharge
impl StructuralPartialEq for OrderReturnServiceCharge
Auto Trait Implementations§
impl Freeze for OrderReturnServiceCharge
impl RefUnwindSafe for OrderReturnServiceCharge
impl Send for OrderReturnServiceCharge
impl Sync for OrderReturnServiceCharge
impl Unpin for OrderReturnServiceCharge
impl UnwindSafe for OrderReturnServiceCharge
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.