Organisation


Overview

URL https://api.xero.com/api.xro/2.0/Organisation
Methods Supported GET
Description Returns information about a Xero 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
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 Will be set to ACTIVE if you can connect to organisation via the Xero API
RegistrationNumber shows for New Zealand, Australian and UK organisations
TaxNumber shown if set
FinancialYearEndDay Calendar day e.g. 0-31
FinancialYearEndMonth Calendar Month e.g. 1-12
PeriodLockDate shown if set. See lock dates
EndOfYearLockDate shown if set. See lock dates
CreatedDateUTC Timestamp when the organisation was created in Xero
OrganisationEntityType Organisation Type
Timezone Timzone specifications
ShortCode A unique identifier for the organisation. Potential uses.
LineOfBusiness Description of business type as defined in Organisation settings
Addresses Address details for organisation – see Addresses
Phones Phones details for organisation – see Phones
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
PaymentTerms Default payment terms for the organisation if set – See Payment Terms below

Elements for PaymentTerms

Bills Default payment terms for bills (accounts payable)
Sales Default payment terms for sales invoices(accounts receivable)

Elements for ExternalLinks

LinkType See External link types
URL URL for service e.g. http://twitter.com/xeroapi

Elements for Bills and Sales

Day Day of Month (0-31)
Type One of the following values OFFOLLOWINGMONTH/DAYSAFTERBILLDATE/OFCURRENTMONTH

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/Xero.Accounting</Url>
        </ExternalLink>
        <ExternalLink>
          <LinkType>Twitter</LinkType>
          <Url>http://twitter.com/xeroapi</Url>
        </ExternalLink>
        <ExternalLink>
          <LinkType>GooglePlus</LinkType>
          <Url>https://plus.google.com/u/0/105727595143346068928/</Url>
        </ExternalLink>
        <ExternalLink>
          <LinkType>LinkedIn</LinkType>
          <Url>http://www.linkedin.com/company/xero</Url>
        </ExternalLink>
      </ExternalLinks>
      <PaymentTerms>
        <Bills>
          <Day>5</Day>
          <Type>OFCURRENTMONTH</Type>
        </Bills>
        <Sales>
          <Day>20</Day>
          <Type>OFFOLLOWINGMONTH</Type>
        </Sales>
      </PaymentTerms>
    </Organisation>
  </Organisations>