<- Object

Object

All versions ->

OrderReturnServiceCharge

Represents the service charge applied to the original order.

Link to section

Properties

Link to section

uid

string

Beta

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

Link to section

source_service_charge_uid

string

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.

Link to section

name

string

The name of the service charge.

Link to section

catalog_object_id

string

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

Exactly one of percentage or amount_money should be set.

Link to section

amount_money

The amount of a non-percentage based service charge.

Exactly one of percentage or amount_money should be set.

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 since the inclusive tax amount will already be 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 amount applied is populated.