SquareConnect::OrderServiceCharge

Description

Represents a service charge applied to an order.

Properties

Name	Type	Description	Notes
uid	String	Unique ID that identifies the service charge only within this order. This field is read-only.	[optional]
name	String	The name of the service charge.	[optional]
catalog_object_id	String	The catalog object ID referencing the service charge CatalogObject.	[optional]
percentage	String	The service charge percentage, as a string representation of a decimal number. For example, `7.25` indicates 7.25% Exactly one of `percentage` or `amount_money` should be set.	[optional]
amount_money	Money	The amount of a non-percentage based service charge. Exactly one of `percentage` or `amount_money` should be set.	[optional]
applied_money	Money	The amount of money applied to the order by the service charge, as calculated by the server. 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. The `applied_money` field will include any inclusive tax amounts as well. This field is read-only.	[optional]
total_money	Money	The total amount of money to collect for the service charge. Note that `total_money` does not equal `applied_money` plus `total_tax_money` if an inclusive tax is applied to the service charge since the inclusive tax amount will be included in both `applied_money` and `total_tax_money`. This field is read-only.	[optional]
total_tax_money	Money	The total amount of tax money to collect for the service charge. This field is read-only.	[optional]
calculation_phase	String	The calculation phase at which to apply the service charge. See OrderServiceChargeCalculationPhase for possible values	[optional]
taxable	BOOLEAN	Indicates whether the service charge can be taxed. If set to `true`, any order-level taxes will automatically apply to this service charge. Note that service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.	[optional]
taxes	Array<OrderLineItemTax>	Taxes applied to the service charge. By default, order-level taxes apply to service charges calculated in the `SUBTOTAL_PHASE` if `taxable` is set to `true`.	[optional]