java.lang.Object
- com.xero.models.accounting.Organisation

public class Organisation
extends Object

Organisation

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Organisation.EditionEnum`	BUSINESS or PARTNER.
`static class`	`Organisation.OrganisationEntityTypeEnum`	Organisation Entity Type
`static class`	`Organisation.OrganisationTypeEnum`	Organisation Type
`static class`	`Organisation.PropertyClassEnum`	Organisation Classes describe which plan the Xero organisation is on (e.g.
`static class`	`Organisation.SalesTaxBasisEnum`	The accounting basis used for tax returns.
`static class`	`Organisation.SalesTaxPeriodEnum`	The frequency with which tax returns are processed.
`static class`	`Organisation.VersionEnum`	See Version Types

Constructor Summary

Constructors
Constructor Description

Organisation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Organisation`	`addAddressesItem(AddressForOrganisation addressesItem)`	Address details for organisation – see Addresses
`Organisation`	`addExternalLinksItem(ExternalLink externalLinksItem)`	Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.
`Organisation`	`addPhonesItem(Phone phonesItem)`	Phones details for organisation – see Phones
`Organisation`	`addresses(List<AddressForOrganisation> addresses)`	Address details for organisation – see Addresses
`Organisation`	`apIKey(String apIKey)`	Display a unique key used for Xero-to-Xero transactions
`Organisation`	`baseCurrency(CurrencyCode baseCurrency)`	baseCurrency
`Organisation`	`countryCode(CountryCode countryCode)`	countryCode
`Organisation`	`defaultPurchasesTax(String defaultPurchasesTax)`	The default for LineAmountTypes on purchase transactions
`Organisation`	`defaultSalesTax(String defaultSalesTax)`	The default for LineAmountTypes on sales transactions
`Organisation`	`edition(Organisation.EditionEnum edition)`	BUSINESS or PARTNER.
`Organisation`	`employerIdentificationNumber(String employerIdentificationNumber)`	Shown if set.
`Organisation`	`endOfYearLockDate(String endOfYearLockDate)`	Shown if set.
`boolean`	`equals(Object o)`
`Organisation`	`externalLinks(List<ExternalLink> externalLinks)`	Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.
`Organisation`	`financialYearEndDay(Integer financialYearEndDay)`	Calendar day e.g.
`Organisation`	`financialYearEndMonth(Integer financialYearEndMonth)`	Calendar Month e.g.
`List<AddressForOrganisation>`	`getAddresses()`	Address details for organisation – see Addresses
`String`	`getApIKey()`	Display a unique key used for Xero-to-Xero transactions
`CurrencyCode`	`getBaseCurrency()`	Get baseCurrency
`CountryCode`	`getCountryCode()`	Get countryCode
`String`	`getCreatedDateUTC()`	Timestamp when the organisation was created in Xero
`org.threeten.bp.OffsetDateTime`	`getCreatedDateUTCAsDate()`	Timestamp when the organisation was created in Xero
`String`	`getDefaultPurchasesTax()`	The default for LineAmountTypes on purchase transactions
`String`	`getDefaultSalesTax()`	The default for LineAmountTypes on sales transactions
`Organisation.EditionEnum`	`getEdition()`	BUSINESS or PARTNER.
`String`	`getEmployerIdentificationNumber()`	Shown if set.
`String`	`getEndOfYearLockDate()`	Shown if set.
`org.threeten.bp.LocalDate`	`getEndOfYearLockDateAsDate()`	Shown if set.
`List<ExternalLink>`	`getExternalLinks()`	Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.
`Integer`	`getFinancialYearEndDay()`	Calendar day e.g.
`Integer`	`getFinancialYearEndMonth()`	Calendar Month e.g.
`Boolean`	`getIsDemoCompany()`	Boolean to describe if organisation is a demo company.
`String`	`getLegalName()`	Organisation name shown on Reports
`String`	`getLineOfBusiness()`	Description of business type as defined in Organisation settings
`String`	`getName()`	Display name of organisation shown in Xero
`Organisation.OrganisationEntityTypeEnum`	`getOrganisationEntityType()`	Organisation Entity Type
`UUID`	`getOrganisationID()`	Unique Xero identifier
`String`	`getOrganisationStatus()`	Will be set to ACTIVE if you can connect to organisation via the Xero API
`Organisation.OrganisationTypeEnum`	`getOrganisationType()`	Organisation Type
`PaymentTerm`	`getPaymentTerms()`	Get paymentTerms
`Boolean`	`getPaysTax()`	Boolean to describe if organisation is registered with a local tax authority i.e.
`String`	`getPeriodLockDate()`	Shown if set.
`org.threeten.bp.LocalDate`	`getPeriodLockDateAsDate()`	Shown if set.
`List<Phone>`	`getPhones()`	Phones details for organisation – see Phones
`Organisation.PropertyClassEnum`	`getPropertyClass()`	Organisation Classes describe which plan the Xero organisation is on (e.g.
`String`	`getRegistrationNumber()`	Shows for New Zealand, Australian and UK organisations
`Organisation.SalesTaxBasisEnum`	`getSalesTaxBasis()`	The accounting basis used for tax returns.
`Organisation.SalesTaxPeriodEnum`	`getSalesTaxPeriod()`	The frequency with which tax returns are processed.
`String`	`getShortCode()`	A unique identifier for the organisation.
`String`	`getTaxNumber()`	Shown if set.
`TimeZone`	`getTimezone()`	Get timezone
`Organisation.VersionEnum`	`getVersion()`	See Version Types
`int`	`hashCode()`
`Organisation`	`isDemoCompany(Boolean isDemoCompany)`	Boolean to describe if organisation is a demo company.
`Organisation`	`legalName(String legalName)`	Organisation name shown on Reports
`Organisation`	`lineOfBusiness(String lineOfBusiness)`	Description of business type as defined in Organisation settings
`Organisation`	`name(String name)`	Display name of organisation shown in Xero
`Organisation`	`organisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType)`	Organisation Entity Type
`Organisation`	`organisationID(UUID organisationID)`	Unique Xero identifier
`Organisation`	`organisationStatus(String organisationStatus)`	Will be set to ACTIVE if you can connect to organisation via the Xero API
`Organisation`	`organisationType(Organisation.OrganisationTypeEnum organisationType)`	Organisation Type
`Organisation`	`paymentTerms(PaymentTerm paymentTerms)`	paymentTerms
`Organisation`	`paysTax(Boolean paysTax)`	Boolean to describe if organisation is registered with a local tax authority i.e.
`Organisation`	`periodLockDate(String periodLockDate)`	Shown if set.
`Organisation`	`phones(List<Phone> phones)`	Phones details for organisation – see Phones
`Organisation`	`propertyClass(Organisation.PropertyClassEnum propertyClass)`	Organisation Classes describe which plan the Xero organisation is on (e.g.
`Organisation`	`registrationNumber(String registrationNumber)`	Shows for New Zealand, Australian and UK organisations
`Organisation`	`salesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis)`	The accounting basis used for tax returns.
`Organisation`	`salesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod)`	The frequency with which tax returns are processed.
`void`	`setAddresses(List<AddressForOrganisation> addresses)`	Address details for organisation – see Addresses
`void`	`setApIKey(String apIKey)`	Display a unique key used for Xero-to-Xero transactions
`void`	`setBaseCurrency(CurrencyCode baseCurrency)`	baseCurrency
`void`	`setCountryCode(CountryCode countryCode)`	countryCode
`void`	`setDefaultPurchasesTax(String defaultPurchasesTax)`	The default for LineAmountTypes on purchase transactions
`void`	`setDefaultSalesTax(String defaultSalesTax)`	The default for LineAmountTypes on sales transactions
`void`	`setEdition(Organisation.EditionEnum edition)`	BUSINESS or PARTNER.
`void`	`setEmployerIdentificationNumber(String employerIdentificationNumber)`	Shown if set.
`void`	`setEndOfYearLockDate(String endOfYearLockDate)`	Shown if set.
`void`	`setEndOfYearLockDate(org.threeten.bp.LocalDate endOfYearLockDate)`	Shown if set.
`void`	`setExternalLinks(List<ExternalLink> externalLinks)`	Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.
`void`	`setFinancialYearEndDay(Integer financialYearEndDay)`	Calendar day e.g.
`void`	`setFinancialYearEndMonth(Integer financialYearEndMonth)`	Calendar Month e.g.
`void`	`setIsDemoCompany(Boolean isDemoCompany)`	Boolean to describe if organisation is a demo company.
`void`	`setLegalName(String legalName)`	Organisation name shown on Reports
`void`	`setLineOfBusiness(String lineOfBusiness)`	Description of business type as defined in Organisation settings
`void`	`setName(String name)`	Display name of organisation shown in Xero
`void`	`setOrganisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType)`	Organisation Entity Type
`void`	`setOrganisationID(UUID organisationID)`	Unique Xero identifier
`void`	`setOrganisationStatus(String organisationStatus)`	Will be set to ACTIVE if you can connect to organisation via the Xero API
`void`	`setOrganisationType(Organisation.OrganisationTypeEnum organisationType)`	Organisation Type
`void`	`setPaymentTerms(PaymentTerm paymentTerms)`	paymentTerms
`void`	`setPaysTax(Boolean paysTax)`	Boolean to describe if organisation is registered with a local tax authority i.e.
`void`	`setPeriodLockDate(String periodLockDate)`	Shown if set.
`void`	`setPeriodLockDate(org.threeten.bp.LocalDate periodLockDate)`	Shown if set.
`void`	`setPhones(List<Phone> phones)`	Phones details for organisation – see Phones
`void`	`setPropertyClass(Organisation.PropertyClassEnum propertyClass)`	Organisation Classes describe which plan the Xero organisation is on (e.g.
`void`	`setRegistrationNumber(String registrationNumber)`	Shows for New Zealand, Australian and UK organisations
`void`	`setSalesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis)`	The accounting basis used for tax returns.
`void`	`setSalesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod)`	The frequency with which tax returns are processed.
`void`	`setShortCode(String shortCode)`	A unique identifier for the organisation.
`void`	`setTaxNumber(String taxNumber)`	Shown if set.
`void`	`setTimezone(TimeZone timezone)`	timezone
`void`	`setVersion(Organisation.VersionEnum version)`	See Version Types
`Organisation`	`shortCode(String shortCode)`	A unique identifier for the organisation.
`Organisation`	`taxNumber(String taxNumber)`	Shown if set.
`Organisation`	`timezone(TimeZone timezone)`	timezone
`String`	`toString()`
`Organisation`	`version(Organisation.VersionEnum version)`	See Version Types

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Organisation
```
public Organisation()
```
- Method Detail
  - organisationID
```
public Organisation organisationID(UUID organisationID)
```
    Unique Xero identifier
    
    Parameters:
    
    organisationID - UUID
    
    Returns:
    
    Organisation
  - getOrganisationID
```
public UUID getOrganisationID()
```
    Unique Xero identifier
    
    Returns:
    
    organisationID
  - setOrganisationID
```
public void setOrganisationID(UUID organisationID)
```
    Unique Xero identifier
    
    Parameters:
    
    organisationID - UUID
  - apIKey
```
public Organisation apIKey(String apIKey)
```
    Display a unique key used for Xero-to-Xero transactions
    
    Parameters:
    
    apIKey - String
    
    Returns:
    
    Organisation
  - getApIKey
```
public String getApIKey()
```
    Display a unique key used for Xero-to-Xero transactions
    
    Returns:
    
    apIKey
  - setApIKey
```
public void setApIKey(String apIKey)
```
    Display a unique key used for Xero-to-Xero transactions
    
    Parameters:
    
    apIKey - String
  - name
```
public Organisation name(String name)
```
    Display name of organisation shown in Xero
    
    Parameters:
    
    name - String
    
    Returns:
    
    Organisation
  - getName
```
public String getName()
```
    Display name of organisation shown in Xero
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    Display name of organisation shown in Xero
    
    Parameters:
    
    name - String
  - legalName
```
public Organisation legalName(String legalName)
```
    Organisation name shown on Reports
    
    Parameters:
    
    legalName - String
    
    Returns:
    
    Organisation
  - getLegalName
```
public String getLegalName()
```
    Organisation name shown on Reports
    
    Returns:
    
    legalName
  - setLegalName
```
public void setLegalName(String legalName)
```
    Organisation name shown on Reports
    
    Parameters:
    
    legalName - String
  - paysTax
```
public Organisation paysTax(Boolean paysTax)
```
    Boolean to describe if organisation is registered with a local tax authority i.e. true, false
    
    Parameters:
    
    paysTax - Boolean
    
    Returns:
    
    Organisation
  - 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)
```
    Boolean to describe if organisation is registered with a local tax authority i.e. true, false
    
    Parameters:
    
    paysTax - Boolean
  - version
```
public Organisation version(Organisation.VersionEnum version)
```
    See Version Types
    
    Parameters:
    
    version - VersionEnum
    
    Returns:
    
    Organisation
  - getVersion
```
public Organisation.VersionEnum getVersion()
```
    See Version Types
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Organisation.VersionEnum version)
```
    See Version Types
    
    Parameters:
    
    version - VersionEnum
  - organisationType
```
public Organisation organisationType(Organisation.OrganisationTypeEnum organisationType)
```
    Organisation Type
    
    Parameters:
    
    organisationType - OrganisationTypeEnum
    
    Returns:
    
    Organisation
  - getOrganisationType
```
public Organisation.OrganisationTypeEnum getOrganisationType()
```
    Organisation Type
    
    Returns:
    
    organisationType
  - setOrganisationType
```
public void setOrganisationType(Organisation.OrganisationTypeEnum organisationType)
```
    Organisation Type
    
    Parameters:
    
    organisationType - OrganisationTypeEnum
  - baseCurrency
```
public Organisation baseCurrency(CurrencyCode baseCurrency)
```
    baseCurrency
    
    Parameters:
    
    baseCurrency - CurrencyCode
    
    Returns:
    
    Organisation
  - getBaseCurrency
```
public CurrencyCode getBaseCurrency()
```
    Get baseCurrency
    
    Returns:
    
    baseCurrency
  - setBaseCurrency
```
public void setBaseCurrency(CurrencyCode baseCurrency)
```
    baseCurrency
    
    Parameters:
    
    baseCurrency - CurrencyCode
  - countryCode
```
public Organisation countryCode(CountryCode countryCode)
```
    countryCode
    
    Parameters:
    
    countryCode - CountryCode
    
    Returns:
    
    Organisation
  - getCountryCode
```
public CountryCode getCountryCode()
```
    Get countryCode
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(CountryCode countryCode)
```
    countryCode
    
    Parameters:
    
    countryCode - CountryCode
  - isDemoCompany
```
public Organisation isDemoCompany(Boolean isDemoCompany)
```
    Boolean to describe if organisation is a demo company.
    
    Parameters:
    
    isDemoCompany - Boolean
    
    Returns:
    
    Organisation
  - getIsDemoCompany
```
public Boolean getIsDemoCompany()
```
    Boolean to describe if organisation is a demo company.
    
    Returns:
    
    isDemoCompany
  - setIsDemoCompany
```
public void setIsDemoCompany(Boolean isDemoCompany)
```
    Boolean to describe if organisation is a demo company.
    
    Parameters:
    
    isDemoCompany - Boolean
  - organisationStatus
```
public Organisation organisationStatus(String organisationStatus)
```
    Will be set to ACTIVE if you can connect to organisation via the Xero API
    
    Parameters:
    
    organisationStatus - String
    
    Returns:
    
    Organisation
  - 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)
```
    Will be set to ACTIVE if you can connect to organisation via the Xero API
    
    Parameters:
    
    organisationStatus - String
  - registrationNumber
```
public Organisation registrationNumber(String registrationNumber)
```
    Shows for New Zealand, Australian and UK organisations
    
    Parameters:
    
    registrationNumber - String
    
    Returns:
    
    Organisation
  - getRegistrationNumber
```
public String getRegistrationNumber()
```
    Shows for New Zealand, Australian and UK organisations
    
    Returns:
    
    registrationNumber
  - setRegistrationNumber
```
public void setRegistrationNumber(String registrationNumber)
```
    Shows for New Zealand, Australian and UK organisations
    
    Parameters:
    
    registrationNumber - String
  - employerIdentificationNumber
```
public Organisation employerIdentificationNumber(String employerIdentificationNumber)
```
    Shown if set. US Only.
    
    Parameters:
    
    employerIdentificationNumber - String
    
    Returns:
    
    Organisation
  - getEmployerIdentificationNumber
```
public String getEmployerIdentificationNumber()
```
    Shown if set. US Only.
    
    Returns:
    
    employerIdentificationNumber
  - setEmployerIdentificationNumber
```
public void setEmployerIdentificationNumber(String employerIdentificationNumber)
```
    Shown if set. US Only.
    
    Parameters:
    
    employerIdentificationNumber - String
  - taxNumber
```
public Organisation taxNumber(String taxNumber)
```
    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).
    
    Parameters:
    
    taxNumber - String
    
    Returns:
    
    Organisation
  - 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)
