com.squareup.square.models

Class OrderReturnServiceCharge

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderReturnServiceCharge(io.apimatic.core.types.OptionalNullable<String> uid, io.apimatic.core.types.OptionalNullable<String> sourceServiceChargeUid, io.apimatic.core.types.OptionalNullable<String> name, io.apimatic.core.types.OptionalNullable<String> catalogObjectId, io.apimatic.core.types.OptionalNullable<Long> catalogVersion, io.apimatic.core.types.OptionalNullable<String> percentage, Money amountMoney, Money appliedMoney, Money totalMoney, Money totalTaxMoney, String calculationPhase, io.apimatic.core.types.OptionalNullable<Boolean> taxable, io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>> appliedTaxes, String treatmentType, String scope) Internal initialization constructor.
	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, String treatmentType, String scope) 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.
Long	getCatalogVersion() Getter for CatalogVersion.
String	getName() Getter for Name.
String	getPercentage() Getter for Percentage.
String	getScope() Getter for Scope.
String	getSourceServiceChargeUid() Getter for SourceServiceChargeUid.
Boolean	getTaxable() Getter for Taxable.
Money	getTotalMoney() Getter for TotalMoney.
Money	getTotalTaxMoney() Getter for TotalTaxMoney.
String	getTreatmentType() Getter for TreatmentType.
String	getUid() Getter for Uid.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>>	internalGetAppliedTaxes() Internal Getter for AppliedTaxes.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCatalogObjectId() Internal Getter for CatalogObjectId.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetCatalogVersion() Internal Getter for CatalogVersion.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPercentage() Internal Getter for Percentage.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSourceServiceChargeUid() Internal Getter for SourceServiceChargeUid.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetTaxable() Internal Getter for Taxable.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUid() Internal Getter for Uid.
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,
                                String treatmentType,
                                String scope)

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.

treatmentType - String value for treatmentType.

scope - String value for scope.

OrderReturnServiceCharge

protected OrderReturnServiceCharge(io.apimatic.core.types.OptionalNullable<String> uid,
                                   io.apimatic.core.types.OptionalNullable<String> sourceServiceChargeUid,
                                   io.apimatic.core.types.OptionalNullable<String> name,
                                   io.apimatic.core.types.OptionalNullable<String> catalogObjectId,
                                   io.apimatic.core.types.OptionalNullable<Long> catalogVersion,
                                   io.apimatic.core.types.OptionalNullable<String> percentage,
                                   Money amountMoney,
                                   Money appliedMoney,
                                   Money totalMoney,
                                   Money totalTaxMoney,
                                   String calculationPhase,
                                   io.apimatic.core.types.OptionalNullable<Boolean> taxable,
                                   io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>> appliedTaxes,
                                   String treatmentType,
                                   String scope)

Internal initialization constructor.

Method Detail

internalGetUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()

Internal Getter for Uid. A unique ID that identifies the return service charge only within this order.

Returns:

Returns the Internal String

getUid

public String getUid()

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

Returns:

Returns the String

internalGetSourceServiceChargeUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetSourceServiceChargeUid()

Internal 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 Internal 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

internalGetName

protected io.apimatic.core.types.OptionalNullable<String> internalGetName()

Internal Getter for Name. The name of the service charge.

Returns:

Returns the Internal String

getName

public String getName()

Getter for Name. The name of the service charge.

Returns:

Returns the String

internalGetCatalogObjectId

protected io.apimatic.core.types.OptionalNullable<String> internalGetCatalogObjectId()

Internal Getter for CatalogObjectId. The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).

Returns:

Returns the Internal String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).

Returns:

Returns the String

internalGetCatalogVersion

protected io.apimatic.core.types.OptionalNullable<Long> internalGetCatalogVersion()

Internal Getter for CatalogVersion. The version of the catalog object that this service charge references.

Returns:

Returns the Internal Long

getCatalogVersion

public Long getCatalogVersion()

Getter for CatalogVersion. The version of the catalog object that this service charge references.

Returns:

Returns the Long

internalGetPercentage

protected io.apimatic.core.types.OptionalNullable<String> internalGetPercentage()

Internal 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 Internal String

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

internalGetTaxable

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetTaxable()

Internal 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 Internal Boolean

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

internalGetAppliedTaxes

protected io.apimatic.core.types.OptionalNullable<List<OrderLineItemAppliedTax>> internalGetAppliedTaxes()

Internal 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 Internal List of OrderLineItemAppliedTax

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

getTreatmentType

public String getTreatmentType()

Getter for TreatmentType. Indicates whether the service charge will be treated as a value-holding line item or apportioned toward a line item.

Returns:

Returns the String

getScope

public String getScope()

Getter for Scope. Indicates whether this is a line-item or order-level apportioned service charge.

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