• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

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

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

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

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

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

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

Max Length 10
amount_money
Money

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

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

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

total_tax_money
Money

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

calculation_phase
string

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

taxable
boolean

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

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

Share Feedback

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