Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
25 lines (18 loc) · 2.82 KB

OrderReturnServiceCharge.md

File metadata and controls

25 lines (18 loc) · 2.82 KB

OrderReturnServiceCharge

Description

The service charge applied to the original order.

Properties

Name Type Description Notes
uid String Unique ID that identifies the return service charge only within this order. This field is read-only. [optional]
sourceServiceChargeUid String `uid` of the Service Charge from the Order which contains the original charge of this service charge, null for unlinked returns. [optional]
name String The name of the service charge. [optional]
catalogObjectId String The ID referencing the service charge CatalogObject [optional]
percentage String The 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]
amountMoney Money The amount of a non-percentage based service charge. Exactly one of percentage or amount_money should be set. [optional]
appliedMoney 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]
totalMoney 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]
totalTaxMoney Money The total amount of tax money to collect for the service charge. This field is read-only. [optional]
calculationPhase String The calculation phase after which to apply the service charge. This field is read-only. See OrderServiceChargeCalculationPhase for possible values [optional]
taxable Boolean Indicates whether the surcharge can be taxed. Service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable. [optional]
returnTaxes List<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]