pub struct OrderLineItemTax {
pub uid: Option<String>,
pub catalog_object_id: Option<String>,
pub catalog_version: Option<i64>,
pub name: Option<String>,
pub type: Option<OrderLineItemTaxType>,
pub percentage: Option<String>,
pub metadata: Option<HashMap<String, String>>,
pub applied_money: Option<Money>,
pub scope: Option<OrderLineItemTaxScope>,
pub auto_applied: Option<bool>,
}
Expand description
Represents a tax that applies to one or more line item in the order.
Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount the item contributes to the order subtotal.
Fields§
§uid: Option<String>
A unique ID that identifies the tax only within this order.
catalog_object_id: Option<String>
The catalog object ID referencing [CatalogTax].
catalog_version: Option<i64>
The version of the catalog object that this tax references.
name: Option<String>
The tax’s name.
type: Option<OrderLineItemTaxType>
Indicates the calculation method used to apply the tax.
percentage: Option<String>
The percentage of the tax, as a string representation of a decimal number. For example, a value of “7.25” corresponds to a percentage of 7.25%.
metadata: Option<HashMap<String, String>>
Application-defined data attached to this tax. 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.
applied_money: Option<Money>
The amount of money applied by the tax in the order.
scope: Option<OrderLineItemTaxScope>
Indicates the level at which the tax applies. For ORDER
scoped taxes, Square generates
references in applied_taxes
on all order line items that do not have them. For LINE_ITEM
scoped taxes, the tax only applies to line items with references in their applied_taxes
field.
This field is immutable. To change the scope, you must delete the tax and re-add it as a new tax.
auto_applied: Option<bool>
Read only Determines whether the tax was automatically applied to the order based on the catalog configuration. For an example, see Automatically Apply Taxes to an Order.
Trait Implementations§
Source§impl Clone for OrderLineItemTax
impl Clone for OrderLineItemTax
Source§fn clone(&self) -> OrderLineItemTax
fn clone(&self) -> OrderLineItemTax
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 OrderLineItemTax
impl Debug for OrderLineItemTax
Source§impl Default for OrderLineItemTax
impl Default for OrderLineItemTax
Source§fn default() -> OrderLineItemTax
fn default() -> OrderLineItemTax
Source§impl<'de> Deserialize<'de> for OrderLineItemTax
impl<'de> Deserialize<'de> for OrderLineItemTax
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 OrderLineItemTax
impl PartialEq for OrderLineItemTax
Source§impl Serialize for OrderLineItemTax
impl Serialize for OrderLineItemTax
impl Eq for OrderLineItemTax
impl StructuralPartialEq for OrderLineItemTax
Auto Trait Implementations§
impl Freeze for OrderLineItemTax
impl RefUnwindSafe for OrderLineItemTax
impl Send for OrderLineItemTax
impl Sync for OrderLineItemTax
impl Unpin for OrderLineItemTax
impl UnwindSafe for OrderLineItemTax
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.