1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! Model struct for OrderReturnServiceCharge type

use serde::{Deserialize, Serialize};
use crate::models::enums::{OrderServiceChargeScope, OrderServiceChargeTreatmentType};

use super::{enums::OrderServiceChargeCalculationPhase, Money, OrderLineItemAppliedTax};

/// Represents the service charge applied to the original order.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct OrderReturnServiceCharge {
    /// A unique ID that identifies the return service charge only within this order.
    pub uid: Option<String>,
    /// The service charge `uid` from the order containing the original service charge.
    /// `source_service_charge_uid` is `None` for unlinked returns.
    pub source_service_charge_uid: Option<String>,
    /// The name of the service charge.
    pub name: Option<String>,
    /// The catalog object ID of the associated [OrderServiceCharge].
    pub catalog_object_id: Option<String>,
    /// The version of the catalog object that this service charge references.
    pub catalog_version: Option<i64>,
    /// 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.
    pub percentage: Option<String>,
    /// The amount of a non-percentage-based service charge.
    ///
    /// Either `percentage` or `amount_money` should be set, but not both.
    pub amount_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.
    pub applied_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`.
    pub total_money: Option<Money>,
    /// **Read only** The total amount of tax money to collect for the service charge.
    pub total_tax_money: Option<Money>,
    /// **Read only** The calculation phase after which to apply the service charge.
    pub calculation_phase: Option<OrderServiceChargeCalculationPhase>,
    /// Indicates whether the surcharge can be taxed. Service charges calculated in the
    /// `TOTAL_PHASE` cannot be marked as taxable.
    pub taxable: Option<bool>,
    /// 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.
    pub applied_taxes: Option<Vec<OrderLineItemAppliedTax>>,
    /// **Read only** The treatment type of the service charge.
    pub treatment_type: Option<OrderServiceChargeTreatmentType>,
    /// Indicates the level at which the apportioned service charge applies. For ORDER scoped service charges,
    /// Square generates references in applied_service_charges on all order line items that do not have them.
    /// For LINE_ITEM scoped service charges, the service charge only applies to line items with a service
    /// charge reference in their applied_service_charges field.
    ///
    /// This field is immutable. To change the scope of an apportioned service charge, you must delete the
    /// apportioned service charge and re-add it as a new apportioned service charge.
    pub scope: Option<OrderServiceChargeScope>,
}