```
    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).
    
    Parameters:
    
    taxNumber - String
  - financialYearEndDay
```
public Organisation financialYearEndDay(Integer financialYearEndDay)
```
    Calendar day e.g. 0-31
    
    Parameters:
    
    financialYearEndDay - Integer
    
    Returns:
    
    Organisation
  - getFinancialYearEndDay
```
public Integer getFinancialYearEndDay()
```
    Calendar day e.g. 0-31
    
    Returns:
    
    financialYearEndDay
  - setFinancialYearEndDay
```
public void setFinancialYearEndDay(Integer financialYearEndDay)
```
    Calendar day e.g. 0-31
    
    Parameters:
    
    financialYearEndDay - Integer
  - financialYearEndMonth
```
public Organisation financialYearEndMonth(Integer financialYearEndMonth)
```
    Calendar Month e.g. 1-12
    
    Parameters:
    
    financialYearEndMonth - Integer
    
    Returns:
    
    Organisation
  - getFinancialYearEndMonth
```
public Integer getFinancialYearEndMonth()
```
    Calendar Month e.g. 1-12
    
    Returns:
    
    financialYearEndMonth
  - setFinancialYearEndMonth
```
public void setFinancialYearEndMonth(Integer financialYearEndMonth)
```
    Calendar Month e.g. 1-12
    
    Parameters:
    
    financialYearEndMonth - Integer
  - salesTaxBasis
```
public Organisation salesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis)
```
    The accounting basis used for tax returns. See Sales Tax Basis
    
    Parameters:
    
    salesTaxBasis - SalesTaxBasisEnum
    
    Returns:
    
    Organisation
  - 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)
```
    The accounting basis used for tax returns. See Sales Tax Basis
    
    Parameters:
    
    salesTaxBasis - SalesTaxBasisEnum
  - salesTaxPeriod
