Package com.xero.models.accounting

Class Organisation

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

  • Constructor Details

    • Organisation

      public Organisation()

  • Method Details

    • organisationID

      public Organisation organisationID​(UUID organisationID)

    • getOrganisationID

      public UUID getOrganisationID()
      Unique Xero identifier
      Returns:
      organisationID

    • setOrganisationID

      public void setOrganisationID​(UUID organisationID)

    • apIKey

      public Organisation apIKey​(String apIKey)

    • getApIKey

      public String getApIKey()
      Display a unique key used for Xero-to-Xero transactions
      Returns:
      apIKey

    • setApIKey

      public void setApIKey​(String apIKey)

    • name

      public Organisation name​(String name)

    • getName

      public String getName()
      Display name of organisation shown in Xero
      Returns:
      name

    • setName

      public void setName​(String name)

    • legalName

      public Organisation legalName​(String legalName)

    • getLegalName

      public String getLegalName()
      Organisation name shown on Reports
      Returns:
      legalName

    • setLegalName

      public void setLegalName​(String legalName)

    • paysTax

      public Organisation paysTax​(Boolean paysTax)

    • getPaysTax

      public Boolean getPaysTax()
      Boolean to describe if organisation is registered with a local tax authority i.e. true, false
      Returns:
      paysTax

    • setPaysTax

      public void setPaysTax​(Boolean paysTax)

    • version

      public Organisation version​(Organisation.VersionEnum version)

    • getVersion

      public Organisation.VersionEnum getVersion()
      See Version Types
      Returns:
      version

    • setVersion

      public void setVersion​(Organisation.VersionEnum version)

    • organisationType

      public Organisation organisationType​(Organisation.OrganisationTypeEnum organisationType)

    • getOrganisationType

      public Organisation.OrganisationTypeEnum getOrganisationType()
      Organisation Type
      Returns:
      organisationType

    • setOrganisationType

      public void setOrganisationType​(Organisation.OrganisationTypeEnum organisationType)

    • baseCurrency

      public Organisation baseCurrency​(CurrencyCode baseCurrency)

    • getBaseCurrency

      public CurrencyCode getBaseCurrency()
      Get baseCurrency
      Returns:
      baseCurrency

    • setBaseCurrency

      public void setBaseCurrency​(CurrencyCode baseCurrency)

    • countryCode

      public Organisation countryCode​(CountryCode countryCode)

    • getCountryCode

      public CountryCode getCountryCode()
      Get countryCode
      Returns:
      countryCode

    • setCountryCode

      public void setCountryCode​(CountryCode countryCode)

    • isDemoCompany

      public Organisation isDemoCompany​(Boolean isDemoCompany)

    • getIsDemoCompany

      public Boolean getIsDemoCompany()
      Boolean to describe if organisation is a demo company.
      Returns:
      isDemoCompany

    • setIsDemoCompany

      public void setIsDemoCompany​(Boolean isDemoCompany)

    • organisationStatus

      public Organisation organisationStatus​(String organisationStatus)

    • getOrganisationStatus

      public String getOrganisationStatus()
      Will be set to ACTIVE if you can connect to organisation via the Xero API
      Returns:
      organisationStatus

    • setOrganisationStatus

      public void setOrganisationStatus​(String organisationStatus)

    • registrationNumber

      public Organisation registrationNumber​(String registrationNumber)

    • getRegistrationNumber

      public String getRegistrationNumber()
      Shows for New Zealand, Australian and UK organisations
      Returns:
      registrationNumber

    • setRegistrationNumber

      public void setRegistrationNumber​(String registrationNumber)

    • employerIdentificationNumber

      public Organisation employerIdentificationNumber​(String employerIdentificationNumber)

    • getEmployerIdentificationNumber

      public String getEmployerIdentificationNumber()
      Shown if set. US Only.
      Returns:
      employerIdentificationNumber

    • setEmployerIdentificationNumber

      public void setEmployerIdentificationNumber​(String employerIdentificationNumber)

    • taxNumber

      public Organisation taxNumber​(String taxNumber)

    • getTaxNumber

      public String getTaxNumber()
      Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global).
      Returns:
      taxNumber

    • setTaxNumber

      public void setTaxNumber​(String taxNumber)

    • financialYearEndDay

      public Organisation financialYearEndDay​(Integer financialYearEndDay)

    • getFinancialYearEndDay

      public Integer getFinancialYearEndDay()
      Calendar day e.g. 0-31
      Returns:
      financialYearEndDay

    • setFinancialYearEndDay

      public void setFinancialYearEndDay​(Integer financialYearEndDay)

    • financialYearEndMonth

      public Organisation financialYearEndMonth​(Integer financialYearEndMonth)

    • getFinancialYearEndMonth

      public Integer getFinancialYearEndMonth()
      Calendar Month e.g. 1-12
      Returns:
      financialYearEndMonth

    • setFinancialYearEndMonth

      public void setFinancialYearEndMonth​(Integer financialYearEndMonth)

    • salesTaxBasis

      public Organisation salesTaxBasis​(Organisation.SalesTaxBasisEnum salesTaxBasis)

    • getSalesTaxBasis

      public Organisation.SalesTaxBasisEnum getSalesTaxBasis()
      The accounting basis used for tax returns. See Sales Tax Basis
      Returns:
      salesTaxBasis

    • setSalesTaxBasis

      public void setSalesTaxBasis​(Organisation.SalesTaxBasisEnum salesTaxBasis)

    • salesTaxPeriod

      public Organisation salesTaxPeriod​(Organisation.SalesTaxPeriodEnum salesTaxPeriod)

    • getSalesTaxPeriod

      public Organisation.SalesTaxPeriodEnum getSalesTaxPeriod()
      The frequency with which tax returns are processed. See Sales Tax Period
      Returns:
      salesTaxPeriod

    • setSalesTaxPeriod

      public void setSalesTaxPeriod​(Organisation.SalesTaxPeriodEnum salesTaxPeriod)

    • defaultSalesTax

      public Organisation defaultSalesTax​(String defaultSalesTax)

    • getDefaultSalesTax

      public String getDefaultSalesTax()
      The default for LineAmountTypes on sales transactions
      Returns:
      defaultSalesTax

    • setDefaultSalesTax

      public void setDefaultSalesTax​(String defaultSalesTax)

    • defaultPurchasesTax

      public Organisation defaultPurchasesTax​(String defaultPurchasesTax)

    • getDefaultPurchasesTax

      public String getDefaultPurchasesTax()
      The default for LineAmountTypes on purchase transactions
      Returns:
      defaultPurchasesTax

    • setDefaultPurchasesTax

      public void setDefaultPurchasesTax​(String defaultPurchasesTax)

    • periodLockDate

      public Organisation periodLockDate​(String periodLockDate)

    • getPeriodLockDate

      public String getPeriodLockDate()
      Shown if set. See lock dates
      Returns:
      periodLockDate

    • getPeriodLockDateAsDate

      public org.threeten.bp.LocalDate getPeriodLockDateAsDate()

    • setPeriodLockDate

      public void setPeriodLockDate​(String periodLockDate)

    • setPeriodLockDate

      public void setPeriodLockDate​(org.threeten.bp.LocalDate periodLockDate)

    • endOfYearLockDate

      public Organisation endOfYearLockDate​(String endOfYearLockDate)

    • getEndOfYearLockDate

      public String getEndOfYearLockDate()
      Shown if set. See lock dates
      Returns:
      endOfYearLockDate

    • getEndOfYearLockDateAsDate

      public org.threeten.bp.LocalDate getEndOfYearLockDateAsDate()

    • setEndOfYearLockDate

      public void setEndOfYearLockDate​(String endOfYearLockDate)

    • setEndOfYearLockDate

      public void setEndOfYearLockDate​(org.threeten.bp.LocalDate endOfYearLockDate)

    • getCreatedDateUTC

      public String getCreatedDateUTC()
      Timestamp when the organisation was created in Xero
      Returns:
      createdDateUTC

    • getCreatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getCreatedDateUTCAsDate()

    • timezone

      public Organisation timezone​(TimeZone timezone)

    • getTimezone

      public TimeZone getTimezone()
      Get timezone
      Returns:
      timezone

    • setTimezone

      public void setTimezone​(TimeZone timezone)

    • organisationEntityType

      public Organisation organisationEntityType​(Organisation.OrganisationEntityTypeEnum organisationEntityType)

    • getOrganisationEntityType

      public Organisation.OrganisationEntityTypeEnum getOrganisationEntityType()
      Organisation Entity Type
      Returns:
      organisationEntityType

    • setOrganisationEntityType

      public void setOrganisationEntityType​(Organisation.OrganisationEntityTypeEnum organisationEntityType)

    • shortCode

      public Organisation shortCode​(String shortCode)

    • getShortCode

      public String getShortCode()
      A unique identifier for the organisation. Potential uses.
      Returns:
      shortCode

    • setShortCode

      public void setShortCode​(String shortCode)

    • propertyClass

      public Organisation propertyClass​(Organisation.PropertyClassEnum propertyClass)

    • getPropertyClass

      public Organisation.PropertyClassEnum getPropertyClass()
      Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
      Returns:
      propertyClass

    • setPropertyClass

      public void setPropertyClass​(Organisation.PropertyClassEnum propertyClass)

    • edition

      public Organisation edition​(Organisation.EditionEnum edition)

    • getEdition

      public Organisation.EditionEnum getEdition()
      BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
      Returns:
      edition

    • setEdition

      public void setEdition​(Organisation.EditionEnum edition)

    • lineOfBusiness

      public Organisation lineOfBusiness​(String lineOfBusiness)

    • getLineOfBusiness

      public String getLineOfBusiness()
      Description of business type as defined in Organisation settings
      Returns:
      lineOfBusiness

    • setLineOfBusiness

      public void setLineOfBusiness​(String lineOfBusiness)

    • addresses

      public Organisation addresses​(List<Address> addresses)

    • addAddressesItem

      public Organisation addAddressesItem​(Address addressesItem)

    • getAddresses

      public List<Address> getAddresses()
      Address details for organisation – see Addresses
      Returns:
      addresses

    • setAddresses

      public void setAddresses​(List<Address> addresses)

    • phones

      public Organisation phones​(List<Phone> phones)

    • addPhonesItem

      public Organisation addPhonesItem​(Phone phonesItem)

    • getPhones

      public List<Phone> getPhones()
      Phones details for organisation – see Phones
      Returns:
      phones

    • setPhones

      public void setPhones​(List<Phone> phones)

    • externalLinks

      public Organisation externalLinks​(List<ExternalLink> externalLinks)

    • addExternalLinksItem

      public Organisation addExternalLinksItem​(ExternalLink externalLinksItem)

    • getExternalLinks

      public List<ExternalLink> getExternalLinks()
      Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings is updated in Xero. See ExternalLinks below
      Returns:
      externalLinks

    • setExternalLinks

      public void setExternalLinks​(List<ExternalLink> externalLinks)

    • paymentTerms

      public Organisation paymentTerms​(PaymentTerm paymentTerms)

    • getPaymentTerms

      public PaymentTerm getPaymentTerms()
      Get paymentTerms
      Returns:
      paymentTerms

    • setPaymentTerms

      public void setPaymentTerms​(PaymentTerm paymentTerms)

    • 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