Package com.xero.models.accounting

Class Contact

java.lang.Object

com.xero.models.accounting.Contact

public class Contact
extends Object

Contact

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Contact.ContactStatusEnum	Current status of a contact – see contact status types
static enum	Contact.PurchasesDefaultLineAmountTypeEnum	The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
static enum	Contact.SalesDefaultLineAmountTypeEnum	The default sales line amount type for a contact.

Constructor Summary

Constructors

Constructor	Description
Contact()

Method Summary

Modifier and Type	Method	Description
Contact	accountNumber(String accountNumber)	A user defined account number.
Contact	accountsPayableTaxType(String accountsPayableTaxType)	The tax type from TaxRates
Contact	accountsReceivableTaxType(String accountsReceivableTaxType)	The tax type from TaxRates
Contact	addAddressesItem(Address addressesItem)	Store certain address types for a contact – see address types
Contact	addAttachmentsItem(Attachment attachmentsItem)	Displays array of attachments from the API
Contact	addContactGroupsItem(ContactGroup contactGroupsItem)	Displays which contact groups a contact is included in
Contact	addContactPersonsItem(ContactPerson contactPersonsItem)	See contact persons
Contact	addPhonesItem(Phone phonesItem)	Store certain phone types for a contact – see phone types
Contact	addPurchasesTrackingCategoriesItem(SalesTrackingCategory purchasesTrackingCategoriesItem)	The default purchases tracking categories for contacts
Contact	addresses(List<Address> addresses)	Store certain address types for a contact – see address types
Contact	addSalesTrackingCategoriesItem(SalesTrackingCategory salesTrackingCategoriesItem)	The default sales tracking categories for contacts
Contact	addValidationErrorsItem(ValidationError validationErrorsItem)	Displays validation errors returned from the API
Contact	attachments(List<Attachment> attachments)	Displays array of attachments from the API
Contact	balances(Balances balances)	balances
Contact	bankAccountDetails(String bankAccountDetails)	Bank account number of contact
Contact	batchPayments(BatchPaymentDetails batchPayments)	batchPayments
Contact	brandingTheme(BrandingTheme brandingTheme)	brandingTheme
Contact	companyNumber(String companyNumber)	Company registration number (max length = 50)
Contact	contactGroups(List<ContactGroup> contactGroups)	Displays which contact groups a contact is included in
Contact	contactID(UUID contactID)	Xero identifier
Contact	contactNumber(String contactNumber)	This can be updated via the API only i.e.
Contact	contactPersons(List<ContactPerson> contactPersons)	See contact persons
Contact	contactStatus(Contact.ContactStatusEnum contactStatus)	Current status of a contact – see contact status types
Contact	defaultCurrency(CurrencyCode defaultCurrency)	defaultCurrency
Contact	emailAddress(String emailAddress)	Email address of contact person (umlauts not supported) (max length = 255)
boolean	equals(Object o)
Contact	firstName(String firstName)	First name of contact person (max length = 255)
String	getAccountNumber()	A user defined account number.
String	getAccountsPayableTaxType()	The tax type from TaxRates
String	getAccountsReceivableTaxType()	The tax type from TaxRates
List<Address>	getAddresses()	Store certain address types for a contact – see address types
List<Attachment>	getAttachments()	Displays array of attachments from the API
Balances	getBalances()	Get balances
String	getBankAccountDetails()	Bank account number of contact
BatchPaymentDetails	getBatchPayments()	Get batchPayments
BrandingTheme	getBrandingTheme()	Get brandingTheme
String	getCompanyNumber()	Company registration number (max length = 50)
List<ContactGroup>	getContactGroups()	Displays which contact groups a contact is included in
UUID	getContactID()	Xero identifier
String	getContactNumber()	This can be updated via the API only i.e.
List<ContactPerson>	getContactPersons()	See contact persons
Contact.ContactStatusEnum	getContactStatus()	Current status of a contact – see contact status types
CurrencyCode	getDefaultCurrency()	Get defaultCurrency
Double	getDiscount()	The default discount rate for the contact (read only)
String	getEmailAddress()	Email address of contact person (umlauts not supported) (max length = 255)
String	getFirstName()	First name of contact person (max length = 255)
Boolean	getHasAttachments()	A boolean to indicate if a contact has an attachment
Boolean	getHasValidationErrors()	A boolean to indicate if a contact has an validation errors
Boolean	getIsCustomer()	true or false – Boolean that describes if a contact has any AR invoices entered against them.
Boolean	getIsSupplier()	true or false – Boolean that describes if a contact that has any AP invoices entered against them.
String	getLastName()	Last name of contact person (max length = 255)
UUID	getMergedToContactID()	ID for the destination of a merged contact.
String	getName()	Full name of contact/organisation (max length = 255)
PaymentTerm	getPaymentTerms()	Get paymentTerms
List<Phone>	getPhones()	Store certain phone types for a contact – see phone types
String	getPurchasesDefaultAccountCode()	The default purchases account code for contacts
Contact.PurchasesDefaultLineAmountTypeEnum	getPurchasesDefaultLineAmountType()	The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
List<SalesTrackingCategory>	getPurchasesTrackingCategories()	The default purchases tracking categories for contacts
String	getSalesDefaultAccountCode()	The default sales account code for contacts
Contact.SalesDefaultLineAmountTypeEnum	getSalesDefaultLineAmountType()	The default sales line amount type for a contact.
List<SalesTrackingCategory>	getSalesTrackingCategories()	The default sales tracking categories for contacts
String	getStatusAttributeString()	Status of object
String	getTaxNumber()	Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)
String	getTrackingCategoryName()	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
String	getTrackingCategoryOption()	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
String	getUpdatedDateUTC()	UTC timestamp of last update to contact
org.threeten.bp.OffsetDateTime	getUpdatedDateUTCAsDate()	UTC timestamp of last update to contact
List<ValidationError>	getValidationErrors()	Displays validation errors returned from the API
String	getWebsite()	Website address for contact (read only)
String	getXeroNetworkKey()	Store XeroNetworkKey for contacts.
Contact	hasAttachments(Boolean hasAttachments)	A boolean to indicate if a contact has an attachment
int	hashCode()
Contact	hasValidationErrors(Boolean hasValidationErrors)	A boolean to indicate if a contact has an validation errors
Contact	isCustomer(Boolean isCustomer)	true or false – Boolean that describes if a contact has any AR invoices entered against them.
Contact	isSupplier(Boolean isSupplier)	true or false – Boolean that describes if a contact that has any AP invoices entered against them.
Contact	lastName(String lastName)	Last name of contact person (max length = 255)
Contact	mergedToContactID(UUID mergedToContactID)	ID for the destination of a merged contact.
Contact	name(String name)	Full name of contact/organisation (max length = 255)
Contact	paymentTerms(PaymentTerm paymentTerms)	paymentTerms
Contact	phones(List<Phone> phones)	Store certain phone types for a contact – see phone types
Contact	purchasesDefaultAccountCode(String purchasesDefaultAccountCode)	The default purchases account code for contacts
Contact	purchasesDefaultLineAmountType(Contact.PurchasesDefaultLineAmountTypeEnum purchasesDefaultLineAmountType)	The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
Contact	purchasesTrackingCategories(List<SalesTrackingCategory> purchasesTrackingCategories)	The default purchases tracking categories for contacts
Contact	salesDefaultAccountCode(String salesDefaultAccountCode)	The default sales account code for contacts
Contact	salesDefaultLineAmountType(Contact.SalesDefaultLineAmountTypeEnum salesDefaultLineAmountType)	The default sales line amount type for a contact.
Contact	salesTrackingCategories(List<SalesTrackingCategory> salesTrackingCategories)	The default sales tracking categories for contacts
void	setAccountNumber(String accountNumber)	A user defined account number.
void	setAccountsPayableTaxType(String accountsPayableTaxType)	The tax type from TaxRates
void	setAccountsReceivableTaxType(String accountsReceivableTaxType)	The tax type from TaxRates
void	setAddresses(List<Address> addresses)	Store certain address types for a contact – see address types
void	setAttachments(List<Attachment> attachments)	Displays array of attachments from the API
void	setBalances(Balances balances)	balances
void	setBankAccountDetails(String bankAccountDetails)	Bank account number of contact
void	setBatchPayments(BatchPaymentDetails batchPayments)	batchPayments
void	setBrandingTheme(BrandingTheme brandingTheme)	brandingTheme
void	setCompanyNumber(String companyNumber)	Company registration number (max length = 50)
void	setContactGroups(List<ContactGroup> contactGroups)	Displays which contact groups a contact is included in
void	setContactID(UUID contactID)	Xero identifier
void	setContactNumber(String contactNumber)	This can be updated via the API only i.e.
void	setContactPersons(List<ContactPerson> contactPersons)	See contact persons
void	setContactStatus(Contact.ContactStatusEnum contactStatus)	Current status of a contact – see contact status types
void	setDefaultCurrency(CurrencyCode defaultCurrency)	defaultCurrency
void	setEmailAddress(String emailAddress)	Email address of contact person (umlauts not supported) (max length = 255)
void	setFirstName(String firstName)	First name of contact person (max length = 255)
void	setHasAttachments(Boolean hasAttachments)	A boolean to indicate if a contact has an attachment
void	setHasValidationErrors(Boolean hasValidationErrors)	A boolean to indicate if a contact has an validation errors
void	setIsCustomer(Boolean isCustomer)	true or false – Boolean that describes if a contact has any AR invoices entered against them.
void	setIsSupplier(Boolean isSupplier)	true or false – Boolean that describes if a contact that has any AP invoices entered against them.
void	setLastName(String lastName)	Last name of contact person (max length = 255)
void	setMergedToContactID(UUID mergedToContactID)	ID for the destination of a merged contact.
void	setName(String name)	Full name of contact/organisation (max length = 255)
void	setPaymentTerms(PaymentTerm paymentTerms)	paymentTerms
void	setPhones(List<Phone> phones)	Store certain phone types for a contact – see phone types
void	setPurchasesDefaultAccountCode(String purchasesDefaultAccountCode)	The default purchases account code for contacts
void	setPurchasesDefaultLineAmountType(Contact.PurchasesDefaultLineAmountTypeEnum purchasesDefaultLineAmountType)	The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
void	setPurchasesTrackingCategories(List<SalesTrackingCategory> purchasesTrackingCategories)	The default purchases tracking categories for contacts
void	setSalesDefaultAccountCode(String salesDefaultAccountCode)	The default sales account code for contacts
void	setSalesDefaultLineAmountType(Contact.SalesDefaultLineAmountTypeEnum salesDefaultLineAmountType)	The default sales line amount type for a contact.
void	setSalesTrackingCategories(List<SalesTrackingCategory> salesTrackingCategories)	The default sales tracking categories for contacts
void	setStatusAttributeString(String statusAttributeString)	Status of object
void	setTaxNumber(String taxNumber)	Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)
void	setTrackingCategoryName(String trackingCategoryName)	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
void	setTrackingCategoryOption(String trackingCategoryOption)	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
void	setValidationErrors(List<ValidationError> validationErrors)	Displays validation errors returned from the API
void	setXeroNetworkKey(String xeroNetworkKey)	Store XeroNetworkKey for contacts.
Contact	statusAttributeString(String statusAttributeString)	Status of object
Contact	taxNumber(String taxNumber)	Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)
String	toString()
Contact	trackingCategoryName(String trackingCategoryName)	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
Contact	trackingCategoryOption(String trackingCategoryOption)	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
Contact	validationErrors(List<ValidationError> validationErrors)	Displays validation errors returned from the API
Contact	xeroNetworkKey(String xeroNetworkKey)	Store XeroNetworkKey for contacts.

