SquareConnect::OrderReturnServiceCharge

June 12, 2019 ยท View on GitHub

Description

The service charge applied to the original order.

Properties

NameTypeDescriptionNotes
uidStringUnique ID that identifies the return service charge only within this order. This field is read-only.[optional]
source_service_charge_uidString`uid` of the Service Charge from the Order which contains the original charge of this service charge, null for unlinked returns.[optional]
nameStringThe name of the service charge.[optional]
catalog_object_idStringThe ID referencing the service charge CatalogObject[optional]
percentageStringThe percentage of the service charge, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. Exactly one of percentage or amount_money should be set.[optional]
amount_moneyMoneyThe amount of a non-percentage based service charge. Exactly one of percentage or amount_money should be set.[optional]
applied_moneyMoneyThe 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_moneyMoneyThe 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_moneyMoneyThe total amount of tax money to collect for the service charge. This field is read-only.[optional]
calculation_phaseStringThe calculation phase after which to apply the service charge. This field is read-only. See OrderServiceChargeCalculationPhase for possible values[optional]
taxableBOOLEANIndicates whether the surcharge can be taxed. Service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.[optional]
return_taxesArray<OrderReturnTax>The taxes which apply to the service charge. Return-level taxes apply by default to service charge calculated in the `SUBTOTAL_PHASE` if the service charge is marked as taxable.[optional]