```
public Organisation salesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod)
```
    The frequency with which tax returns are processed. See Sales Tax Period
    
    Parameters:
    
    salesTaxPeriod - SalesTaxPeriodEnum
    
    Returns:
    
    Organisation
  - 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)
```
    The frequency with which tax returns are processed. See Sales Tax Period
    
    Parameters:
    
    salesTaxPeriod - SalesTaxPeriodEnum
  - defaultSalesTax
```
public Organisation defaultSalesTax(String defaultSalesTax)
```
    The default for LineAmountTypes on sales transactions
    
    Parameters:
    
    defaultSalesTax - String
    
    Returns:
    
    Organisation
  - getDefaultSalesTax
```
public String getDefaultSalesTax()
```
    The default for LineAmountTypes on sales transactions
    
    Returns:
    
    defaultSalesTax
  - setDefaultSalesTax
```
public void setDefaultSalesTax(String defaultSalesTax)
```
    The default for LineAmountTypes on sales transactions
    
    Parameters:
    
    defaultSalesTax - String
  - defaultPurchasesTax
```
public Organisation defaultPurchasesTax(String defaultPurchasesTax)
```
    The default for LineAmountTypes on purchase transactions
    
    Parameters:
    
    defaultPurchasesTax - String
    
    Returns:
    
    Organisation
  - getDefaultPurchasesTax
```
public String getDefaultPurchasesTax()
```
    The default for LineAmountTypes on purchase transactions
    
    Returns:
    
    defaultPurchasesTax
  - setDefaultPurchasesTax
```
public void setDefaultPurchasesTax(String defaultPurchasesTax)
```
    The default for LineAmountTypes on purchase transactions
    
    Parameters:
    
    defaultPurchasesTax - String
  - periodLockDate
```
public Organisation periodLockDate(String periodLockDate)
```
    Shown if set. See lock dates
    
    Parameters:
    
    periodLockDate - String
    
    Returns:
    
    Organisation
  - getPeriodLockDate
```
public String getPeriodLockDate()
```
    Shown if set. See lock dates
    
    Returns:
    
    periodLockDate
  - getPeriodLockDateAsDate
```
public org.threeten.bp.LocalDate getPeriodLockDateAsDate()
```
    Shown if set. See lock dates
    
    Returns:
    
    LocalDate
  - setPeriodLockDate
```
public void setPeriodLockDate(String periodLockDate)
```
    Shown if set. See lock dates
    
    Parameters:
    
    periodLockDate - String
  - setPeriodLockDate
```
public void setPeriodLockDate(org.threeten.bp.LocalDate periodLockDate)
```
    Shown if set. See lock dates
    
    Parameters:
    
    periodLockDate - LocalDateTime
  - endOfYearLockDate
```
public Organisation endOfYearLockDate(String endOfYearLockDate)
```
    Shown if set. See lock dates
    
    Parameters:
    
    endOfYearLockDate - String
    
    Returns:
    
    Organisation
  - getEndOfYearLockDate
```
public String getEndOfYearLockDate()
```
    Shown if set. See lock dates
    
    Returns:
    
    endOfYearLockDate
  - getEndOfYearLockDateAsDate
```
public org.threeten.bp.LocalDate getEndOfYearLockDateAsDate()
```
    Shown if set. See lock dates
    
    Returns:
    
    LocalDate
  - setEndOfYearLockDate
```
public void setEndOfYearLockDate(String endOfYearLockDate)
```
    Shown if set. See lock dates
    
    Parameters:
    
    endOfYearLockDate - String
  - setEndOfYearLockDate
```
public void setEndOfYearLockDate(org.threeten.bp.LocalDate endOfYearLockDate)
```
    Shown if set. See lock dates
    
    Parameters:
    
    endOfYearLockDate - LocalDateTime
  - getCreatedDateUTC
```
public String getCreatedDateUTC()
```
    Timestamp when the organisation was created in Xero
    
    Returns:
    
    createdDateUTC
  - getCreatedDateUTCAsDate
```
public org.threeten.bp.OffsetDateTime getCreatedDateUTCAsDate()
```
    Timestamp when the organisation was created in Xero
    
    Returns:
    
    OffsetDateTime
  - timezone
```
public Organisation timezone(TimeZone timezone)
```
    timezone
    
    Parameters:
    
    timezone - TimeZone
    
    Returns:
    
    Organisation
  - getTimezone
```
public TimeZone getTimezone()
```
    Get timezone
    
    Returns:
    
    timezone
  - setTimezone
```
public void setTimezone(TimeZone timezone)
```
    timezone
    
    Parameters:
    
    timezone - TimeZone
  - organisationEntityType
```
public Organisation organisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType)
```
    Organisation Entity Type
    
    Parameters:
    
    organisationEntityType - OrganisationEntityTypeEnum
    
    Returns:
    
    Organisation
  - getOrganisationEntityType
```
public Organisation.OrganisationEntityTypeEnum getOrganisationEntityType()
```
    Organisation Entity Type
    
    Returns:
    
    organisationEntityType
  - setOrganisationEntityType
```
public void setOrganisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType)
```
    Organisation Entity Type
    
    Parameters:
    
    organisationEntityType - OrganisationEntityTypeEnum
  - shortCode
```
public Organisation shortCode(String shortCode)
```
    A unique identifier for the organisation. Potential uses.
    
    Parameters:
    
    shortCode - String
    
    Returns:
    
    Organisation
  - getShortCode
```
public String getShortCode()
```
    A unique identifier for the organisation. Potential uses.
    
    Returns:
    
    shortCode
  - setShortCode
```
public void setShortCode(String shortCode)
```
    A unique identifier for the organisation. Potential uses.
    
    Parameters:
    
    shortCode - String
  - propertyClass
```
public Organisation propertyClass(Organisation.PropertyClassEnum propertyClass)
```
    Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
    
    Parameters:
    
    propertyClass - PropertyClassEnum
    
    Returns:
    
    Organisation
  - 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)
```
    Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
    
    Parameters:
    
    propertyClass - PropertyClassEnum
  - edition
