Xero · Schema

Organisation

AccountingBank FeedsFinanceFinancial-ServicesInvoicingPayrollSmall Business

Properties

Name	Type	Description
OrganisationID	string	Unique Xero identifier
APIKey	string	Display a unique key used for Xero-to-Xero transactions
Name	string	Display name of organisation shown in Xero
LegalName	string	Organisation name shown on Reports
PaysTax	boolean	Boolean to describe if organisation is registered with a local tax authority i.e. true, false
Version	string	See Version Types
OrganisationType	string	Organisation Type
BaseCurrency	string
CountryCode	string
IsDemoCompany	boolean	Boolean to describe if organisation is a demo company.
OrganisationStatus	string	Will be set to ACTIVE if you can connect to organisation via the Xero API
RegistrationNumber	string	Shows for New Zealand, Australian and UK organisations
EmployerIdentificationNumber	string	Shown if set. US Only.
TaxNumber	string	Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global).
FinancialYearEndDay	integer	Calendar day e.g. 0-31
FinancialYearEndMonth	integer	Calendar Month e.g. 1-12
SalesTaxBasis	string	The accounting basis used for tax returns. See Sales Tax Basis
SalesTaxPeriod	string	The frequency with which tax returns are processed. See Sales Tax Period
DefaultSalesTax	string	The default for LineAmountTypes on sales transactions
DefaultPurchasesTax	string	The default for LineAmountTypes on purchase transactions
PeriodLockDate	string	Shown if set. See lock dates
EndOfYearLockDate	string	Shown if set. See lock dates
CreatedDateUTC	string	Timestamp when the organisation was created in Xero
Timezone	string
OrganisationEntityType	string	Organisation Entity Type
ShortCode	string	A unique identifier for the organisation. Potential uses.
Class	string	Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
Edition	string	BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
LineOfBusiness	string	Description of business type as defined in Organisation settings
Addresses	array	Address details for organisation – see Addresses
Phones	array	Phones details for organisation – see Phones
ExternalLinks	array	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 Ex
PaymentTerms	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Organisation",
  "title": "Organisation",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/organisation/"
  },
  "properties": {
    "OrganisationID": {
      "description": "Unique Xero identifier",
      "type": "string",
      "format": "uuid",
      "example": "8be9db36-3598-4755-ba5c-c2dbc8c4a7a2"
    },
    "APIKey": {
      "description": "Display a unique key used for Xero-to-Xero transactions",
      "type": "string"
    },
    "Name": {
      "description": "Display name of organisation shown in Xero",
      "type": "string"
    },
    "LegalName": {
      "description": "Organisation name shown on Reports",
      "type": "string"
    },
    "PaysTax": {
      "description": "Boolean to describe if organisation is registered with a local tax authority i.e. true, false",
      "type": "boolean"
    },
    "Version": {
      "description": "See Version Types",
      "type": "string",
      "enum": [
        "AU",
        "NZ",
        "GLOBAL",
        "UK",
        "US",
        "AUONRAMP",
        "NZONRAMP",
        "GLOBALONRAMP",
        "UKONRAMP",
        "USONRAMP"
      ]
    },
    "OrganisationType": {
      "description": "Organisation Type",
      "type": "string",
      "enum": [
        "ACCOUNTING_PRACTICE",
        "COMPANY",
        "CHARITY",
        "CLUB_OR_SOCIETY",
        "INDIVIDUAL",
        "LOOK_THROUGH_COMPANY",
        "NOT_FOR_PROFIT",
        "PARTNERSHIP",
        "S_CORPORATION",
        "SELF_MANAGED_SUPERANNUATION_FUND",
        "SOLE_TRADER",
        "SUPERANNUATION_FUND",
        "TRUST"
      ]
    },
    "BaseCurrency": {
      "$ref": "#/components/schemas/CurrencyCode",
      "type": "string"
    },
    "CountryCode": {
      "$ref": "#/components/schemas/CountryCode",
      "type": "string"
    },
    "IsDemoCompany": {
      "description": "Boolean to describe if organisation is a demo company.",
      "type": "boolean"
    },
    "OrganisationStatus": {
      "description": "Will be set to ACTIVE if you can connect to organisation via the Xero API",
      "type": "string"
    },
    "RegistrationNumber": {
      "description": "Shows for New Zealand, Australian and UK organisations",
      "type": "string"
    },
    "EmployerIdentificationNumber": {
      "description": "Shown if set. US Only.",
      "type": "string"
    },
    "TaxNumber": {
      "description": "Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global).",
      "type": "string"
    },
    "FinancialYearEndDay": {
      "description": "Calendar day e.g. 0-31",
      "type": "integer"
    },
    "FinancialYearEndMonth": {
      "description": "Calendar Month e.g. 1-12",
      "type": "integer"
    },
    "SalesTaxBasis": {
      "description": "The accounting basis used for tax returns. See Sales Tax Basis",
      "type": "string",
      "enum": [
        "PAYMENTS",
        "INVOICE",
        "NONE",
        "CASH",
        "ACCRUAL",
        "FLATRATECASH",
        "FLATRATEACCRUAL",
        "ACCRUALS"
      ]
    },
    "SalesTaxPeriod": {
      "description": "The frequency with which tax returns are processed. See Sales Tax Period",
      "type": "string",
      "enum": [
        "MONTHLY",
        "QUARTERLY1",
        "QUARTERLY2",
        "QUARTERLY3",
        "ANNUALLY",
        "ONEMONTHS",
        "TWOMONTHS",
        "SIXMONTHS",
        "1MONTHLY",
        "2MONTHLY",
        "3MONTHLY",
        "6MONTHLY",
        "QUARTERLY",
        "YEARLY",
        "NONE"
      ]
    },
    "DefaultSalesTax": {
      "description": "The default for LineAmountTypes on sales transactions",
      "type": "string"
    },
    "DefaultPurchasesTax": {
      "description": "The default for LineAmountTypes on purchase transactions",
      "type": "string"
    },
    "PeriodLockDate": {
      "description": "Shown if set. See lock dates",
      "type": "string",
      "x-is-msdate": true
    },
    "EndOfYearLockDate": {
      "description": "Shown if set. See lock dates",
      "type": "string",
      "x-is-msdate": true
    },
    "CreatedDateUTC": {
      "description": "Timestamp when the organisation was created in Xero",
      "type": "string",
      "x-is-msdate-time": true,
      "example": "/Date(1573755038314)/",
      "readOnly": true
    },
    "Timezone": {
      "$ref": "#/components/schemas/TimeZone",
      "type": "string"
    },
    "OrganisationEntityType": {
      "description": "Organisation Entity Type",
      "type": "string",
      "enum": [
        "ACCOUNTING_PRACTICE",
        "COMPANY",
        "CHARITY",
        "CLUB_OR_SOCIETY",
        "INDIVIDUAL",
        "LOOK_THROUGH_COMPANY",
        "NOT_FOR_PROFIT",
        "PARTNERSHIP",
        "S_CORPORATION",
        "SELF_MANAGED_SUPERANNUATION_FUND",
        "SOLE_TRADER",
        "SUPERANNUATION_FUND",
        "TRUST"
      ]
    },
    "ShortCode": {
      "description": "A unique identifier for the organisation. Potential uses.",
      "type": "string"
    },
    "Class": {
      "description": "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)",
      "type": "string",
      "enum": [
        "DEMO",
        "TRIAL",
        "STARTER",
        "STANDARD",
        "PREMIUM",
        "PREMIUM_20",
        "PREMIUM_50",
        "PREMIUM_100",
        "LEDGER",
        "GST_CASHBOOK",
        "NON_GST_CASHBOOK",
        "ULTIMATE",
        "LITE",
        "ULTIMATE_10",
        "ULTIMATE_20",
        "ULTIMATE_50",
        "ULTIMATE_100",
        "IGNITE",
        "GROW",
        "COMPREHENSIVE",
        "SIMPLE"
      ]
    },
    "Edition": {
      "description": "BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)",
      "type": "string",
      "enum": [
        "BUSINESS",
        "PARTNER"
      ]
    },
    "LineOfBusiness": {
      "description": "Description of business type as defined in Organisation settings",
      "type": "string"
    },
    "Addresses": {
      "description": "Address details for organisation \u2013 see Addresses",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AddressForOrganisation"
      }
    },
    "Phones": {
      "description": "Phones details for organisation \u2013 see Phones",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Phone"
      }
    },
    "ExternalLinks": {
      "description": "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",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExternalLink"
      }
    },
    "PaymentTerms": {
      "$ref": "#/components/schemas/PaymentTerm"
    }
  },
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/xero-organisation"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.