Object Index / Definition

You are viewing an old version of the API
OrderReturnServiceCharge

Represents the service charge applied to the original order.

Properties

Name Description
uid
string

Beta

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

Max Length 60
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.

Max Length 60
name
string

The name of the service charge.

Max Length 255
catalog_object_id
string

The catalog object ID of the associated CatalogServiceCharge.

Max Length 192
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.

Max Length 10
amount_money
Money

The amount of a non-percentage based service charge.

Exactly one of percentage or amount_money should be set.

applied_money
Money

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.
total_money
Money

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.

total_tax_money
Money

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

calculation_phase
string

The calculation phase after which to apply the service charge. See OrderServiceChargeCalculationPhase for possible values

taxable
boolean

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

return_taxes
OrderReturnTax [ ]

Deprecated

Taxes applied to the OrderReturnServiceCharge. By default, return-level taxes apply to OrderReturnServiceCharges 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.

applied_taxes
OrderLineItemAppliedTax [ ]

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?