Methods inherited from class java.lang.Object

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

Constructor Details

Contact

public Contact()

Method Details

contactID

public Contact contactID(UUID contactID)

Xero identifier

Parameters:

contactID - UUID

Returns:

Contact

getContactID

public UUID getContactID()

Xero identifier

Returns:

contactID

setContactID

public void setContactID(UUID contactID)

Xero identifier

Parameters:

contactID - UUID

mergedToContactID

public Contact mergedToContactID(UUID mergedToContactID)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Parameters:

mergedToContactID - UUID

Returns:

Contact

getMergedToContactID

public UUID getMergedToContactID()

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Returns:

mergedToContactID

setMergedToContactID

public void setMergedToContactID(UUID mergedToContactID)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Parameters:

mergedToContactID - UUID

contactNumber

public Contact contactNumber(String contactNumber)

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

Parameters:

contactNumber - String

Returns:

Contact

getContactNumber

public String getContactNumber()

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

Returns:

contactNumber

setContactNumber

public void setContactNumber(String contactNumber)

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

Parameters:

contactNumber - String

accountNumber

public Contact accountNumber(String accountNumber)

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

Parameters:

accountNumber - String

Returns:

Contact

getAccountNumber

public String getAccountNumber()

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

Returns:

accountNumber

setAccountNumber

