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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Model struct for OrderServiceCharge type

use std::collections::HashMap;

use serde::{Deserialize, Serialize};

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

/// Represents a service charge applied to an order.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct OrderServiceCharge {
    /// A unique ID that identifies the service charge only within this order.
    pub uid: Option<String>,
    /// The name of the service charge.
    pub name: Option<String>,
    /// The catalog object ID referencing the service charge [CatalogObject].
    pub catalog_object_id: Option<String>,
    /// The version of the catalog object that this service charge references.
    pub catalog_version: Option<i64>,
    /// The service charge percentage as a string representation of a decimal number. For example,
    /// "7.25" indicates a service charge of 7.25%.
    ///
    /// Exactly 1 of `percentage` or `amount_money` should be set.
    pub percentage: Option<String>,
    /// The amount of a non-percentage-based service charge.
    ///
    /// Exactly one of `percentage` or `amount_money` should be set.
    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>,
    /// The calculation phase at which to apply the service charge.
    pub calculation_phase: Option<OrderServiceChargeCalculationPhase>,
    /// Indicates whether the service charge can be taxed. If set to `true`, order-level taxes
    /// automatically apply to the service charge. Note that service charges calculated in the
    /// `TOTAL_PHASE` cannot be marked as taxable.
    pub taxable: Option<bool>,
    /// The list of references to the taxes applied to this service charge. Each
    /// `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level
    /// `OrderLineItemTax` that is being applied to this service charge. On reads, the amount
    /// applied is populated.
    ///
    /// An `OrderLineItemAppliedTax` is automatically created on every taxable service charge for
    /// all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records for
    /// `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable
    /// service charge. Taxable service charges have the `taxable` field set to `true` and
    /// calculated in the `SUBTOTAL_PHASE`.
    ///
    /// To change the amount of a tax, modify the referenced top-level tax.
    pub applied_taxes: Option<Vec<OrderLineItemAppliedTax>>,
    /// Application-defined data attached to this service charge. Metadata fields are intended to
    /// store descriptive references or associations with an entity in another system or store brief
    /// information about the object. Square does not process this field; it only stores and returns
    /// it in relevant API calls. Do not use metadata to store any sensitive information (such as
    /// personally identifiable information or card details).
    ///
    /// Keys written by applications must be 60 characters or less and must be in the character set
    /// [a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are
    /// prefixed with a namespace, separated from the key with a ':' character.
    ///
    /// Values have a maximum length of 255 characters.
    ///
    /// An application can have up to 10 entries per metadata field.
    ///
    /// Entries written by applications are private and can only be read or modified by the same
    /// application.
    ///
    /// For more information, see
    /// [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
    pub metadata: Option<HashMap<String, String>>,
    /// **Read only** The type of the service charge.
    pub r#type: Option<OrderServiceChargeType>,
}