```
public Organisation edition(Organisation.EditionEnum edition)
```
    BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
    
    Parameters:
    
    edition - EditionEnum
    
    Returns:
    
    Organisation
  - 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)
```
    BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
    
    Parameters:
    
    edition - EditionEnum
  - lineOfBusiness
```
public Organisation lineOfBusiness(String lineOfBusiness)
```
    Description of business type as defined in Organisation settings
    
    Parameters:
    
    lineOfBusiness - String
    
    Returns:
    
    Organisation
  - getLineOfBusiness
```
public String getLineOfBusiness()
```
    Description of business type as defined in Organisation settings
    
    Returns:
    
    lineOfBusiness
  - setLineOfBusiness
```
public void setLineOfBusiness(String lineOfBusiness)
```
    Description of business type as defined in Organisation settings
    
    Parameters:
    
    lineOfBusiness - String
  - addresses
```
public Organisation addresses(List<AddressForOrganisation> addresses)
```
    Address details for organisation – see Addresses
    
    Parameters:
    
    addresses - List<AddressForOrganisation>
    
    Returns:
    
    Organisation
  - addAddressesItem
```
public Organisation addAddressesItem(AddressForOrganisation addressesItem)
```
    Address details for organisation – see Addresses
    
    Parameters:
    
    addressesItem - AddressForOrganisation
    
    Returns:
    
    Organisation
  - getAddresses
```
public List<AddressForOrganisation> getAddresses()
```
    Address details for organisation – see Addresses
    
    Returns:
    
    addresses
  - setAddresses
```
public void setAddresses(List<AddressForOrganisation> addresses)
```
    Address details for organisation – see Addresses
    
    Parameters:
    
    addresses - List<AddressForOrganisation>
  - phones
```
public Organisation phones(List<Phone> phones)
```
    Phones details for organisation – see Phones
    
    Parameters:
    
    phones - List<Phone>
    
    Returns:
    
    Organisation
  - addPhonesItem
```
public Organisation addPhonesItem(Phone phonesItem)
```
    Phones details for organisation – see Phones
    
    Parameters:
    
    phonesItem - Phone
    
    Returns:
    
    Organisation
  - getPhones
```
public List<Phone> getPhones()
```
    Phones details for organisation – see Phones
    
    Returns:
    
    phones
  - setPhones
```
public void setPhones(List<Phone> phones)
```
    Phones details for organisation – see Phones
    
    Parameters:
    
    phones - List<Phone>
  - externalLinks
```
public Organisation externalLinks(List<ExternalLink> externalLinks)
```
    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
    
    Parameters:
    
    externalLinks - List<ExternalLink>
    
    Returns:
    
    Organisation
  - addExternalLinksItem
```
public Organisation addExternalLinksItem(ExternalLink externalLinksItem)
```
    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
    
    Parameters:
    
    externalLinksItem - ExternalLink
    
    Returns:
    
    Organisation
  - 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)
```
    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
    
    Parameters:
    
    externalLinks - List<ExternalLink>
  - paymentTerms
