Package com.xero.models.accounting
Class Contact
java.lang.Object
com.xero.models.accounting.Contact
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumCurrent status of a contact – see contact status typesstatic enumThe 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 enumThe default sales line amount type for a contact. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccountNumber(String accountNumber) A user defined account number.accountsPayableTaxType(String accountsPayableTaxType) The tax type from TaxRatesaccountsReceivableTaxType(String accountsReceivableTaxType) The tax type from TaxRatesaddAddressesItem(Address addressesItem) Store certain address types for a contact – see address typesaddAttachmentsItem(Attachment attachmentsItem) Displays array of attachments from the APIaddContactGroupsItem(ContactGroup contactGroupsItem) Displays which contact groups a contact is included inaddContactPersonsItem(ContactPerson contactPersonsItem) See contact personsaddPhonesItem(Phone phonesItem) Store certain phone types for a contact – see phone typesaddPurchasesTrackingCategoriesItem(SalesTrackingCategory purchasesTrackingCategoriesItem) The default purchases tracking categories for contactsStore certain address types for a contact – see address typesaddSalesTrackingCategoriesItem(SalesTrackingCategory salesTrackingCategoriesItem) The default sales tracking categories for contactsaddValidationErrorsItem(ValidationError validationErrorsItem) Displays validation errors returned from the APIattachments(List<Attachment> attachments) Displays array of attachments from the APIbalancesbankAccountDetails(String bankAccountDetails) Bank account number of contactbatchPayments(BatchPaymentDetails batchPayments) batchPaymentsbrandingTheme(BrandingTheme brandingTheme) brandingThemecompanyNumber(String companyNumber) Company registration number (max length = 50)contactGroups(List<ContactGroup> contactGroups) Displays which contact groups a contact is included inXero identifiercontactNumber(String contactNumber) This can be updated via the API only i.e.contactPersons(List<ContactPerson> contactPersons) See contact personscontactStatus(Contact.ContactStatusEnum contactStatus) Current status of a contact – see contact status typesdefaultCurrency(CurrencyCode defaultCurrency) defaultCurrencyemailAddress(String emailAddress) Email address of contact person (umlauts not supported) (max length = 255)booleanFirst name of contact person (max length = 255)A user defined account number.The tax type from TaxRatesThe tax type from TaxRatesStore certain address types for a contact – see address typesDisplays array of attachments from the APIGet balancesBank account number of contactGet batchPaymentsGet brandingThemeCompany registration number (max length = 50)Displays which contact groups a contact is included inXero identifierThis can be updated via the API only i.e.See contact personsCurrent status of a contact – see contact status typesGet defaultCurrencyThe default discount rate for the contact (read only)Email address of contact person (umlauts not supported) (max length = 255)First name of contact person (max length = 255)A boolean to indicate if a contact has an attachmentA boolean to indicate if a contact has an validation errorstrue or false – Boolean that describes if a contact has any AR invoices entered against them.true or false – Boolean that describes if a contact that has any AP invoices entered against them.Last name of contact person (max length = 255)ID for the destination of a merged contact.getName()Full name of contact/organisation (max length = 255)Get paymentTermsStore certain phone types for a contact – see phone typesThe default purchases account code for contactsThe default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.The default purchases tracking categories for contactsThe default sales account code for contactsThe default sales line amount type for a contact.The default sales tracking categories for contactsStatus of objectTax 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)The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategoriesThe name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategoriesUTC timestamp of last update to contactorg.threeten.bp.OffsetDateTimeUTC timestamp of last update to contactDisplays validation errors returned from the APIWebsite address for contact (read only)Store XeroNetworkKey for contacts.hasAttachments(Boolean hasAttachments) A boolean to indicate if a contact has an attachmentinthashCode()hasValidationErrors(Boolean hasValidationErrors) A boolean to indicate if a contact has an validation errorsisCustomer(Boolean isCustomer) true or false – Boolean that describes if a contact has any AR invoices entered against them.isSupplier(Boolean isSupplier) true or false – Boolean that describes if a contact that has any AP invoices entered against them.Last name of contact person (max length = 255)mergedToContactID(UUID mergedToContactID) ID for the destination of a merged contact.Full name of contact/organisation (max length = 255)paymentTerms(PaymentTerm paymentTerms) paymentTermsStore certain phone types for a contact – see phone typespurchasesDefaultAccountCode(String purchasesDefaultAccountCode) The default purchases account code for contactspurchasesDefaultLineAmountType(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.purchasesTrackingCategories(List<SalesTrackingCategory> purchasesTrackingCategories) The default purchases tracking categories for contactssalesDefaultAccountCode(String salesDefaultAccountCode) The default sales account code for contactssalesDefaultLineAmountType(Contact.SalesDefaultLineAmountTypeEnum salesDefaultLineAmountType) The default sales line amount type for a contact.salesTrackingCategories(List<SalesTrackingCategory> salesTrackingCategories) The default sales tracking categories for contactsvoidsetAccountNumber(String accountNumber) A user defined account number.voidsetAccountsPayableTaxType(String accountsPayableTaxType) The tax type from TaxRatesvoidsetAccountsReceivableTaxType(String accountsReceivableTaxType) The tax type from TaxRatesvoidsetAddresses(List<Address> addresses) Store certain address types for a contact – see address typesvoidsetAttachments(List<Attachment> attachments) Displays array of attachments from the APIvoidsetBalances(Balances balances) balancesvoidsetBankAccountDetails(String bankAccountDetails) Bank account number of contactvoidsetBatchPayments(BatchPaymentDetails batchPayments) batchPaymentsvoidsetBrandingTheme(BrandingTheme brandingTheme) brandingThemevoidsetCompanyNumber(String companyNumber) Company registration number (max length = 50)voidsetContactGroups(List<ContactGroup> contactGroups) Displays which contact groups a contact is included invoidsetContactID(UUID contactID) Xero identifiervoidsetContactNumber(String contactNumber) This can be updated via the API only i.e.voidsetContactPersons(List<ContactPerson> contactPersons) See contact personsvoidsetContactStatus(Contact.ContactStatusEnum contactStatus) Current status of a contact – see contact status typesvoidsetDefaultCurrency(CurrencyCode defaultCurrency) defaultCurrencyvoidsetEmailAddress(String emailAddress) Email address of contact person (umlauts not supported) (max length = 255)voidsetFirstName(String firstName) First name of contact person (max length = 255)voidsetHasAttachments(Boolean hasAttachments) A boolean to indicate if a contact has an attachmentvoidsetHasValidationErrors(Boolean hasValidationErrors) A boolean to indicate if a contact has an validation errorsvoidsetIsCustomer(Boolean isCustomer) true or false – Boolean that describes if a contact has any AR invoices entered against them.voidsetIsSupplier(Boolean isSupplier) true or false – Boolean that describes if a contact that has any AP invoices entered against them.voidsetLastName(String lastName) Last name of contact person (max length = 255)voidsetMergedToContactID(UUID mergedToContactID) ID for the destination of a merged contact.voidFull name of contact/organisation (max length = 255)voidsetPaymentTerms(PaymentTerm paymentTerms) paymentTermsvoidStore certain phone types for a contact – see phone typesvoidsetPurchasesDefaultAccountCode(String purchasesDefaultAccountCode) The default purchases account code for contactsvoidsetPurchasesDefaultLineAmountType(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.voidsetPurchasesTrackingCategories(List<SalesTrackingCategory> purchasesTrackingCategories) The default purchases tracking categories for contactsvoidsetSalesDefaultAccountCode(String salesDefaultAccountCode) The default sales account code for contactsvoidsetSalesDefaultLineAmountType(Contact.SalesDefaultLineAmountTypeEnum salesDefaultLineAmountType) The default sales line amount type for a contact.voidsetSalesTrackingCategories(List<SalesTrackingCategory> salesTrackingCategories) The default sales tracking categories for contactsvoidsetStatusAttributeString(String statusAttributeString) Status of objectvoidsetTaxNumber(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)voidsetTrackingCategoryName(String trackingCategoryName) The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategoriesvoidsetTrackingCategoryOption(String trackingCategoryOption) The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategoriesvoidsetValidationErrors(List<ValidationError> validationErrors) Displays validation errors returned from the APIvoidsetXeroNetworkKey(String xeroNetworkKey) Store XeroNetworkKey for contacts.statusAttributeString(String statusAttributeString) Status of objectTax 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)toString()trackingCategoryName(String trackingCategoryName) The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategoriestrackingCategoryOption(String trackingCategoryOption) The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategoriesvalidationErrors(List<ValidationError> validationErrors) Displays validation errors returned from the APIxeroNetworkKey(String xeroNetworkKey) Store XeroNetworkKey for contacts.
-
Constructor Details
-
Contact
public Contact()
-
-
Method Details
-
contactID
-
getContactID
-
setContactID
-
mergedToContactID
-
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
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
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
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
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
-
getAccountNumber
A user defined account number. This can be updated via the API and the Xero UI (max length = 50)- Returns:
- accountNumber
-
setAccountNumber
A user defined account number. This can be updated via the API and the Xero UI (max length = 50)- Parameters:
accountNumber- String
-
contactStatus
Current status of a contact – see contact status types- Parameters:
contactStatus- ContactStatusEnum- Returns:
- Contact
-
getContactStatus
Current status of a contact – see contact status types- Returns:
- contactStatus
-
setContactStatus
Current status of a contact – see contact status types- Parameters:
contactStatus- ContactStatusEnum
-
name
-
getName
-
setName
Full name of contact/organisation (max length = 255)- Parameters:
name- String
-
firstName
-
getFirstName
-
setFirstName
First name of contact person (max length = 255)- Parameters:
firstName- String
-
lastName
-
getLastName
-
setLastName
Last name of contact person (max length = 255)- Parameters:
lastName- String
-
companyNumber
-
getCompanyNumber
Company registration number (max length = 50)- Returns:
- companyNumber
-
setCompanyNumber
Company registration number (max length = 50)- Parameters:
companyNumber- String
-
emailAddress
-
getEmailAddress
Email address of contact person (umlauts not supported) (max length = 255)- Returns:
- emailAddress
-
setEmailAddress
Email address of contact person (umlauts not supported) (max length = 255)- Parameters:
emailAddress- String
-
contactPersons
See contact persons- Parameters:
contactPersons- List<ContactPerson>- Returns:
- Contact
-
addContactPersonsItem
See contact persons- Parameters:
contactPersonsItem- ContactPerson- Returns:
- Contact
-
getContactPersons
-
setContactPersons
See contact persons- Parameters:
contactPersons- List<ContactPerson>
-
bankAccountDetails
-
getBankAccountDetails
-
setBankAccountDetails
Bank account number of contact- Parameters:
bankAccountDetails- 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
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
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
-
getAccountsReceivableTaxType
The tax type from TaxRates- Returns:
- accountsReceivableTaxType
-
setAccountsReceivableTaxType
The tax type from TaxRates- Parameters:
accountsReceivableTaxType- String
-
accountsPayableTaxType
-
getAccountsPayableTaxType
The tax type from TaxRates- Returns:
- accountsPayableTaxType
-
setAccountsPayableTaxType
The tax type from TaxRates- Parameters:
accountsPayableTaxType- String
-
addresses
-
addAddressesItem
-
getAddresses
-
setAddresses
-
phones
-
addPhonesItem
-
getPhones
-
setPhones
-
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
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
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
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
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
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
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
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
defaultCurrency- Parameters:
defaultCurrency- CurrencyCode- Returns:
- Contact
-
getDefaultCurrency
-
setDefaultCurrency
defaultCurrency- Parameters:
defaultCurrency- CurrencyCode
-
xeroNetworkKey
-
getXeroNetworkKey
-
setXeroNetworkKey
Store XeroNetworkKey for contacts.- Parameters:
xeroNetworkKey- String
-
salesDefaultAccountCode
-
getSalesDefaultAccountCode
The default sales account code for contacts- Returns:
- salesDefaultAccountCode
-
setSalesDefaultAccountCode
The default sales account code for contacts- Parameters:
salesDefaultAccountCode- String
-
purchasesDefaultAccountCode
-
getPurchasesDefaultAccountCode
The default purchases account code for contacts- Returns:
- purchasesDefaultAccountCode
-
setPurchasesDefaultAccountCode
The default purchases account code for contacts- Parameters:
purchasesDefaultAccountCode- String
-
salesTrackingCategories
The default sales tracking categories for contacts- Parameters:
salesTrackingCategories- List<SalesTrackingCategory>- Returns:
- Contact
-
addSalesTrackingCategoriesItem
The default sales tracking categories for contacts- Parameters:
salesTrackingCategoriesItem- SalesTrackingCategory- Returns:
- Contact
-
getSalesTrackingCategories
The default sales tracking categories for contacts- Returns:
- salesTrackingCategories
-
setSalesTrackingCategories
The default sales tracking categories for contacts- Parameters:
salesTrackingCategories- 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
The default purchases tracking categories for contacts- Returns:
- purchasesTrackingCategories
-
setPurchasesTrackingCategories
The default purchases tracking categories for contacts- Parameters:
purchasesTrackingCategories- List<SalesTrackingCategory>
-
trackingCategoryName
-
getTrackingCategoryName
The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories- Returns:
- trackingCategoryName
-
setTrackingCategoryName
The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories- Parameters:
trackingCategoryName- String
-
trackingCategoryOption
-
getTrackingCategoryOption
The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories- Returns:
- trackingCategoryOption
-
setTrackingCategoryOption
The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories- Parameters:
trackingCategoryOption- String
-
paymentTerms
paymentTerms- Parameters:
paymentTerms- PaymentTerm- Returns:
- Contact
-
getPaymentTerms
-
setPaymentTerms
paymentTerms- Parameters:
paymentTerms- PaymentTerm
-
getUpdatedDateUTC
-
getUpdatedDateUTCAsDate
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()UTC timestamp of last update to contact- Returns:
- OffsetDateTime
-
contactGroups
Displays which contact groups a contact is included in- Parameters:
contactGroups- List<ContactGroup>- Returns:
- Contact
-
addContactGroupsItem
Displays which contact groups a contact is included in- Parameters:
contactGroupsItem- ContactGroup- Returns:
- Contact
-
getContactGroups
Displays which contact groups a contact is included in- Returns:
- contactGroups
-
setContactGroups
Displays which contact groups a contact is included in- Parameters:
contactGroups- List<ContactGroup>
-
getWebsite
-
brandingTheme
brandingTheme- Parameters:
brandingTheme- BrandingTheme- Returns:
- Contact
-
getBrandingTheme
-
setBrandingTheme
brandingTheme- Parameters:
brandingTheme- BrandingTheme
-
batchPayments
batchPayments- Parameters:
batchPayments- BatchPaymentDetails- Returns:
- Contact
-
getBatchPayments
-
setBatchPayments
batchPayments- Parameters:
batchPayments- BatchPaymentDetails
-
getDiscount
-
balances
-
getBalances
-
setBalances
-
attachments
Displays array of attachments from the API- Parameters:
attachments- List<Attachment>- Returns:
- Contact
-
addAttachmentsItem
Displays array of attachments from the API- Parameters:
attachmentsItem- Attachment- Returns:
- Contact
-
getAttachments
Displays array of attachments from the API- Returns:
- attachments
-
setAttachments
Displays array of attachments from the API- Parameters:
attachments- List<Attachment>
-
hasAttachments
-
getHasAttachments
A boolean to indicate if a contact has an attachment- Returns:
- hasAttachments
-
setHasAttachments
A boolean to indicate if a contact has an attachment- Parameters:
hasAttachments- Boolean
-
validationErrors
Displays validation errors returned from the API- Parameters:
validationErrors- List<ValidationError>- Returns:
- Contact
-
addValidationErrorsItem
Displays validation errors returned from the API- Parameters:
validationErrorsItem- ValidationError- Returns:
- Contact
-
getValidationErrors
Displays validation errors returned from the API- Returns:
- validationErrors
-
setValidationErrors
Displays validation errors returned from the API- Parameters:
validationErrors- List<ValidationError>
-
hasValidationErrors
-
getHasValidationErrors
A boolean to indicate if a contact has an validation errors- Returns:
- hasValidationErrors
-
setHasValidationErrors
A boolean to indicate if a contact has an validation errors- Parameters:
hasValidationErrors- Boolean
-
statusAttributeString
-
getStatusAttributeString
-
setStatusAttributeString
Status of object- Parameters:
statusAttributeString- String
-
equals
-
hashCode
-
toString
-