com.squareup.square.models

Class AdditionalRecipient

java.lang.Object

com.squareup.square.models.AdditionalRecipient

public class AdditionalRecipient
extends Object

This is a model class for AdditionalRecipient type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AdditionalRecipient(String locationId, Money amountMoney, String description, String receivableId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
String	getDescription() Getter for Description.
String	getLocationId() Getter for LocationId.
String	getReceivableId() Getter for ReceivableId.
int	hashCode()
AdditionalRecipient.Builder	toBuilder() Builds a new AdditionalRecipient.Builder object.
String	toString() Converts this AdditionalRecipient into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalRecipient

public AdditionalRecipient(String locationId,
                           Money amountMoney,
                           String description,
                           String receivableId)

Initialization constructor.

Parameters:

locationId - String value for locationId.

amountMoney - Money value for amountMoney.

description - String value for description.

receivableId - String value for receivableId.

Method Detail

getLocationId

public String getLocationId()

Getter for LocationId. The location ID for a recipient (other than the merchant) receiving a portion of this tender.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. The description of the additional recipient.

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

getReceivableId

public String getReceivableId()

Getter for ReceivableId. The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public AdditionalRecipient.Builder toBuilder()

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

Returns:

a new AdditionalRecipient.Builder object