```
public Organisation paymentTerms(PaymentTerm paymentTerms)
```
    paymentTerms
    
    Parameters:
    
    paymentTerms - PaymentTerm
    
    Returns:
    
    Organisation
  - getPaymentTerms
```
public PaymentTerm getPaymentTerms()
```
    Get paymentTerms
    
    Returns:
    
    paymentTerms
  - setPaymentTerms
```
public void setPaymentTerms(PaymentTerm paymentTerms)
```
    paymentTerms
    
    Parameters:
    
    paymentTerms - PaymentTerm
  - 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

Class Organisation

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Organisation

Method Detail

organisationID

getOrganisationID

setOrganisationID

apIKey

getApIKey

setApIKey

name

getName

setName

legalName

getLegalName

setLegalName

paysTax

getPaysTax

setPaysTax

version

getVersion

setVersion

organisationType

getOrganisationType

setOrganisationType

baseCurrency

getBaseCurrency

setBaseCurrency

countryCode

getCountryCode

setCountryCode

isDemoCompany

getIsDemoCompany

setIsDemoCompany

organisationStatus

getOrganisationStatus

setOrganisationStatus

registrationNumber

getRegistrationNumber

setRegistrationNumber

employerIdentificationNumber

getEmployerIdentificationNumber

setEmployerIdentificationNumber

taxNumber

getTaxNumber

setTaxNumber

financialYearEndDay

getFinancialYearEndDay

setFinancialYearEndDay

financialYearEndMonth

getFinancialYearEndMonth

setFinancialYearEndMonth

salesTaxBasis

getSalesTaxBasis

setSalesTaxBasis

salesTaxPeriod

getSalesTaxPeriod

setSalesTaxPeriod

defaultSalesTax

getDefaultSalesTax

setDefaultSalesTax

defaultPurchasesTax

getDefaultPurchasesTax

setDefaultPurchasesTax

periodLockDate

getPeriodLockDate

getPeriodLockDateAsDate

setPeriodLockDate

setPeriodLockDate

endOfYearLockDate

getEndOfYearLockDate

getEndOfYearLockDateAsDate

setEndOfYearLockDate

setEndOfYearLockDate

getCreatedDateUTC

getCreatedDateUTCAsDate