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

Modifier	Constructor and Description
protected	CatalogTax(io.apimatic.core.types.OptionalNullable<String> name, String calculationPhase, String inclusionType, io.apimatic.core.types.OptionalNullable<String> percentage, io.apimatic.core.types.OptionalNullable<Boolean> appliesToCustomAmounts, io.apimatic.core.types.OptionalNullable<Boolean> enabled, io.apimatic.core.types.OptionalNullable<String> appliesToProductSetId) Internal initialization constructor.
	CatalogTax(String name, String calculationPhase, String inclusionType, String percentage, Boolean appliesToCustomAmounts, Boolean enabled, String appliesToProductSetId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAppliesToCustomAmounts() Getter for AppliesToCustomAmounts.
String	getAppliesToProductSetId() Getter for AppliesToProductSetId.
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()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAppliesToCustomAmounts() Internal Getter for AppliesToCustomAmounts.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetAppliesToProductSetId() Internal Getter for AppliesToProductSetId.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetEnabled() Internal Getter for Enabled.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPercentage() Internal Getter for Percentage.
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,
                  String appliesToProductSetId)

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.

appliesToProductSetId - String value for appliesToProductSetId.

CatalogTax

protected CatalogTax(io.apimatic.core.types.OptionalNullable<String> name,
                     String calculationPhase,
                     String inclusionType,
                     io.apimatic.core.types.OptionalNullable<String> percentage,
                     io.apimatic.core.types.OptionalNullable<Boolean> appliesToCustomAmounts,
                     io.apimatic.core.types.OptionalNullable<Boolean> enabled,
                     io.apimatic.core.types.OptionalNullable<String> appliesToProductSetId)

Internal initialization constructor.

Method Detail

internalGetName

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

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

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

internalGetPercentage

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

Internal 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%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.

Returns:

Returns the Internal 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%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.

Returns:

Returns the String

internalGetAppliesToCustomAmounts

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

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

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

internalGetEnabled

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

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

internalGetAppliesToProductSetId

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

Internal Getter for AppliesToProductSetId. The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set.

Returns:

Returns the Internal String

getAppliesToProductSetId

public String getAppliesToProductSetId()

Getter for AppliesToProductSetId. The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set.

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