The following elements are tracked in the Organisation endpoint:
Field | Information |
---|---|
API Key | Display a unique key used for Xero-to-Xero transactions |
Name | Display name of organisation shown in Xero |
Legal Name | Organisation name shown on Reports |
Pays Tax | Describes if organisation is registered with a local tax authority i.e. true, false |
Version | AU, NZ, GLOBAL, UK or US |
Organisation Type | Organisation type |
Base Currency | Default currency for organisation in ISO 4217 format |
Country Code | Country code for organisation in ISO 3166-2 format |
Is Demo Company | Indicates if organisation is a demo company |
Organisation Status | Will be set to ACTIVE if you can connect to organisation via the Xero API |
Registration Number | Shows for New Zealand, Australian and UK organisations |
Employer Identification Number | Shown if set, US Only |
Tax Number | Shown if set. Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global). |
Financial Year End Day | Calendar day e.g. 0-31 |
Financial Year End Month | Calendar month e.g. 1-12 |
Sales Tax Basis | The accounting basis used for tax returns |
Sales Tax Period | The frequency with which tax returns are processed |
Default Sales Tax | The default for Line Amount Types on sales transactions |
Default Purchases Tax | The default for Line Amount Types on purchase transactions |
Period Lock Date | Shown if set |
End Of Year Lock Date | Shown if set |
Created Date UTC | Timestamp when the organisation was created in Xero |
Timezone | Timezone specifications |
Organisation Entity Type | Organisation type |
Short Code | A unique identifier for the organisation |
Organisation ID | The Xero generated unique identifier for the organisation |
Edition | BUSINESS or PARTNER |
Class | Organisation classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM) |
Line Of Business | Description of business type as defined in Organisation settings |
Addresses | Address details for organisation |
Phones | Phones details for organisation |
External Links | Organisation profile links for popular services such as Facebook, Twitter, GooglePlus and LinkedIn |
Payment Terms | Default payment terms for the organisation if set |