<- Object

Object

OrderReturnServiceCharge

Represents the service charge applied to the original order.

Link to section

Properties

Link to section

uid

string

Beta

A unique ID that identifies the return service charge only within this order.

Link to section

source_service_charge_uid

string

The service charge uid from the order containing the original service charge. source_service_charge_uid is null for unlinked returns.

Link to section

name

string

The name of the service charge.

Link to section

catalog_object_id

string

Link to section

catalog_version

integer(64-bit)

The version of the catalog object that this service charge references.

Link to section

percentage

string

The 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%.

Either percentage or amount_money should be set, but not both.

Link to section

amount_money

The amount of a non-percentage-based service charge.

Either percentage or amount_money should be set, but not both.

Link to section

applied_money

Read only The 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.
Link to section

total_money

Read only The 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 because the inclusive tax amount is already included in both applied_money and total_tax_money.

Link to section

total_tax_money

Read only The total amount of tax money to collect for the service charge.

Link to section

calculation_phase

string

Read only The calculation phase after which to apply the service charge.

Link to section

taxable

boolean

Indicates whether the surcharge can be taxed. Service charges calculated in the TOTAL_PHASE cannot be marked as taxable.

Link to section

applied_taxes

Beta

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 applied amount is populated.

Link to section

treatment_type

string

Beta

The treatment type of the service charge.

Link to section

scope

string

Beta

Indicates the level at which the apportioned service charge applies. For ORDER scoped service charges, Square generates references in applied_service_charges on all order line items that do not have them. For LINE_ITEM scoped service charges, the service charge only applies to line items with a service charge reference in their applied_service_charges field.

This field is immutable. To change the scope of an apportioned service charge, you must delete the apportioned service charge and re-add it as a new apportioned service charge.