com.xero.models.accounting

Class Organisation

java.lang.Object

com.xero.models.accounting.Organisation

public class Organisation
extends Object

Organisation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Organisation.EditionEnum BUSINESS or PARTNER.
static class	Organisation.OrganisationEntityTypeEnum Organisation 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 and Description
Organisation()

Method Summary

Modifier and Type	Method and Description
Organisation	addAddressesItem(Address addressesItem)
Organisation	addExternalLinksItem(ExternalLink externalLinksItem)
Organisation	addPhonesItem(Phone phonesItem)
Organisation	addresses(List<Address> addresses)
Organisation	apIKey(String apIKey)
Organisation	baseCurrency(CurrencyCode baseCurrency)
Organisation	countryCode(CountryCode countryCode)
Organisation	createdDateUTC(org.threeten.bp.OffsetDateTime createdDateUTC)
Organisation	defaultPurchasesTax(String defaultPurchasesTax)
Organisation	defaultSalesTax(String defaultSalesTax)
Organisation	edition(Organisation.EditionEnum edition)
Organisation	endOfYearLockDate(org.threeten.bp.LocalDate endOfYearLockDate)
boolean	equals(Object o)
Organisation	externalLinks(List<ExternalLink> externalLinks)
Organisation	financialYearEndDay(Integer financialYearEndDay)
Organisation	financialYearEndMonth(Integer financialYearEndMonth)
List<Address>	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
org.threeten.bp.OffsetDateTime	getCreatedDateUTC() 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.
org.threeten.bp.LocalDate	getEndOfYearLockDate() 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 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.
org.threeten.bp.LocalDate	getPeriodLockDate() 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)
Organisation	legalName(String legalName)
Organisation	lineOfBusiness(String lineOfBusiness)
Organisation	name(String name)
Organisation	organisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType)
Organisation	organisationID(UUID organisationID)
Organisation	organisationStatus(String organisationStatus)
Organisation	organisationType(Organisation.OrganisationTypeEnum organisationType)
Organisation	paymentTerms(PaymentTerm paymentTerms)
Organisation	paysTax(Boolean paysTax)
Organisation	periodLockDate(org.threeten.bp.LocalDate periodLockDate)
Organisation	phones(List<Phone> phones)
Organisation	propertyClass(Organisation.PropertyClassEnum propertyClass)
Organisation	registrationNumber(String registrationNumber)
Organisation	salesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis)
Organisation	salesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod)
void	setAddresses(List<Address> addresses)
void	setApIKey(String apIKey)
void	setBaseCurrency(CurrencyCode baseCurrency)
void	setCountryCode(CountryCode countryCode)
void	setCreatedDateUTC(org.threeten.bp.OffsetDateTime createdDateUTC)
void	setDefaultPurchasesTax(String defaultPurchasesTax)
void	setDefaultSalesTax(String defaultSalesTax)
void	setEdition(Organisation.EditionEnum edition)
void	setEndOfYearLockDate(org.threeten.bp.LocalDate endOfYearLockDate)
void	setExternalLinks(List<ExternalLink> externalLinks)
void	setFinancialYearEndDay(Integer financialYearEndDay)
void	setFinancialYearEndMonth(Integer financialYearEndMonth)
void	setIsDemoCompany(Boolean isDemoCompany)
void	setLegalName(String legalName)
void	setLineOfBusiness(String lineOfBusiness)
void	setName(String name)
void	setOrganisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType)
void	setOrganisationID(UUID organisationID)
void	setOrganisationStatus(String organisationStatus)
void	setOrganisationType(Organisation.OrganisationTypeEnum organisationType)
void	setPaymentTerms(PaymentTerm paymentTerms)
void	setPaysTax(Boolean paysTax)
void	setPeriodLockDate(org.threeten.bp.LocalDate periodLockDate)
void	setPhones(List<Phone> phones)
void	setPropertyClass(Organisation.PropertyClassEnum propertyClass)
void	setRegistrationNumber(String registrationNumber)
void	setSalesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis)
void	setSalesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod)
void	setShortCode(String shortCode)
void	setTaxNumber(String taxNumber)
void	setTimezone(TimeZone timezone)
void	setVersion(Organisation.VersionEnum version)
Organisation	shortCode(String shortCode)
Organisation	taxNumber(String taxNumber)
Organisation	timezone(TimeZone timezone)
String	toString()
Organisation	version(Organisation.VersionEnum version)

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)

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)

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(org.threeten.bp.LocalDate periodLockDate)

getPeriodLockDate

public org.threeten.bp.LocalDate getPeriodLockDate()

Shown if set. See lock dates

Returns:

periodLockDate

setPeriodLockDate

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

endOfYearLockDate

public Organisation endOfYearLockDate(org.threeten.bp.LocalDate endOfYearLockDate)

getEndOfYearLockDate

public org.threeten.bp.LocalDate getEndOfYearLockDate()

Shown if set. See lock dates

Returns:

endOfYearLockDate

setEndOfYearLockDate

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

createdDateUTC

public Organisation createdDateUTC(org.threeten.bp.OffsetDateTime createdDateUTC)

getCreatedDateUTC

public org.threeten.bp.OffsetDateTime getCreatedDateUTC()

Timestamp when the organisation was created in Xero

Returns:

createdDateUTC

setCreatedDateUTC

public void setCreatedDateUTC(org.threeten.bp.OffsetDateTime createdDateUTC)

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