com.squareup.square.models

Class InvoiceRecipient

java.lang.Object

com.squareup.square.models.InvoiceRecipient

public class InvoiceRecipient
extends Object

This is a model class for InvoiceRecipient type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
InvoiceRecipient(String customerId, String givenName, String familyName, String emailAddress, Address address, String phoneNumber, String companyName, InvoiceRecipientTaxIds taxIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Address	getAddress() Getter for Address.
String	getCompanyName() Getter for CompanyName.
String	getCustomerId() Getter for CustomerId.
String	getEmailAddress() Getter for EmailAddress.
String	getFamilyName() Getter for FamilyName.
String	getGivenName() Getter for GivenName.
String	getPhoneNumber() Getter for PhoneNumber.
InvoiceRecipientTaxIds	getTaxIds() Getter for TaxIds.
int	hashCode()
InvoiceRecipient.Builder	toBuilder() Builds a new InvoiceRecipient.Builder object.
String	toString() Converts this InvoiceRecipient into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvoiceRecipient

public InvoiceRecipient(String customerId,
                        String givenName,
                        String familyName,
                        String emailAddress,
                        Address address,
                        String phoneNumber,
                        String companyName,
                        InvoiceRecipientTaxIds taxIds)

Initialization constructor.

Parameters:

customerId - String value for customerId.

givenName - String value for givenName.

familyName - String value for familyName.

emailAddress - String value for emailAddress.

address - Address value for address.

phoneNumber - String value for phoneNumber.

companyName - String value for companyName.

taxIds - InvoiceRecipientTaxIds value for taxIds.

Method Detail

getCustomerId

public String getCustomerId()

Getter for CustomerId. The ID of the customer. This is the customer profile ID that you provide when creating a draft invoice.

Returns:

Returns the String

getGivenName

public String getGivenName()

Getter for GivenName. The recipient's given (that is, first) name.

Returns:

Returns the String

getFamilyName

public String getFamilyName()

Getter for FamilyName. The recipient's family (that is, last) name.

Returns:

Returns the String

getEmailAddress

public String getEmailAddress()

Getter for EmailAddress. The recipient's email address.

Returns:

Returns the String

getAddress

public Address getAddress()

Getter for Address. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the Address

getPhoneNumber

public String getPhoneNumber()

Getter for PhoneNumber. The recipient's phone number.

Returns:

Returns the String

getCompanyName

public String getCompanyName()

Getter for CompanyName. The name of the recipient's company.

Returns:

Returns the String

getTaxIds

public InvoiceRecipientTaxIds getTaxIds()

Getter for TaxIds. Represents the tax IDs for an invoice recipient. The country of the seller account determines whether the corresponding `tax_ids` field is available for the customer. For more information, see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).

Returns:

Returns the InvoiceRecipientTaxIds

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public InvoiceRecipient.Builder toBuilder()

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

Returns:

a new InvoiceRecipient.Builder object