public void setAccountNumber(String accountNumber)

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

Parameters:

accountNumber - String

contactStatus

public Contact contactStatus(Contact.ContactStatusEnum contactStatus)

Current status of a contact – see contact status types

Parameters:

contactStatus - ContactStatusEnum

Returns:

Contact

getContactStatus

public Contact.ContactStatusEnum getContactStatus()

Current status of a contact – see contact status types

Returns:

contactStatus

setContactStatus

public void setContactStatus(Contact.ContactStatusEnum contactStatus)

Current status of a contact – see contact status types

Parameters:

contactStatus - ContactStatusEnum

name

public Contact name(String name)

Full name of contact/organisation (max length = 255)

Parameters:

name - String

Returns:

Contact

getName

public String getName()

Full name of contact/organisation (max length = 255)

Returns:

name

setName

public void setName(String name)

Full name of contact/organisation (max length = 255)

Parameters:

name - String

firstName

public Contact firstName(String firstName)

First name of contact person (max length = 255)

Parameters:

firstName - String

Returns:

Contact

getFirstName

public String getFirstName()

First name of contact person (max length = 255)

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

First name of contact person (max length = 255)

Parameters:

firstName - String

lastName

public Contact lastName(String lastName)

Last name of contact person (max length = 255)

Parameters:

