OrderReturnServiceCharge

October 23, 2019 ยท View on GitHub

Description

Represents the service charge applied to the original order.

Properties

NameTypeDescriptionNotes
uidStringUnique ID that identifies the return service charge only within this order.[optional] [beta]
sourceServiceChargeUidString`uid` of the Service Charge from the Order containing the original charge of the service charge. `source_service_charge_uid` is `null` for unlinked returns.[optional]
nameStringThe name of the service charge.[optional]
catalogObjectIdStringThe catalog object ID of the associated `CatalogServiceCharge`.[optional]
percentageStringThe 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%. Exactly one of `percentage` or `amount_money` should be set.[optional]
amountMoneyMoneyThe amount of a non-percentage based service charge. Exactly one of `percentage` or `amount_money` should be set.[optional]
appliedMoneyMoneyThe 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.[optional]
totalMoneyMoneyThe 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` since the inclusive tax amount will already be included in both `applied_money` and `total_tax_money`.[optional]
totalTaxMoneyMoneyThe total amount of tax money to collect for the service charge.[optional]
calculationPhaseStringThe calculation phase after which to apply the service charge. 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]
returnTaxesList<OrderReturnTax>Taxes applied to the `OrderReturnServiceCharge`. By default, return-level taxes apply to `OrderReturnServiceCharge`s calculated in the `SUBTOTAL_PHASE` if `taxable` is set to `true`. On read or retrieve, this list includes both item-level taxes and any return-level taxes apportioned to this item. This field has been deprecated in favour of `applied_taxes`.[optional] [deprecated]
appliedTaxesList<OrderLineItemAppliedTax>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 amount applied is populated.[optional] [beta]