com.squareup.square.models

Class CatalogTax

java.lang.Object

com.squareup.square.models.CatalogTax

public class CatalogTax
extends Object

This is a model class for CatalogTax type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogTax(String name, String calculationPhase, String inclusionType, String percentage, Boolean appliesToCustomAmounts, Boolean enabled) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAppliesToCustomAmounts() Getter for AppliesToCustomAmounts.
String	getCalculationPhase() Getter for CalculationPhase.
Boolean	getEnabled() Getter for Enabled.
String	getInclusionType() Getter for InclusionType.
String	getName() Getter for Name.
String	getPercentage() Getter for Percentage.
int	hashCode()
CatalogTax.Builder	toBuilder() Builds a new CatalogTax.Builder object.
String	toString() Converts this CatalogTax into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogTax

public CatalogTax(String name,
                  String calculationPhase,
                  String inclusionType,
                  String percentage,
                  Boolean appliesToCustomAmounts,
                  Boolean enabled)

Initialization constructor.

Parameters:

name - String value for name.

calculationPhase - String value for calculationPhase.

inclusionType - String value for inclusionType.

percentage - String value for percentage.

appliesToCustomAmounts - Boolean value for appliesToCustomAmounts.

enabled - Boolean value for enabled.

Method Detail

getName

public String getName()

Getter for Name. The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Returns:

Returns the String

getCalculationPhase

public String getCalculationPhase()

Getter for CalculationPhase. When to calculate the taxes due on a cart.

Returns:

Returns the String

getInclusionType

public String getInclusionType()

Getter for InclusionType. Whether to the tax amount should be additional to or included in the CatalogItem price.

Returns:

Returns the String

getPercentage

public String getPercentage()

Getter for Percentage. The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%.

Returns:

Returns the String

getAppliesToCustomAmounts

public Boolean getAppliesToCustomAmounts()

Getter for AppliesToCustomAmounts. If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`.

Returns:

Returns the Boolean

getEnabled

public Boolean getEnabled()

Getter for Enabled. A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`).

Returns:

Returns the Boolean

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 CatalogTax into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogTax.Builder toBuilder()

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

Returns:

a new CatalogTax.Builder object