com.squareup.square.models

Class OrderLineItemTax

java.lang.Object

com.squareup.square.models.OrderLineItemTax

public class OrderLineItemTax
extends Object

This is a model class for OrderLineItemTax type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OrderLineItemTax(String uid, String catalogObjectId, Long catalogVersion, String name, String type, String percentage, Map<String,String> metadata, Money appliedMoney, String scope, Boolean autoApplied) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAppliedMoney() Getter for AppliedMoney.
Boolean	getAutoApplied() Getter for AutoApplied.
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.
String	getScope() Getter for Scope.
String	getType() Getter for Type.
String	getUid() Getter for Uid.
int	hashCode()
OrderLineItemTax.Builder	toBuilder() Builds a new OrderLineItemTax.Builder object.
String	toString() Converts this OrderLineItemTax into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderLineItemTax

public OrderLineItemTax(String uid,
                        String catalogObjectId,
                        Long catalogVersion,
                        String name,
                        String type,
                        String percentage,
                        Map<String,String> metadata,
                        Money appliedMoney,
                        String scope,
                        Boolean autoApplied)

Initialization constructor.

Parameters:

uid - String value for uid.

catalogObjectId - String value for catalogObjectId.

catalogVersion - Long value for catalogVersion.

name - String value for name.

type - String value for type.

percentage - String value for percentage.

metadata - Map of String, value for metadata.

appliedMoney - Money value for appliedMoney.

scope - String value for scope.

autoApplied - Boolean value for autoApplied.

Method Detail

getUid

public String getUid()

Getter for Uid. A unique ID that identifies the tax only within this order.

Returns:

Returns the String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The catalog object ID referencing [CatalogTax]($m/CatalogTax).

Returns:

Returns the String

getCatalogVersion

public Long getCatalogVersion()

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

Returns:

Returns the Long

getName

public String getName()

Getter for Name. The tax's name.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Indicates how the tax is applied to the associated line item or order.

Returns:

Returns the String

getPercentage

public String getPercentage()

Getter for Percentage. The percentage of the tax, as a string representation of a decimal number. For example, a value of `"7.25"` corresponds to a percentage of 7.25%.

Returns:

Returns the String

getMetadata

public Map<String,String> getMetadata()

Getter for Metadata. Application-defined data attached to this tax. 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

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

getScope

public String getScope()

Getter for Scope. Indicates whether this is a line-item or order-level tax.

Returns:

Returns the String

getAutoApplied

public Boolean getAutoApplied()

Getter for AutoApplied. Determines whether the tax was automatically applied to the order based on the catalog configuration. For an example, see [Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderLineItemTax.Builder toBuilder()

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

Returns:

a new OrderLineItemTax.Builder object