OrderServiceCharge (Square 20.0.0.20220512 API)

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.

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, Long catalogVersion, String percentage, Money amountMoney, Money appliedMoney, Money totalMoney, Money totalTaxMoney, String calculationPhase, Boolean taxable, List<OrderLineItemAppliedTax> appliedTaxes, Map<String,String> metadata, String type)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Long`	`getCatalogVersion()` Getter for CatalogVersion.
`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`	`getType()` Getter for Type.
`String`	`getUid()` Getter for Uid.
`int`	`hashCode()`
`OrderServiceCharge.Builder`	`toBuilder()` Builds a new `OrderServiceCharge.Builder` object.
`String`	`toString()` Converts this OrderServiceCharge into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OrderServiceCharge
```
public OrderServiceCharge(String uid,
                          String name,
                          String catalogObjectId,
                          Long catalogVersion,
                          String percentage,
                          Money amountMoney,
                          Money appliedMoney,
                          Money totalMoney,
                          Money totalTaxMoney,
                          String calculationPhase,
                          Boolean taxable,
                          List<OrderLineItemAppliedTax> appliedTaxes,
                          Map<String,String> metadata,
                          String type)
```
    Initialization constructor.
    
    Parameters:
    
    uid - String value for uid.
    
    name - String value for name.
    
    catalogObjectId - String value for catalogObjectId.
    
    catalogVersion - Long value for catalogVersion.
    
    percentage - String value for percentage.
    
    amountMoney - Money value for amountMoney.
    
    appliedMoney - Money value for appliedMoney.
    
    totalMoney - Money value for totalMoney.
    
    totalTaxMoney - Money value for totalTaxMoney.
    
    calculationPhase - String value for calculationPhase.
    
    taxable - Boolean value for taxable.
    
    appliedTaxes - List of OrderLineItemAppliedTax value for appliedTaxes.
    
    metadata - Map of String, value for metadata.
    
    type - String value for type.
- Method Detail
  - getUid
```
public String getUid()
```
    Getter for Uid. A unique ID that identifies the service charge only within this order.
    
    Returns:
    
    Returns the String
  - getName
```
public String getName()
```
    Getter for Name. The name of the service charge.
    
    Returns:
    
    Returns the String
  - getCatalogObjectId
```
public String getCatalogObjectId()
```
    Getter for CatalogObjectId. The catalog object ID referencing the service charge [CatalogObject]($m/CatalogObject).
    
    Returns:
    
    Returns the String
  - getCatalogVersion
```
public Long getCatalogVersion()
```
    Getter for CatalogVersion. The version of the catalog object that this service charge references.
    
    Returns:
    
    Returns the Long
  - 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.
    
    Returns:
    
    Returns the String
  - 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.
    
    Returns:
    
    Returns the Money
  - 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.
    
    Returns:
    
    Returns the Money
  - 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.
    
    Returns:
    
    Returns the Money
  - 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.
    
    Returns:
    
    Returns the Money
  - 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/orders-api/how-it-works#how-totals-are-calculated)
    
    Returns:
    
    Returns the String
  - 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.
    
    Returns:
    
    Returns the Boolean
  - getAppliedTaxes
```
public List<OrderLineItemAppliedTax> getAppliedTaxes()
```
    Getter for AppliedTaxes. The list of references to the 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` is 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.
    
    Returns:
    
    Returns the List of OrderLineItemAppliedTax
  - 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 (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can 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. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
    
    Returns:
    
    Returns the Map of String, String
  - getType
```
public String getType()
```
    Getter for Type.
    
    Returns:
    
    Returns the String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this OrderServiceCharge into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - 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

Class OrderServiceCharge

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderServiceCharge

Method Detail

getUid

getName

getCatalogObjectId

getCatalogVersion

getPercentage

getAmountMoney

getAppliedMoney

getTotalMoney

getTotalTaxMoney

getCalculationPhase

getTaxable

getAppliedTaxes

getMetadata

getType

hashCode

equals

toString

toBuilder