Package com.xero.models.accounting
Class Organisation
java.lang.Object
com.xero.models.accounting.Organisation
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumBUSINESS or PARTNER.static enumOrganisation Entity Typestatic enumOrganisation Typestatic enumOrganisation Classes describe which plan the Xero organisation is on (e.g.static enumThe accounting basis used for tax returns.static enumThe frequency with which tax returns are processed.static enumSee Version Types -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAddressesItem(AddressForOrganisation addressesItem) Address details for organisation – see AddressesaddExternalLinksItem(ExternalLink externalLinksItem) Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.addPhonesItem(Phone phonesItem) Phones details for organisation – see Phonesaddresses(List<AddressForOrganisation> addresses) Address details for organisation – see AddressesDisplay a unique key used for Xero-to-Xero transactionsbaseCurrency(CurrencyCode baseCurrency) baseCurrencycountryCode(CountryCode countryCode) countryCodedefaultPurchasesTax(String defaultPurchasesTax) The default for LineAmountTypes on purchase transactionsdefaultSalesTax(String defaultSalesTax) The default for LineAmountTypes on sales transactionsedition(Organisation.EditionEnum edition) BUSINESS or PARTNER.employerIdentificationNumber(String employerIdentificationNumber) Shown if set.endOfYearLockDate(String endOfYearLockDate) Shown if set.booleanexternalLinks(List<ExternalLink> externalLinks) Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.financialYearEndDay(Integer financialYearEndDay) Calendar day e.g.financialYearEndMonth(Integer financialYearEndMonth) Calendar Month e.g.Address details for organisation – see AddressesDisplay a unique key used for Xero-to-Xero transactionsGet baseCurrencyGet countryCodeTimestamp when the organisation was created in Xeroorg.threeten.bp.OffsetDateTimeTimestamp when the organisation was created in XeroThe default for LineAmountTypes on purchase transactionsThe default for LineAmountTypes on sales transactionsBUSINESS or PARTNER.Shown if set.Shown if set.org.threeten.bp.LocalDateShown if set.Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.Calendar day e.g.Calendar Month e.g.Boolean to describe if organisation is a demo company.Organisation name shown on ReportsDescription of business type as defined in Organisation settingsgetName()Display name of organisation shown in XeroOrganisation Entity TypeUnique Xero identifierWill be set to ACTIVE if you can connect to organisation via the Xero APIOrganisation TypeGet paymentTermsBoolean to describe if organisation is registered with a local tax authority i.e.Shown if set.org.threeten.bp.LocalDateShown if set.Phones details for organisation – see PhonesOrganisation Classes describe which plan the Xero organisation is on (e.g.Shows for New Zealand, Australian and UK organisationsThe accounting basis used for tax returns.The frequency with which tax returns are processed.A unique identifier for the organisation.Shown if set.Get timezoneSee Version TypesinthashCode()isDemoCompany(Boolean isDemoCompany) Boolean to describe if organisation is a demo company.Organisation name shown on ReportslineOfBusiness(String lineOfBusiness) Description of business type as defined in Organisation settingsDisplay name of organisation shown in XeroorganisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType) Organisation Entity TypeorganisationID(UUID organisationID) Unique Xero identifierorganisationStatus(String organisationStatus) Will be set to ACTIVE if you can connect to organisation via the Xero APIorganisationType(Organisation.OrganisationTypeEnum organisationType) Organisation TypepaymentTerms(PaymentTerm paymentTerms) paymentTermsBoolean to describe if organisation is registered with a local tax authority i.e.periodLockDate(String periodLockDate) Shown if set.Phones details for organisation – see PhonespropertyClass(Organisation.PropertyClassEnum propertyClass) Organisation Classes describe which plan the Xero organisation is on (e.g.registrationNumber(String registrationNumber) Shows for New Zealand, Australian and UK organisationssalesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis) The accounting basis used for tax returns.salesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod) The frequency with which tax returns are processed.voidsetAddresses(List<AddressForOrganisation> addresses) Address details for organisation – see AddressesvoidDisplay a unique key used for Xero-to-Xero transactionsvoidsetBaseCurrency(CurrencyCode baseCurrency) baseCurrencyvoidsetCountryCode(CountryCode countryCode) countryCodevoidsetDefaultPurchasesTax(String defaultPurchasesTax) The default for LineAmountTypes on purchase transactionsvoidsetDefaultSalesTax(String defaultSalesTax) The default for LineAmountTypes on sales transactionsvoidsetEdition(Organisation.EditionEnum edition) BUSINESS or PARTNER.voidsetEmployerIdentificationNumber(String employerIdentificationNumber) Shown if set.voidsetEndOfYearLockDate(String endOfYearLockDate) Shown if set.voidsetEndOfYearLockDate(org.threeten.bp.LocalDate endOfYearLockDate) Shown if set.voidsetExternalLinks(List<ExternalLink> externalLinks) Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn.voidsetFinancialYearEndDay(Integer financialYearEndDay) Calendar day e.g.voidsetFinancialYearEndMonth(Integer financialYearEndMonth) Calendar Month e.g.voidsetIsDemoCompany(Boolean isDemoCompany) Boolean to describe if organisation is a demo company.voidsetLegalName(String legalName) Organisation name shown on ReportsvoidsetLineOfBusiness(String lineOfBusiness) Description of business type as defined in Organisation settingsvoidDisplay name of organisation shown in XerovoidsetOrganisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType) Organisation Entity TypevoidsetOrganisationID(UUID organisationID) Unique Xero identifiervoidsetOrganisationStatus(String organisationStatus) Will be set to ACTIVE if you can connect to organisation via the Xero APIvoidsetOrganisationType(Organisation.OrganisationTypeEnum organisationType) Organisation TypevoidsetPaymentTerms(PaymentTerm paymentTerms) paymentTermsvoidsetPaysTax(Boolean paysTax) Boolean to describe if organisation is registered with a local tax authority i.e.voidsetPeriodLockDate(String periodLockDate) Shown if set.voidsetPeriodLockDate(org.threeten.bp.LocalDate periodLockDate) Shown if set.voidPhones details for organisation – see PhonesvoidsetPropertyClass(Organisation.PropertyClassEnum propertyClass) Organisation Classes describe which plan the Xero organisation is on (e.g.voidsetRegistrationNumber(String registrationNumber) Shows for New Zealand, Australian and UK organisationsvoidsetSalesTaxBasis(Organisation.SalesTaxBasisEnum salesTaxBasis) The accounting basis used for tax returns.voidsetSalesTaxPeriod(Organisation.SalesTaxPeriodEnum salesTaxPeriod) The frequency with which tax returns are processed.voidsetShortCode(String shortCode) A unique identifier for the organisation.voidsetTaxNumber(String taxNumber) Shown if set.voidsetTimezone(TimeZone timezone) timezonevoidsetVersion(Organisation.VersionEnum version) See Version TypesA unique identifier for the organisation.Shown if set.timezonetoString()version(Organisation.VersionEnum version) See Version Types
-
Constructor Details
-
Organisation
public Organisation()
-
-
Method Details
-
organisationID
Unique Xero identifier- Parameters:
organisationID- UUID- Returns:
- Organisation
-
getOrganisationID
-
setOrganisationID
Unique Xero identifier- Parameters:
organisationID- UUID
-
apIKey
Display a unique key used for Xero-to-Xero transactions- Parameters:
apIKey- String- Returns:
- Organisation
-
getApIKey
-
setApIKey
Display a unique key used for Xero-to-Xero transactions- Parameters:
apIKey- String
-
name
Display name of organisation shown in Xero- Parameters:
name- String- Returns:
- Organisation
-
getName
-
setName
Display name of organisation shown in Xero- Parameters:
name- String
-
legalName
Organisation name shown on Reports- Parameters:
legalName- String- Returns:
- Organisation
-
getLegalName
-
setLegalName
Organisation name shown on Reports- Parameters:
legalName- String
-
paysTax
Boolean to describe if organisation is registered with a local tax authority i.e. true, false- Parameters:
paysTax- Boolean- Returns:
- Organisation
-
getPaysTax
Boolean to describe if organisation is registered with a local tax authority i.e. true, false- Returns:
- paysTax
-
setPaysTax
Boolean to describe if organisation is registered with a local tax authority i.e. true, false- Parameters:
paysTax- Boolean
-
version
See Version Types- Parameters:
version- VersionEnum- Returns:
- Organisation
-
getVersion
-
setVersion
See Version Types- Parameters:
version- VersionEnum
-
organisationType
Organisation Type- Parameters:
organisationType- OrganisationTypeEnum- Returns:
- Organisation
-
getOrganisationType
Organisation Type- Returns:
- organisationType
-
setOrganisationType
Organisation Type- Parameters:
organisationType- OrganisationTypeEnum
-
baseCurrency
baseCurrency- Parameters:
baseCurrency- CurrencyCode- Returns:
- Organisation
-
getBaseCurrency
-
setBaseCurrency
baseCurrency- Parameters:
baseCurrency- CurrencyCode
-
countryCode
countryCode- Parameters:
countryCode- CountryCode- Returns:
- Organisation
-
getCountryCode
-
setCountryCode
countryCode- Parameters:
countryCode- CountryCode
-
isDemoCompany
Boolean to describe if organisation is a demo company.- Parameters:
isDemoCompany- Boolean- Returns:
- Organisation
-
getIsDemoCompany
Boolean to describe if organisation is a demo company.- Returns:
- isDemoCompany
-
setIsDemoCompany
Boolean to describe if organisation is a demo company.- Parameters:
isDemoCompany- Boolean
-
organisationStatus
Will be set to ACTIVE if you can connect to organisation via the Xero API- Parameters:
organisationStatus- String- Returns:
- Organisation
-
getOrganisationStatus
Will be set to ACTIVE if you can connect to organisation via the Xero API- Returns:
- organisationStatus
-
setOrganisationStatus
Will be set to ACTIVE if you can connect to organisation via the Xero API- Parameters:
organisationStatus- String
-
registrationNumber
Shows for New Zealand, Australian and UK organisations- Parameters:
registrationNumber- String- Returns:
- Organisation
-
getRegistrationNumber
Shows for New Zealand, Australian and UK organisations- Returns:
- registrationNumber
-
setRegistrationNumber
Shows for New Zealand, Australian and UK organisations- Parameters:
registrationNumber- String
-
employerIdentificationNumber
Shown if set. US Only.- Parameters:
employerIdentificationNumber- String- Returns:
- Organisation
-
getEmployerIdentificationNumber
Shown if set. US Only.- Returns:
- employerIdentificationNumber
-
setEmployerIdentificationNumber
Shown if set. US Only.- Parameters:
employerIdentificationNumber- 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
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
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
Calendar day e.g. 0-31- Parameters:
financialYearEndDay- Integer- Returns:
- Organisation
-
getFinancialYearEndDay
-
setFinancialYearEndDay
Calendar day e.g. 0-31- Parameters:
financialYearEndDay- Integer
-
financialYearEndMonth
Calendar Month e.g. 1-12- Parameters:
financialYearEndMonth- Integer- Returns:
- Organisation
-
getFinancialYearEndMonth
-
setFinancialYearEndMonth
Calendar Month e.g. 1-12- Parameters:
financialYearEndMonth- Integer
-
salesTaxBasis
The accounting basis used for tax returns. See Sales Tax Basis- Parameters:
salesTaxBasis- SalesTaxBasisEnum- Returns:
- Organisation
-
getSalesTaxBasis
The accounting basis used for tax returns. See Sales Tax Basis- Returns:
- salesTaxBasis
-
setSalesTaxBasis
The accounting basis used for tax returns. See Sales Tax Basis- Parameters:
salesTaxBasis- SalesTaxBasisEnum
-
salesTaxPeriod
The frequency with which tax returns are processed. See Sales Tax Period- Parameters:
salesTaxPeriod- SalesTaxPeriodEnum- Returns:
- Organisation
-
getSalesTaxPeriod
The frequency with which tax returns are processed. See Sales Tax Period- Returns:
- salesTaxPeriod
-
setSalesTaxPeriod
The frequency with which tax returns are processed. See Sales Tax Period- Parameters:
salesTaxPeriod- SalesTaxPeriodEnum
-
defaultSalesTax
The default for LineAmountTypes on sales transactions- Parameters:
defaultSalesTax- String- Returns:
- Organisation
-
getDefaultSalesTax
The default for LineAmountTypes on sales transactions- Returns:
- defaultSalesTax
-
setDefaultSalesTax
The default for LineAmountTypes on sales transactions- Parameters:
defaultSalesTax- String
-
defaultPurchasesTax
The default for LineAmountTypes on purchase transactions- Parameters:
defaultPurchasesTax- String- Returns:
- Organisation
-
getDefaultPurchasesTax
The default for LineAmountTypes on purchase transactions- Returns:
- defaultPurchasesTax
-
setDefaultPurchasesTax
The default for LineAmountTypes on purchase transactions- Parameters:
defaultPurchasesTax- String
-
periodLockDate
Shown if set. See lock dates- Parameters:
periodLockDate- String- Returns:
- Organisation
-
getPeriodLockDate
-
getPeriodLockDateAsDate
public org.threeten.bp.LocalDate getPeriodLockDateAsDate()Shown if set. See lock dates- Returns:
- LocalDate
-
setPeriodLockDate
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
Shown if set. See lock dates- Parameters:
endOfYearLockDate- String- Returns:
- Organisation
-
getEndOfYearLockDate
-
getEndOfYearLockDateAsDate
public org.threeten.bp.LocalDate getEndOfYearLockDateAsDate()Shown if set. See lock dates- Returns:
- LocalDate
-
setEndOfYearLockDate
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
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
timezone- Parameters:
timezone- TimeZone- Returns:
- Organisation
-
getTimezone
-
setTimezone
-
organisationEntityType
public Organisation organisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType) Organisation Entity Type- Parameters:
organisationEntityType- OrganisationEntityTypeEnum- Returns:
- Organisation
-
getOrganisationEntityType
Organisation Entity Type- Returns:
- organisationEntityType
-
setOrganisationEntityType
public void setOrganisationEntityType(Organisation.OrganisationEntityTypeEnum organisationEntityType) Organisation Entity Type- Parameters:
organisationEntityType- OrganisationEntityTypeEnum
-
shortCode
A unique identifier for the organisation. Potential uses.- Parameters:
shortCode- String- Returns:
- Organisation
-
getShortCode
A unique identifier for the organisation. Potential uses.- Returns:
- shortCode
-
setShortCode
A unique identifier for the organisation. Potential uses.- Parameters:
shortCode- String
-
propertyClass
Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)- Parameters:
propertyClass- PropertyClassEnum- Returns:
- Organisation
-
getPropertyClass
Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)- Returns:
- propertyClass
-
setPropertyClass
Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)- Parameters:
propertyClass- PropertyClassEnum
-
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
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
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
Description of business type as defined in Organisation settings- Parameters:
lineOfBusiness- String- Returns:
- Organisation
-
getLineOfBusiness
Description of business type as defined in Organisation settings- Returns:
- lineOfBusiness
-
setLineOfBusiness
Description of business type as defined in Organisation settings- Parameters:
lineOfBusiness- String
-
addresses
Address details for organisation – see Addresses- Parameters:
addresses- List<AddressForOrganisation>- Returns:
- Organisation
-
addAddressesItem
Address details for organisation – see Addresses- Parameters:
addressesItem- AddressForOrganisation- Returns:
- Organisation
-
getAddresses
Address details for organisation – see Addresses- Returns:
- addresses
-
setAddresses
Address details for organisation – see Addresses- Parameters:
addresses- List<AddressForOrganisation>
-
phones
Phones details for organisation – see Phones- Parameters:
phones- List<Phone>- Returns:
- Organisation
-
addPhonesItem
Phones details for organisation – see Phones- Parameters:
phonesItem- Phone- Returns:
- Organisation
-
getPhones
-
setPhones
-
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
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
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
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
paymentTerms- Parameters:
paymentTerms- PaymentTerm- Returns:
- Organisation
-
getPaymentTerms
-
setPaymentTerms
paymentTerms- Parameters:
paymentTerms- PaymentTerm
-
equals
-
hashCode
-
toString
-