com.squareup.square.models

Class OrderServiceCharge

java.lang.Object

com.squareup.square.models.OrderServiceCharge

public class OrderServiceCharge
extends Object

This is a model class for OrderServiceCharge type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderServiceCharge.Builder Class to build instances of OrderServiceCharge

Constructor Summary

Constructors

Constructor and Description
OrderServiceCharge(String uid, String name, String catalogObjectId, String percentage, Money amountMoney, Money appliedMoney, Money totalMoney, Money totalTaxMoney, String calculationPhase, Boolean taxable, List<OrderLineItemAppliedTax> appliedTaxes, Map<String,String> metadata) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
Money	getAppliedMoney() Getter for AppliedMoney.
List<OrderLineItemAppliedTax>	getAppliedTaxes() Getter for AppliedTaxes.
String	getCalculationPhase() Getter for CalculationPhase.
String	getCatalogObjectId() Getter for CatalogObjectId.
Map<String,String>	getMetadata() Getter for Metadata.
String	getName() Getter for Name.
String	getPercentage() Getter for Percentage.
Boolean	getTaxable() Getter for Taxable.
Money	getTotalMoney() Getter for TotalMoney.
Money	getTotalTaxMoney() Getter for TotalTaxMoney.
String	getUid() Getter for Uid.
int	hashCode()
OrderServiceCharge.Builder	toBuilder() Builds a new OrderServiceCharge.Builder object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrderServiceCharge

public OrderServiceCharge(String uid,
                          String name,
                          String catalogObjectId,
                          String percentage,
                          Money amountMoney,
                          Money appliedMoney,
                          Money totalMoney,
                          Money totalTaxMoney,
                          String calculationPhase,
                          Boolean taxable,
                          List<OrderLineItemAppliedTax> appliedTaxes,
                          Map<String,String> metadata)

Initialization constructor.

Parameters:

uid -

name -

catalogObjectId -

percentage -

amountMoney -

appliedMoney -

totalMoney -

totalTaxMoney -

calculationPhase -

taxable -

appliedTaxes -

metadata -

Method Detail

getUid

public String getUid()

Getter for Uid. Unique ID that identifies the service charge only within this order.

getName

public String getName()

Getter for Name. The name of the service charge.

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The catalog object ID referencing the service charge [CatalogObject](#type-catalogobject).

getPercentage

public String getPercentage()

Getter for Percentage. The service charge percentage as a string representation of a decimal number. For example, `"7.25"` indicates a service charge of 7.25%. Exactly 1 of `percentage` or `amount_money` should be set.

getAmountMoney

public Money getAmountMoney()

Getter for AmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

getAppliedMoney

public Money getAppliedMoney()

Getter for AppliedMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

getTotalMoney

public Money getTotalMoney()

Getter for TotalMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

getTotalTaxMoney

public Money getTotalTaxMoney()

Getter for TotalTaxMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

getCalculationPhase

public String getCalculationPhase()

Getter for CalculationPhase. Represents a phase in the process of calculating order totals. Service charges are applied __after__ the indicated phase. [Read more about how order totals are calculated.](https://developer.squareup.com/docs/docs/orders-api/how-it-works#how-totals-are-calculated)

getTaxable

public Boolean getTaxable()

Getter for Taxable. Indicates whether the service charge can be taxed. If set to `true`, order-level taxes automatically apply to the service charge. Note that service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.

getAppliedTaxes

public List<OrderLineItemAppliedTax> getAppliedTaxes()

Getter for AppliedTaxes. The list of references to taxes applied to this service charge. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` will be automatically created on every taxable service charge for all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable service charge. Taxable service charges have the `taxable` field set to true and calculated in the `SUBTOTAL_PHASE`. To change the amount of a tax, modify the referenced top-level tax.

getMetadata

public Map<String,String> getMetadata()

Getter for Metadata. 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 `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. 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](https://developer.squareup.com/docs/build-basics/metadata) for more information.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toBuilder

public OrderServiceCharge.Builder toBuilder()

Builds a new OrderServiceCharge.Builder object. Creates the instance with the state of the current model.

Returns:

a new OrderServiceCharge.Builder object