com.squareup.square.models

Class V1PaymentSurcharge

java.lang.Object

com.squareup.square.models.V1PaymentSurcharge

public class V1PaymentSurcharge
extends Object

This is a model class for V1PaymentSurcharge type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
V1PaymentSurcharge(String name, V1Money appliedMoney, String rate, V1Money amountMoney, String type, Boolean taxable, List<V1PaymentTax> taxes, String surchargeId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
V1Money	getAmountMoney() Getter for AmountMoney.
V1Money	getAppliedMoney() Getter for AppliedMoney.
String	getName() Getter for Name.
String	getRate() Getter for Rate.
String	getSurchargeId() Getter for SurchargeId.
Boolean	getTaxable() Getter for Taxable.
List<V1PaymentTax>	getTaxes() Getter for Taxes.
String	getType() Getter for Type.
int	hashCode()
V1PaymentSurcharge.Builder	toBuilder() Builds a new V1PaymentSurcharge.Builder object.
String	toString() Converts this V1PaymentSurcharge into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

V1PaymentSurcharge

public V1PaymentSurcharge(String name,
                          V1Money appliedMoney,
                          String rate,
                          V1Money amountMoney,
                          String type,
                          Boolean taxable,
                          List<V1PaymentTax> taxes,
                          String surchargeId)

Initialization constructor.

Parameters:

name - String value for name.

appliedMoney - V1Money value for appliedMoney.

rate - String value for rate.

amountMoney - V1Money value for amountMoney.

type - String value for type.

taxable - Boolean value for taxable.

taxes - List of V1PaymentTax value for taxes.

surchargeId - String value for surchargeId.

Method Detail

getName

public String getName()

Getter for Name. The name of the surcharge.

Returns:

Returns the String

getAppliedMoney

public V1Money getAppliedMoney()

Getter for AppliedMoney.

Returns:

Returns the V1Money

getRate

public String getRate()

Getter for Rate. The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.

Returns:

Returns the String

getAmountMoney

public V1Money getAmountMoney()

Getter for AmountMoney.

Returns:

Returns the V1Money

getType

public String getType()

Getter for Type.

Returns:

Returns the String

getTaxable

public Boolean getTaxable()

Getter for Taxable. Indicates whether the surcharge is taxable.

Returns:

Returns the Boolean

getTaxes

public List<V1PaymentTax> getTaxes()

Getter for Taxes. The list of taxes that should be applied to the surcharge.

Returns:

Returns the List of V1PaymentTax

getSurchargeId

public String getSurchargeId()

Getter for SurchargeId. A Square-issued unique identifier associated with the surcharge.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public V1PaymentSurcharge.Builder toBuilder()

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

Returns:

a new V1PaymentSurcharge.Builder object