Skip to content
Beautiful accounting software


Organisation

URL https://api.xero.com/api.xro/2.0/Organisation
Methods Supported GET
Description Returns information about a Xero organisation

Optional parameters for GET Organisation

Response elements returned for GET Organisation

APIKey Display a unique key used for Xero-to-Xero transactions
Name Display name of organisation shown in Xero
LegalName Organisation name shown on Reports
PaysTax Boolean to describe if organisation is registered with a local tax authority i.e. true, false
Version See Version Types
OrganisationType See Organisation Types
BaseCurrency Default currency for organisation. See ISO 4217 Currency Codes
CountryCode Country code for organisation. See ISO 3166-2 Country Codes
IsDemoCompany Boolean to describe if organisation is a demo company.
OrganisationStatus
TaxNumber shown if set
FinancialYearEndDay
FinancialYearEndMonth
PeriodLockDate shown if set
EndOfYearLockDate shown if set
RegistrationNumber shows for Australian and UK organisations
Addresses Address details for organisation – see Addresses
ShortCode A unique identifier for the organisation
CreatedDateUTC  

Example response for GET Organisation

  <Organisations>
    <Organisation>
      <APIKey>PV1PS57LYQ7VDJYTGCUI99A6YJI1WZ</APIKey>
      <Name>Demo Company (NZ)</Name>
      <LegalName>Demo Company (NZ)</LegalName>
      <PaysTax>true</PaysTax>
      <Version>NZ</Version>
      <OrganisationType>COMPANY</OrganisationType>
      <BaseCurrency>NZD</BaseCurrency>
      <CountryCode>NZ</CountryCode>
      <IsDemoCompany>true</IsDemoCompany>
      <OrganisationStatus>ACTIVE</OrganisationStatus>
      <TaxNumber>101-2-303</TaxNumber>
      <FinancialYearEndDay>31</FinancialYearEndDay>
      <FinancialYearEndMonth>3</FinancialYearEndMonth>
      <PeriodLockDate>2009-09-30T00:00:00</PeriodLockDate>
      <CreatedDateUTC>2012-02-19T18:31:02.66</CreatedDateUTC>
      <OrganisationEntityType>COMPANY</OrganisationEntityType>
      <Timezone>NEWZEALANDSTANDARDTIME</Timezone>
      <ShortCode>!23eYt</ShortCode>
      <Addresses>
      <Address>
          <AddressType>POBOX</AddressType>
              <AddressLine1>3 Market Place</AddressLine1>
              <AddressLine2>Twizel 7901</AddressLine2>
              <City>Twizel</City>
              <PostalCode>7901</PostalCode>
              <Country>New Zealand</Country>
              <AttentionTo>Bentley Rhythm Ace</AttentionTo>
          </Address>
      </Addresses>
      <ExternalLinks>
          <ExternalLink>
           <LinkType>Facebook</LinkType>
           <Url>http://facebook.com/XeroDemoOrg>/Url>
          </ExternalLink>
      </ExternalLinks>
    </Organisation>
  </Organisations>