Organisation
Used to query general organization data in Xero, including company details, settings, and configurations.
Table Specific Information
The organization view allows you to SELECT organization data for a Xero organization.
SELECT
The Xero API allows extensive filtering and ordering. You can define WHERE and ORDER BY clauses in a query to filter and order the results using any non-line-item column.
Note: The Xero API does not support filtering on line items or journal lines.
Columns
| Name | Type | Description |
| ShortCode [KEY] | String | A unique identifier assigned to the organisation within Xero. This code is used to uniquely reference the organisation in Xero's system. |
| APIKey | String | A unique API key that facilitates Xero-to-Xero transactions. This key is used to authenticate and authorize communication between Xero organizations. |
| Name | String | The display name of the organisation as shown in the Xero interface. This is typically the official name used for identification. |
| LegalName | String | The legal name of the organisation, as it appears on official reports and documents. |
| PaysTax | Boolean | Indicates whether the organisation is registered with a local tax authority. If the value is 'true', the organisation is subject to tax regulations. |
| Version | String | The version of Xero used by the organisation. This is helpful for compatibility and support, as different versions may have different features. |
| BaseCurrency | String | The default currency used by the organisation in Xero. This currency is applied to all financial transactions unless otherwise specified. |
| CountryCode | String | The country code associated with the organisation. This is typically a two-letter ISO country code (for example, 'US', 'NZ', and 'GB'). |
| IsDemoCompany | String | Indicates whether the organisation is a demo company. 'True' means the organisation is a demo for testing, training, or evaluation purposes. |
| OrganisationStatus | String | The status of the organisation within Xero. It is set to 'ACTIVE' if you can connect to the organisation via the Xero API, otherwise, it will reflect other statuses like 'INACTIVE' or 'ARCHIVED'. |
| RegistrationNumber | String | The registration number for the organisation, applicable for NZ, AU, and UK organisations. This is a legal identifier used for tax and compliance purposes. |
| TaxNumber | String | The tax identification number of the organisation, such as 'ABN' (Australia), 'GST number' (New Zealand), 'VAT number' (UK), or equivalent based on the country. |
| FinancialYearEndDay | String | The day of the year on which the organisation's financial year ends. For example, '31' represents the last day of the year. |
| FinancialYearEndMonth | String | The month of the year on which the organisation's financial year ends. For example, '12' represents December. |
| PeriodLockDate | Date | The date when the organisation locks the period for accounting purposes. This prevents changes to financial data after this date. |
| EndOfYearLockDate | Date | The date when the organisation locks the end of the financial year, preventing modifications to financial data for the completed year. |
| CreatedDateUTC | Datetime | The timestamp indicating when the organisation was created in Xero. This helps track when the organisation was set up in the system. |
| UpdatedDateUTC | Datetime | The timestamp indicating when the organisation details were last updated. This helps track changes to the organisation's data. |
| OrganisationEntityType | String | The entity type of the organisation. Common entity types include 'COMPANY' and 'SOLEPROPRIETOR', and indicate the legal structure of the business. |
| Timezone | String | The time zone for the organisation, specified in IANA time zone format (for example, 'America/New_York' and 'Europe/London'). |
| Edition | String | The edition of Xero used by the organisation. Possible values are 'BUSINESS' for standard Xero users and 'PARTNER' for users with restricted functionality in the Xero partner program. |
| Class | String | The subscription class of the organisation, such as 'DEMO', 'TRIAL', 'STARTER', 'STANDARD', 'PREMIUM', or specific premium tiers like 'PREMIUM_20', 'PREMIUM_50' It defines the plan or tier the organisation is subscribed to. |
| LineOfBusiness | String | A description of the business type or industry of the organisation. This provides insight into the nature of the organisation's operations. |
| Street_AddressLine1 | String | The first line of the street address for the organisation's physical location. |
| Street_AddressLine2 | String | The second line of the street address for the organisation's physical location. |
| Street_AddressLine3 | String | The third line of the street address for the organisation's physical location. |
| Street_AddressLine4 | String | The fourth line of the street address for the organisation's physical location. |
| Street_City | String | The city in which the organisation is located. |
| Street_PostalCode | String | The postal code for the organisation's physical location. |
| Street_Country | String | The country in which the organisation is located, specified by its full name (for example, 'United States' or 'New Zealand'). |
| Street_Region | String | The region or state in which the organisation is located. |
| Street_AttentionTo | String | An attention-to line for the street address, used for specific recipients or departments. |
| POBox_AddressLine1 | String | The first line of the PO box address for the organisation. |
| POBox_AddressLine2 | String | The second line of the PO box address for the organisation. |
| POBox_AddressLine3 | String | The third line of the PO box address for the organisation. |
| POBox_AddressLine4 | String | The fourth line of the PO box address for the organisation. |
| POBox_City | String | The city for the PO box address. |
| POBox_PostalCode | String | The postal code for the PO box address. |
| POBox_Country | String | The country for the PO box address. |
| POBox_Region | String | The region or state for the PO box address. |
| POBox_AttentionTo | String | An attention-to line for the PO box address, used for specific recipients or departments. |
| DDI_PhoneNumber | String | The direct dial-in (DDI) phone number of the organisation, without area or country code. |
| DDI_PhoneAreaCode | String | The area code for the organisation's DDI phone number. |
| DDI_PhoneCountryCode | String | The country code for the organisation's DDI phone number. |
| Default_PhoneNumber | String | The default phone number for the organisation, without area or country code. |
| Default_PhoneAreaCode | String | The area code for the organisation's default phone number. |
| Default_PhoneCountryCode | String | The country code for the organisation's default phone number. |
| Fax_PhoneNumber | String | The fax phone number for the organisation, without area or country code. |
| Fax_PhoneAreaCode | String | The area code for the organisation's fax phone number. |
| Fax_PhoneCountryCode | String | The country code for the organisation's fax phone number. |
| Mobile_PhoneNumber | String | The mobile phone number for the organisation, without area or country code. |
| Mobile_PhoneAreaCode | String | The area code for the organisation's mobile phone number. |
| Mobile_PhoneCountryCode | String | The country code for the organisation's mobile phone number. |
| Facebook_URL | String | The URL to the organisation's Facebook page, providing direct access to its social media profile. |
| Twitter_URL | String | The URL to the organisation's Twitter page, providing direct access to its social media profile. |
| GooglePlus_URL | String | The URL to the organisation's Google Plus page, providing direct access to its social media profile. |
| LinkedIn_URL | String | The URL to the organisation's LinkedIn page, providing direct access to its professional networking profile. |
| Website_URL | String | The URL to the organisation's official website, providing direct access to more information about the organisation. |
| PaymentTerms_Bills_Day | String | The default number of days for payment terms on bills. This value determines how many days after the invoice date the payment is due. |
| PaymentTerms_Bills_Type | String | The default payment terms for bills. The type specifies whether the payment terms are based on a certain number of days, weeks, or other units. |
| PaymentTerms_Sales_Day | String | The default number of days for payment terms on sales invoices. This value determines how many days after the invoice date the payment is due. |
| PaymentTerms_Sales_Type | String | The default payment terms for sales invoices. The type specifies whether the payment terms are based on a certain number of days, weeks, or other units. |
| TenantId | String | The unique identifier of the tenant. This ensures that queries are scoped correctly, particularly in multi-tenant environments where data must be isolated for different organisations. |