CData Python Connector for Xero

Build 25.0.9454

Tenant

Specifies the Xero organization (tenant) to connect to. This can be either the name of the organization or its unique tenant ID. If not specified, the first authorized tenant is used by default.

Data Type

string

Default Value

""

Remarks

Xero allows users to authorize applications for access to multiple organizations (tenants) under a single login. By default, the connector connects to the first available tenant returned by the Xero API.

To explicitly connect to a specific organization, set the Tenant property to either:

  • The name of the organization
  • The tenant ID (a unique identifier assigned by Xero)
Important: If you have multiple organizations with the same name, we recommend using the tenant ID to ensure accurate selection.

To find the tenant ID:

  1. Connect with the Tenant property unset.
  2. Query the Tenants view to retrieve a list of authorized tenants and their IDs.
Examples:
Tenant = "Demo Company (Global)"
Tenant = "d75cc47e-d749-4c93-b050-3177ad62f6d2"
Setting this property is recommended when working with integrations that span multiple organizations or require consistent targeting across sessions.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454