lastName - String

Returns:

Contact

getLastName

public String getLastName()

Last name of contact person (max length = 255)

Returns:

lastName

setLastName

public void setLastName(String lastName)

Last name of contact person (max length = 255)

Parameters:

lastName - String

companyNumber

public Contact companyNumber(String companyNumber)

Company registration number (max length = 50)

Parameters:

companyNumber - String

Returns:

Contact

getCompanyNumber

public String getCompanyNumber()

Company registration number (max length = 50)

Returns:

companyNumber

setCompanyNumber

public void setCompanyNumber(String companyNumber)

Company registration number (max length = 50)

Parameters:

companyNumber - String

emailAddress

public Contact emailAddress(String emailAddress)

Email address of contact person (umlauts not supported) (max length = 255)

Parameters:

emailAddress - String

Returns:

Contact

getEmailAddress

public String getEmailAddress()

Email address of contact person (umlauts not supported) (max length = 255)

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(String emailAddress)

Email address of contact person (umlauts not supported) (max length = 255)

Parameters:

emailAddress - String

contactPersons

public Contact contactPersons(List<ContactPerson> contactPersons)

See contact persons

Parameters:

contactPersons - List<ContactPerson>

Returns:

Contact

addContactPersonsItem

public Contact addContactPersonsItem(ContactPerson contactPersonsItem)

See contact persons

Parameters:

contactPersonsItem - ContactPerson

Returns:

Contact

getContactPersons

public List<ContactPerson> getContactPersons()

See contact persons

Returns:

contactPersons

setContactPersons

public void setContactPersons(List<ContactPerson> contactPersons)

See contact persons

Parameters:

contactPersons - List<ContactPerson>

bankAccountDetails

public Contact bankAccountDetails(String bankAccountDetails)

Bank account number of contact

Parameters:

bankAccountDetails - String

Returns:

Contact

getBankAccountDetails

public String getBankAccountDetails()

Bank account number of contact

Returns:

bankAccountDetails

setBankAccountDetails

public void setBankAccountDetails(String bankAccountDetails)

Bank account number of contact

Parameters:

bankAccountDetails - String

taxNumber

public Contact taxNumber(String taxNumber)

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

Parameters:

taxNumber - String

Returns:

Contact

getTaxNumber

public String getTaxNumber()

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

Returns:

taxNumber

setTaxNumber

public void setTaxNumber(String taxNumber)

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

Parameters:

taxNumber - String

accountsReceivableTaxType

public Contact accountsReceivableTaxType(String accountsReceivableTaxType)

The tax type from TaxRates

Parameters:

accountsReceivableTaxType - String

Returns:

Contact

getAccountsReceivableTaxType

public String getAccountsReceivableTaxType()

The tax type from TaxRates

Returns:

accountsReceivableTaxType

setAccountsReceivableTaxType

public void setAccountsReceivableTaxType(String accountsReceivableTaxType)

The tax type from TaxRates

Parameters:

accountsReceivableTaxType - String

accountsPayableTaxType

public Contact accountsPayableTaxType(String accountsPayableTaxType)

The tax type from TaxRates

Parameters:

accountsPayableTaxType - String

Returns:

Contact

getAccountsPayableTaxType

public String getAccountsPayableTaxType()

The tax type from TaxRates

Returns:

accountsPayableTaxType

setAccountsPayableTaxType

public void setAccountsPayableTaxType(String accountsPayableTaxType)

The tax type from TaxRates

Parameters:

accountsPayableTaxType - String

addresses

public Contact addresses(List<Address> addresses)

Store certain address types for a contact – see address types

Parameters:

addresses - List<Address>

Returns:

Contact

addAddressesItem

public Contact addAddressesItem(Address addressesItem)

Store certain address types for a contact – see address types

Parameters:

addressesItem - Address

Returns:

Contact

getAddresses

public List<Address> getAddresses()

Store certain address types for a contact – see address types

Returns:

addresses

setAddresses

public void setAddresses(List<Address> addresses)

Store certain address types for a contact – see address types

Parameters:

addresses - List<Address>

phones

public Contact phones(List<Phone> phones)

Store certain phone types for a contact – see phone types

Parameters:

phones - List<Phone>

Returns:

Contact

addPhonesItem

public Contact addPhonesItem(Phone phonesItem)

Store certain phone types for a contact – see phone types

Parameters:

phonesItem - Phone

Returns:

Contact

getPhones

public List<Phone> getPhones()

Store certain phone types for a contact – see phone types

Returns:

phones

setPhones

public void setPhones(List<Phone> phones)

Store certain phone types for a contact – see phone types

Parameters:

phones - List<Phone>

isSupplier

public Contact isSupplier(Boolean isSupplier)

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

Parameters:

isSupplier - Boolean

Returns:

Contact

getIsSupplier

public Boolean getIsSupplier()

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

Returns:

isSupplier

setIsSupplier

public void setIsSupplier(Boolean isSupplier)

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

Parameters:

isSupplier - Boolean

isCustomer

public Contact isCustomer(Boolean isCustomer)

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

Parameters:

isCustomer - Boolean

Returns:

Contact

getIsCustomer

public Boolean getIsCustomer()

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

Returns:

isCustomer

setIsCustomer

public void setIsCustomer(Boolean isCustomer)

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

Parameters:

isCustomer - Boolean

salesDefaultLineAmountType

public Contact salesDefaultLineAmountType(Contact.SalesDefaultLineAmountTypeEnum salesDefaultLineAmountType)

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Parameters:

salesDefaultLineAmountType - SalesDefaultLineAmountTypeEnum

Returns:

Contact

getSalesDefaultLineAmountType

public Contact.SalesDefaultLineAmountTypeEnum getSalesDefaultLineAmountType()

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Returns:

salesDefaultLineAmountType

setSalesDefaultLineAmountType

public void setSalesDefaultLineAmountType(Contact.SalesDefaultLineAmountTypeEnum salesDefaultLineAmountType)

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Parameters:

salesDefaultLineAmountType - SalesDefaultLineAmountTypeEnum

purchasesDefaultLineAmountType

public Contact purchasesDefaultLineAmountType(Contact.PurchasesDefaultLineAmountTypeEnum purchasesDefaultLineAmountType)

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Parameters:

purchasesDefaultLineAmountType - PurchasesDefaultLineAmountTypeEnum

Returns:

Contact

getPurchasesDefaultLineAmountType

public Contact.PurchasesDefaultLineAmountTypeEnum getPurchasesDefaultLineAmountType()

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Returns:

purchasesDefaultLineAmountType

setPurchasesDefaultLineAmountType

public void setPurchasesDefaultLineAmountType(Contact.PurchasesDefaultLineAmountTypeEnum purchasesDefaultLineAmountType)

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Parameters:

purchasesDefaultLineAmountType - PurchasesDefaultLineAmountTypeEnum

defaultCurrency

public Contact defaultCurrency(CurrencyCode defaultCurrency)

defaultCurrency

Parameters:

defaultCurrency - CurrencyCode

Returns:

Contact

getDefaultCurrency

public CurrencyCode getDefaultCurrency()

Get defaultCurrency

Returns:

defaultCurrency

setDefaultCurrency

public void setDefaultCurrency(CurrencyCode defaultCurrency)

defaultCurrency

Parameters:

defaultCurrency - CurrencyCode

xeroNetworkKey

public Contact xeroNetworkKey(String xeroNetworkKey)

Store XeroNetworkKey for contacts.

Parameters:

xeroNetworkKey - String

Returns:

Contact

getXeroNetworkKey

public String getXeroNetworkKey()

Store XeroNetworkKey for contacts.

Returns:

xeroNetworkKey

setXeroNetworkKey

public void setXeroNetworkKey(String xeroNetworkKey)

Store XeroNetworkKey for contacts.

Parameters:

xeroNetworkKey - String

salesDefaultAccountCode

public Contact salesDefaultAccountCode(String salesDefaultAccountCode)

The default sales account code for contacts

Parameters:

salesDefaultAccountCode - String

Returns:

Contact

getSalesDefaultAccountCode

public String getSalesDefaultAccountCode()

The default sales account code for contacts

Returns:

salesDefaultAccountCode

setSalesDefaultAccountCode

public void setSalesDefaultAccountCode(String salesDefaultAccountCode)

The default sales account code for contacts

Parameters:

salesDefaultAccountCode - String

purchasesDefaultAccountCode

public Contact purchasesDefaultAccountCode(String purchasesDefaultAccountCode)

The default purchases account code for contacts

Parameters:

purchasesDefaultAccountCode - String

Returns:

Contact

getPurchasesDefaultAccountCode

public String getPurchasesDefaultAccountCode()

The default purchases account code for contacts

Returns:

purchasesDefaultAccountCode

setPurchasesDefaultAccountCode

public void setPurchasesDefaultAccountCode(String purchasesDefaultAccountCode)

The default purchases account code for contacts

Parameters:

purchasesDefaultAccountCode - String

salesTrackingCategories

public Contact salesTrackingCategories(List<SalesTrackingCategory> salesTrackingCategories)

The default sales tracking categories for contacts

Parameters:

salesTrackingCategories - List<SalesTrackingCategory>

Returns:

Contact

addSalesTrackingCategoriesItem

public Contact addSalesTrackingCategoriesItem(SalesTrackingCategory salesTrackingCategoriesItem)

The default sales tracking categories for contacts

Parameters:

salesTrackingCategoriesItem - SalesTrackingCategory

Returns:

Contact

getSalesTrackingCategories

public List<SalesTrackingCategory> getSalesTrackingCategories()

The default sales tracking categories for contacts

Returns:

salesTrackingCategories

setSalesTrackingCategories

public void setSalesTrackingCategories(List<SalesTrackingCategory> salesTrackingCategories)

The default sales tracking categories for contacts

Parameters:

salesTrackingCategories - List<SalesTrackingCategory>

purchasesTrackingCategories

public Contact purchasesTrackingCategories(List<SalesTrackingCategory> purchasesTrackingCategories)

The default purchases tracking categories for contacts

Parameters:

purchasesTrackingCategories - List<SalesTrackingCategory>

Returns:

Contact

addPurchasesTrackingCategoriesItem

public Contact addPurchasesTrackingCategoriesItem(SalesTrackingCategory purchasesTrackingCategoriesItem)

The default purchases tracking categories for contacts

Parameters:

purchasesTrackingCategoriesItem - SalesTrackingCategory

Returns:

Contact

getPurchasesTrackingCategories

public List<SalesTrackingCategory> getPurchasesTrackingCategories()

The default purchases tracking categories for contacts

Returns:

purchasesTrackingCategories

setPurchasesTrackingCategories

public void setPurchasesTrackingCategories(List<SalesTrackingCategory> purchasesTrackingCategories)

The default purchases tracking categories for contacts

Parameters:

purchasesTrackingCategories - List<SalesTrackingCategory>

trackingCategoryName

public Contact trackingCategoryName(String trackingCategoryName)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Parameters:

trackingCategoryName - String

Returns:

Contact

getTrackingCategoryName

public String getTrackingCategoryName()

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Returns:

trackingCategoryName

setTrackingCategoryName

public void setTrackingCategoryName(String trackingCategoryName)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Parameters:

trackingCategoryName - String

trackingCategoryOption

public Contact trackingCategoryOption(String trackingCategoryOption)

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Parameters:

trackingCategoryOption - String

Returns:

Contact

getTrackingCategoryOption

public String getTrackingCategoryOption()

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Returns:

trackingCategoryOption

setTrackingCategoryOption

public void setTrackingCategoryOption(String trackingCategoryOption)

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Parameters:

trackingCategoryOption - String

paymentTerms

public Contact paymentTerms(PaymentTerm paymentTerms)

paymentTerms

Parameters:

paymentTerms - PaymentTerm

Returns:

Contact

getPaymentTerms

public PaymentTerm getPaymentTerms()

Get paymentTerms

Returns:

paymentTerms

setPaymentTerms

public void setPaymentTerms(PaymentTerm paymentTerms)

paymentTerms

Parameters:

paymentTerms - PaymentTerm

getUpdatedDateUTC

public String getUpdatedDateUTC()

UTC timestamp of last update to contact

Returns:

updatedDateUTC

getUpdatedDateUTCAsDate

public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

UTC timestamp of last update to contact

Returns:

OffsetDateTime

contactGroups

public Contact contactGroups(List<ContactGroup> contactGroups)

Displays which contact groups a contact is included in

Parameters:

contactGroups - List<ContactGroup>

Returns:

Contact

addContactGroupsItem

public Contact addContactGroupsItem(ContactGroup contactGroupsItem)

Displays which contact groups a contact is included in

Parameters:

contactGroupsItem - ContactGroup

Returns:

Contact

getContactGroups

public List<ContactGroup> getContactGroups()

Displays which contact groups a contact is included in

Returns:

contactGroups

setContactGroups

public void setContactGroups(List<ContactGroup> contactGroups)

Displays which contact groups a contact is included in

Parameters:

contactGroups - List<ContactGroup>

getWebsite

public String getWebsite()

Website address for contact (read only)

Returns:

website

brandingTheme

public Contact brandingTheme(BrandingTheme brandingTheme)

brandingTheme

Parameters:

brandingTheme - BrandingTheme

Returns:

Contact

getBrandingTheme

public BrandingTheme getBrandingTheme()

Get brandingTheme

Returns:

brandingTheme

setBrandingTheme

public void setBrandingTheme(BrandingTheme brandingTheme)

brandingTheme

Parameters:

brandingTheme - BrandingTheme

batchPayments

public Contact batchPayments(BatchPaymentDetails batchPayments)

batchPayments

Parameters:

batchPayments - BatchPaymentDetails

Returns:

Contact

getBatchPayments

public BatchPaymentDetails getBatchPayments()

Get batchPayments

Returns:

batchPayments

setBatchPayments

public void setBatchPayments(BatchPaymentDetails batchPayments)

batchPayments

Parameters:

batchPayments - BatchPaymentDetails

getDiscount

public Double getDiscount()

The default discount rate for the contact (read only)

Returns:

discount

balances

public Contact balances(Balances balances)

balances

Parameters:

balances - Balances

Returns:

Contact

getBalances

public Balances getBalances()

Get balances

Returns:

balances

setBalances

public void setBalances(Balances balances)

balances

Parameters:

balances - Balances

attachments

public Contact attachments(List<Attachment> attachments)

Displays array of attachments from the API

Parameters:

attachments - List<Attachment>

Returns:

Contact

addAttachmentsItem

public Contact addAttachmentsItem(Attachment attachmentsItem)

Displays array of attachments from the API

Parameters:

attachmentsItem - Attachment

Returns:

Contact

getAttachments

public List<Attachment> getAttachments()

Displays array of attachments from the API

Returns:

attachments

setAttachments

public void setAttachments(List<Attachment> attachments)

Displays array of attachments from the API

Parameters:

attachments - List<Attachment>

hasAttachments

public Contact hasAttachments(Boolean hasAttachments)

A boolean to indicate if a contact has an attachment

Parameters:

hasAttachments - Boolean

Returns:

Contact

getHasAttachments

public Boolean getHasAttachments()

A boolean to indicate if a contact has an attachment

Returns:

hasAttachments

setHasAttachments

public void setHasAttachments(Boolean hasAttachments)

A boolean to indicate if a contact has an attachment

Parameters:

hasAttachments - Boolean

validationErrors

public Contact validationErrors(List<ValidationError> validationErrors)

Displays validation errors returned from the API

Parameters:

validationErrors - List<ValidationError>

Returns:

Contact

addValidationErrorsItem

public Contact addValidationErrorsItem(ValidationError validationErrorsItem)

Displays validation errors returned from the API

Parameters:

validationErrorsItem - ValidationError

Returns:

Contact

getValidationErrors

public List<ValidationError> getValidationErrors()

Displays validation errors returned from the API

Returns:

validationErrors

setValidationErrors

public void setValidationErrors(List<ValidationError> validationErrors)

Displays validation errors returned from the API

Parameters:

validationErrors - List<ValidationError>

hasValidationErrors

public Contact hasValidationErrors(Boolean hasValidationErrors)

A boolean to indicate if a contact has an validation errors

Parameters:

hasValidationErrors - Boolean

Returns:

Contact

getHasValidationErrors

public Boolean getHasValidationErrors()

A boolean to indicate if a contact has an validation errors

Returns:

hasValidationErrors

setHasValidationErrors

public void setHasValidationErrors(Boolean hasValidationErrors)

A boolean to indicate if a contact has an validation errors

Parameters:

hasValidationErrors - Boolean

statusAttributeString

public Contact statusAttributeString(String statusAttributeString)

Status of object

Parameters:

statusAttributeString - String

Returns:

Contact

getStatusAttributeString

public String getStatusAttributeString()

Status of object

Returns:

statusAttributeString

setStatusAttributeString

public void setStatusAttributeString(String statusAttributeString)

Status of object

Parameters:

statusAttributeString - String

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object