Package com.xero.models.accounting

Class Contact

java.lang.Object
com.xero.models.accounting.Contact
public class Contact
extends Object
Contact

  • Constructor Details

    • Contact

      public Contact()

  • Method Details

    • contactID

      public Contact contactID​(UUID contactID)

    • getContactID

      public UUID getContactID()
      Xero identifier
      Returns:
      contactID

    • setContactID

      public void setContactID​(UUID contactID)

    • contactNumber

      public Contact contactNumber​(String contactNumber)

    • 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)

    • accountNumber

      public Contact accountNumber​(String accountNumber)

    • 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)

    • contactStatus

      public Contact contactStatus​(Contact.ContactStatusEnum contactStatus)

    • getContactStatus

      public Contact.ContactStatusEnum getContactStatus()
      Current status of a contact – see contact status types
      Returns:
      contactStatus

    • setContactStatus

      public void setContactStatus​(Contact.ContactStatusEnum contactStatus)

    • name

      public Contact name​(String name)

    • getName

      public String getName()
      Full name of contact/organisation (max length = 255)
      Returns:
      name

    • setName

      public void setName​(String name)

    • firstName

      public Contact firstName​(String firstName)

    • getFirstName

      public String getFirstName()
      First name of contact person (max length = 255)
      Returns:
      firstName

    • setFirstName

      public void setFirstName​(String firstName)

    • lastName

      public Contact lastName​(String lastName)

    • getLastName

      public String getLastName()
      Last name of contact person (max length = 255)
      Returns:
      lastName

    • setLastName

      public void setLastName​(String lastName)

    • emailAddress

      public Contact emailAddress​(String emailAddress)

    • getEmailAddress

      public String getEmailAddress()
      Email address of contact person (umlauts not supported) (max length = 255)
      Returns:
      emailAddress

    • setEmailAddress

      public void setEmailAddress​(String emailAddress)

    • skypeUserName

      public Contact skypeUserName​(String skypeUserName)

    • getSkypeUserName

      public String getSkypeUserName()
      Skype user name of contact
      Returns:
      skypeUserName

    • setSkypeUserName

      public void setSkypeUserName​(String skypeUserName)

    • contactPersons

      public Contact contactPersons​(List<ContactPerson> contactPersons)

    • addContactPersonsItem

      public Contact addContactPersonsItem​(ContactPerson contactPersonsItem)

    • getContactPersons

      public List<ContactPerson> getContactPersons()
      See contact persons
      Returns:
      contactPersons

    • setContactPersons

      public void setContactPersons​(List<ContactPerson> contactPersons)

    • bankAccountDetails

      public Contact bankAccountDetails​(String bankAccountDetails)

    • getBankAccountDetails

      public String getBankAccountDetails()
      Bank account number of contact
      Returns:
      bankAccountDetails

    • setBankAccountDetails

      public void setBankAccountDetails​(String bankAccountDetails)

    • taxNumber

      public Contact taxNumber​(String taxNumber)

    • 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)

    • accountsReceivableTaxType

      public Contact accountsReceivableTaxType​(String accountsReceivableTaxType)

    • getAccountsReceivableTaxType

      public String getAccountsReceivableTaxType()
      The tax type from TaxRates
      Returns:
      accountsReceivableTaxType

    • setAccountsReceivableTaxType

      public void setAccountsReceivableTaxType​(String accountsReceivableTaxType)

    • accountsPayableTaxType

      public Contact accountsPayableTaxType​(String accountsPayableTaxType)

    • getAccountsPayableTaxType

      public String getAccountsPayableTaxType()
      The tax type from TaxRates
      Returns:
      accountsPayableTaxType

    • setAccountsPayableTaxType

      public void setAccountsPayableTaxType​(String accountsPayableTaxType)

    • addresses

      public Contact addresses​(List<Address> addresses)

    • addAddressesItem

      public Contact addAddressesItem​(Address addressesItem)

    • getAddresses

      public List<Address> getAddresses()
      Store certain address types for a contact – see address types
      Returns:
      addresses

    • setAddresses

      public void setAddresses​(List<Address> addresses)

    • phones

      public Contact phones​(List<Phone> phones)

    • addPhonesItem

      public Contact addPhonesItem​(Phone phonesItem)

    • getPhones

      public List<Phone> getPhones()
      Store certain phone types for a contact – see phone types
      Returns:
      phones

    • setPhones

      public void setPhones​(List<Phone> phones)

    • isSupplier

      public Contact isSupplier​(Boolean isSupplier)

    • 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)

    • isCustomer

      public Contact isCustomer​(Boolean isCustomer)

    • 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)

    • defaultCurrency

      public Contact defaultCurrency​(CurrencyCode defaultCurrency)

    • getDefaultCurrency

      public CurrencyCode getDefaultCurrency()
      Get defaultCurrency
      Returns:
      defaultCurrency

    • setDefaultCurrency

      public void setDefaultCurrency​(CurrencyCode defaultCurrency)

    • xeroNetworkKey

      public Contact xeroNetworkKey​(String xeroNetworkKey)

    • getXeroNetworkKey

      public String getXeroNetworkKey()
      Store XeroNetworkKey for contacts.
      Returns:
      xeroNetworkKey

    • setXeroNetworkKey

      public void setXeroNetworkKey​(String xeroNetworkKey)

    • salesDefaultAccountCode

      public Contact salesDefaultAccountCode​(String salesDefaultAccountCode)

    • getSalesDefaultAccountCode

      public String getSalesDefaultAccountCode()
      The default sales account code for contacts
      Returns:
      salesDefaultAccountCode

    • setSalesDefaultAccountCode

      public void setSalesDefaultAccountCode​(String salesDefaultAccountCode)

    • purchasesDefaultAccountCode

      public Contact purchasesDefaultAccountCode​(String purchasesDefaultAccountCode)

    • getPurchasesDefaultAccountCode

      public String getPurchasesDefaultAccountCode()
      The default purchases account code for contacts
      Returns:
      purchasesDefaultAccountCode

    • setPurchasesDefaultAccountCode

      public void setPurchasesDefaultAccountCode​(String purchasesDefaultAccountCode)

    • salesTrackingCategories

      public Contact salesTrackingCategories​(List<SalesTrackingCategory> salesTrackingCategories)

    • addSalesTrackingCategoriesItem

      public Contact addSalesTrackingCategoriesItem​(SalesTrackingCategory salesTrackingCategoriesItem)

    • getSalesTrackingCategories

      public List<SalesTrackingCategory> getSalesTrackingCategories()
      The default sales tracking categories for contacts
      Returns:
      salesTrackingCategories

    • setSalesTrackingCategories

      public void setSalesTrackingCategories​(List<SalesTrackingCategory> salesTrackingCategories)

    • purchasesTrackingCategories

      public Contact purchasesTrackingCategories​(List<SalesTrackingCategory> purchasesTrackingCategories)

    • addPurchasesTrackingCategoriesItem

      public Contact addPurchasesTrackingCategoriesItem​(SalesTrackingCategory purchasesTrackingCategoriesItem)

    • getPurchasesTrackingCategories

      public List<SalesTrackingCategory> getPurchasesTrackingCategories()
      The default purchases tracking categories for contacts
      Returns:
      purchasesTrackingCategories

    • setPurchasesTrackingCategories

      public void setPurchasesTrackingCategories​(List<SalesTrackingCategory> purchasesTrackingCategories)

    • trackingCategoryName

      public Contact trackingCategoryName​(String trackingCategoryName)

    • 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)

    • trackingCategoryOption

      public Contact trackingCategoryOption​(String trackingCategoryOption)

    • 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)

    • paymentTerms

      public Contact paymentTerms​(PaymentTerm paymentTerms)

    • getPaymentTerms

      public PaymentTerm getPaymentTerms()
      Get paymentTerms
      Returns:
      paymentTerms

    • setPaymentTerms

      public void setPaymentTerms​(PaymentTerm paymentTerms)

    • getUpdatedDateUTC

      public String getUpdatedDateUTC()
      UTC timestamp of last update to contact
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • contactGroups

      public Contact contactGroups​(List<ContactGroup> contactGroups)

    • addContactGroupsItem

      public Contact addContactGroupsItem​(ContactGroup contactGroupsItem)

    • getContactGroups

      public List<ContactGroup> getContactGroups()
      Displays which contact groups a contact is included in
      Returns:
      contactGroups

    • setContactGroups

      public void setContactGroups​(List<ContactGroup> contactGroups)

    • getWebsite

      public String getWebsite()
      Website address for contact (read only)
      Returns:
      website

    • brandingTheme

      public Contact brandingTheme​(BrandingTheme brandingTheme)

    • getBrandingTheme

      public BrandingTheme getBrandingTheme()
      Get brandingTheme
      Returns:
      brandingTheme

    • setBrandingTheme

      public void setBrandingTheme​(BrandingTheme brandingTheme)

    • batchPayments

      public Contact batchPayments​(BatchPaymentDetails batchPayments)

    • getBatchPayments

      public BatchPaymentDetails getBatchPayments()
      Get batchPayments
      Returns:
      batchPayments

    • setBatchPayments

      public void setBatchPayments​(BatchPaymentDetails batchPayments)

    • getDiscount

      public Double getDiscount()
      The default discount rate for the contact (read only)
      Returns:
      discount

    • balances

      public Contact balances​(Balances balances)

    • getBalances

      public Balances getBalances()
      Get balances
      Returns:
      balances

    • setBalances

      public void setBalances​(Balances balances)

    • attachments

      public Contact attachments​(List<Attachment> attachments)

    • addAttachmentsItem

      public Contact addAttachmentsItem​(Attachment attachmentsItem)

    • getAttachments

      public List<Attachment> getAttachments()
      Displays array of attachments from the API
      Returns:
      attachments

    • setAttachments

      public void setAttachments​(List<Attachment> attachments)

    • hasAttachments

      public Contact hasAttachments​(Boolean hasAttachments)

    • getHasAttachments

      public Boolean getHasAttachments()
      A boolean to indicate if a contact has an attachment
      Returns:
      hasAttachments

    • setHasAttachments

      public void setHasAttachments​(Boolean hasAttachments)

    • validationErrors

      public Contact validationErrors​(List<ValidationError> validationErrors)

    • addValidationErrorsItem

      public Contact addValidationErrorsItem​(ValidationError validationErrorsItem)

    • getValidationErrors

      public List<ValidationError> getValidationErrors()
      Displays validation errors returned from the API
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors​(List<ValidationError> validationErrors)

    • hasValidationErrors

      public Contact hasValidationErrors​(Boolean hasValidationErrors)

    • getHasValidationErrors

      public Boolean getHasValidationErrors()
      A boolean to indicate if a contact has an validation errors
      Returns:
      hasValidationErrors

    • setHasValidationErrors

      public void setHasValidationErrors​(Boolean hasValidationErrors)

    • statusAttributeString

      public Contact statusAttributeString​(String statusAttributeString)

    • getStatusAttributeString

      public String getStatusAttributeString()
      Status of object
      Returns:
      statusAttributeString

    • setStatusAttributeString

      public void setStatusAttributeString​(String statusAttributeString)

    • 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