Object Index
You are viewing an old version of the API
OrderServiceCharge
Object Index
Represents a service charge applied to an order.
Properties
Name | Description |
---|---|
uid
Beta
|
Unique ID that identifies the service charge only within this order. |
name
|
The name of the service charge. |
catalog_
|
The catalog object ID referencing the service charge CatalogObject. |
percentage
|
The service charge percentage as a string representation of a
decimal number. For example, Exactly 1 of |
amount_
|
The amount of a non-percentage based service charge. Exactly one of |
applied_
|
Read only The amount of money applied to the order by the service charge, including any inclusive tax amounts, as calculated by Square.
|
total_
|
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_
|
Read only The total amount of tax money to collect for the service charge. |
calculation_
|
The calculation phase at which to apply the service charge. |
taxable
|
Indicates whether the service charge can be taxed. If set to |
applied_
Beta
|
The list of references to taxes applied to this service charge. Each
An To change the amount of a tax, modify the referenced top-level tax. |
metadata
Beta
|
Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set
Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See Metadata for more information. |