OrderReturnServiceCharge (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.OrderReturnServiceCharge

```
public class OrderReturnServiceCharge
extends Object
```
This is a model class for OrderReturnServiceCharge type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OrderReturnServiceCharge.Builder
Class to build instances of OrderReturnServiceCharge.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrderReturnServiceCharge.Builder` Class to build instances of `OrderReturnServiceCharge`.

Constructor Summary

Constructors
Constructor and Description
`OrderReturnServiceCharge(String uid, String sourceServiceChargeUid, String name, String catalogObjectId, Long catalogVersion, String percentage, Money amountMoney, Money appliedMoney, Money totalMoney, Money totalTaxMoney, String calculationPhase, Boolean taxable, List<OrderLineItemAppliedTax> appliedTaxes)` 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.
`String`	`getName()` Getter for Name.
`String`	`getPercentage()` Getter for Percentage.
`String`	`getSourceServiceChargeUid()` Getter for SourceServiceChargeUid.
`Boolean`	`getTaxable()` Getter for Taxable.
`Money`	`getTotalMoney()` Getter for TotalMoney.
`Money`	`getTotalTaxMoney()` Getter for TotalTaxMoney.
`String`	`getUid()` Getter for Uid.
`int`	`hashCode()`
`OrderReturnServiceCharge.Builder`	`toBuilder()` Builds a new `OrderReturnServiceCharge.Builder` object.
`String`	`toString()` Converts this OrderReturnServiceCharge into string format.

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

- Constructor Detail
  - OrderReturnServiceCharge
```
public OrderReturnServiceCharge(String uid,
                                String sourceServiceChargeUid,
                                String name,
                                String catalogObjectId,
                                Long catalogVersion,
                                String percentage,
                                Money amountMoney,
                                Money appliedMoney,
                                Money totalMoney,
                                Money totalTaxMoney,
                                String calculationPhase,
                                Boolean taxable,
                                List<OrderLineItemAppliedTax> appliedTaxes)
```
    Initialization constructor.
    
    Parameters:
    
    uid - String value for uid.
    
    sourceServiceChargeUid - String value for sourceServiceChargeUid.
    
    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.
- Method Detail
  - getUid
```
public String getUid()
```
    Getter for Uid. A unique ID that identifies the return service charge only within this order.
    
    Returns:
    
    Returns the String
  - getSourceServiceChargeUid
```
public String getSourceServiceChargeUid()
```
    Getter for SourceServiceChargeUid. The service charge `uid` from the order containing the original service charge. `source_service_charge_uid` is `null` for unlinked returns.
    
    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 of the associated [OrderServiceCharge]($m/OrderServiceCharge).
    
    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 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.
    
    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 surcharge can be taxed. 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 `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.
    
    Returns:
    
    Returns the List of OrderLineItemAppliedTax
  - 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 OrderReturnServiceCharge into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public OrderReturnServiceCharge.Builder toBuilder()
```
    Builds a new OrderReturnServiceCharge.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new OrderReturnServiceCharge.Builder object

Class OrderReturnServiceCharge

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderReturnServiceCharge

Method Detail

getUid

getSourceServiceChargeUid

getName

getCatalogObjectId

getCatalogVersion

getPercentage

getAmountMoney

getAppliedMoney

getTotalMoney

getTotalTaxMoney

getCalculationPhase

getTaxable

getAppliedTaxes

hashCode

equals

toString

toBuilder