Xero Accounting Endpoint: Organisation
Jump to navigation
Jump to search
Overview
The Xero Organisation endpoint allows you to access various information about your Xero organisation / data file.
Fields
The following fields are available for the Organisation endpoint.
- OrganisationID
- A GUID field representing the internal id of the organisation.
- This field does not link to other endpoints.
- Name
- A text field that provides the name of the xero organisation.
- LegalName
- A text field that provides the legal name of the xero organisation.
- OrganisationType
- A text field that indicates the type of organisation.
- Possible values are:
- ACCOUNTING_PRACTICE
- CHARITY
- CLUB_OR_SOCIETY
- COMPANY
- LOOK_THROUGH_COMPANY
- NOT_FOR_PROFIT
- PARTNERSHIP
- S_CORPORATION
- SELF_MANAGED_SUPERANNUATION_FUND
- SOLE_TRADER
- SUPERANNUATION_FUND
- TRUST
- OrganisationEntityType
- A text field that indicates the type of organisation. Similar to OrganisationType.
- OrganisationStatus
- A text field that indicates the status of organisation.
- This should always be set to ACTIVE.
- LineOfBusiness
- A text field that indicates the type of business as chosen within the organisation settings screen.
- CountryCode
- A text field that provides the country code of the organisation.
- BaseCurrency
- A text field that provides the native currency code of the organisation.
- Timezone
- A text field that provides the timezone for the organisation.
- ShortCode
- A text field that provides a unique identifier for the organisation.
- This would commonly be used for deep-linking to other systems.
- TaxNumber
- A text field that provides the tax number of the organisation (ABN, TFN, etc.)
- PaysTax
- A true/false value that indicates if the organisation pays tax or not.
- Addresses
- A table field that provides one or more address for the organisation.
- Phones
- A table field that provides one or more phone number for the organisation.
- Version
- A text field that provides the version of Xero running for this organisation.
- Possible values are:
- AU
- NZ
- GLOBAL
- UK
- US
- Edition
- A text field that provides the edition of Xero running for this organisation.
- Possible values are:
- BUSINESS
- PARTNER
- Class
- A text field that provides the class of Xero running for this organisation.
- Possible values are:
- DEMO
- TRIAL
- PREMIUM
- RegistrationNumber
- A text field that provides the registration number of Xero running for this organisation (Australia, New Zealand and UK only).
- EmployerIdentificationNumber
- A text field that provides the employer identifier number (US only).
- IsDemoCompany
- A true/false value that indicates if the data file is a demo organisation.
- FinancialYearEndDay
- A whole number field that provides the end day of the financial year.
- FinancialYearEndMonth
- A whole number field that provides the end month of the financial year.
- SalesTaxBasis
- A text field that provides the default sales tax basis.
- Possible values for Australia, US and Global are:
- CASH
- ACCRUALS
- NONE
- Possible values for New Zealand are:
- PAYMENTS
- INVOICE
- NONE
- Possible values for the United Kingdom are:
- CASH
- ACCRUAL
- FLATRATECASH
- FLATRATEACCRUAL
- NONE
- SalesTaxPeriod
- A text field that provides the frequency with which sales tax returns are processed.
- Possible values for Australia are:
- MONTHLY
- QUARTERLY1
- QUARTERLY2
- QUARTERLY3
- ANNUALLY
- Possible values for New Zealand are:
- ONEMONTHS
- TWOMONTHS
- SIXMONTHS
- Possible values for the United Kingdom are:
- MONTHLY
- QUARTERLY
- YEARLY
- Possible values for the US and Global are:
- 1MONTHLY
- 2MONTHLY
- 3MONTHLY
- 6MONTHLY
- ANNUALLY
- DefaultSalesTax
- A text field that provides the default tax type for sales.
- DefaultPurchasesTax
- A text field that provides the default tax type for purchases.
- PeriodLockDate
- A date time field that indicates the date from which transaction can be entered.
- EndOfYearLockDate
- A date time field that indicates the date from which transaction can be entered.
- PaymentTerms
- A record field provides further information for payment terms for sales and purchases.
- See PaymentTerms Fields for more information.
- ExternalLinks
- A table field provides further information for populate external links such as facebook, twitter, etc.
- See ExternalLinks Fields for more information.
- APIKey
- A text field that provides the unique API key used for xero-to-xero transactions.
- CreatedDateUTC
- A date time field that indicates the date and time this record was created.
PaymentTerms Fields
The PaymentTerms Fields include the following sub fields.
- Bills
- A record field provides further information for payment terms for purchases.
- See PaymentTerms.Bills Fields for more information.
- Sales
- A record field provides further information for payment terms for sales.
- See PaymentTerms.Sales Fields for more information.
PaymentTerms.Bills Fields
The PaymentTerms.Bills Fields include the following sub fields.
- Day
- A whole number field that indicates the day of the month.
- Type
- A text field that indicates how the day field is applied.
- Possible values are:
- DAYSAFTERBILLDATE: x days after bill date
- DAYSAFTERBILLMONTH: x days after bill month
- OFCURRENTMONTH: on a specific day of the current month
- OFFOLLOWINGMONTH: on a specific day of the following month
PaymentTerms.Sales Fields
The PaymentTerms.Sales Fields include the following sub fields.
- Day
- A whole number field that indicates the day of the month.
- Type
- A text field that indicates how the day field is applied.
- Possible values are:
- DAYSAFTERBILLDATE: x days after bill date
- DAYSAFTERBILLMONTH: x days after bill month
- OFCURRENTMONTH: on a specific day of the current month
- OFFOLLOWINGMONTH: on a specific day of the following month
ExternalLinks Fields
The ExternalLinks Fields include the following sub fields.
- LinkType
- A text field that indicates the type of link it is.
- Possible values are:
- GooglePlus
- Website
- Url
- A text field that provides the URL for the link.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints