Xero connector

Beta

This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for Xero from the Previews page. See Manage Databricks previews.

The managed Xero connector in Lakeflow Connect ingests accounting data such as invoices, payments, contacts, and bank transactions from Xero into Databricks.

Feature availability

Feature	Availability
UI-based pipeline authoring	Supported
API-based pipeline authoring	Supported
Declarative Automation Bundles	Supported
Incremental ingestion	Supported
Unity Catalog governance	Supported
Orchestration using Lakeflow Jobs	Supported
API-based column selection and deselection	Supported
API-based row filtering	Not supported
Slowly changing dimensions (SCD) type 2	Supported for 15 of 23 tables Tables with VARIANT columns (bank_transactions, credit_notes, invoices, overpayments, payments, prepayments, purchase_orders, and repeating_invoices) do not support SCD type 2.
Automated schema evolution: New and deleted columns	Supported
Automated schema evolution: Data type changes	Not supported
Automated schema evolution: Column renames	Not supported Requires a full refresh.

Feature	Availability
UI-based pipeline authoring	Supported
API-based pipeline authoring	Supported
Declarative Automation Bundles	Supported
Incremental ingestion	Supported
Unity Catalog governance	Supported
Orchestration using Lakeflow Jobs	Supported
API-based column selection and deselection	Supported
API-based row filtering	Not supported
Slowly changing dimensions (SCD) type 2	Supported for 15 of 23 tables Tables with VARIANT columns (bank_transactions, credit_notes, invoices, overpayments, payments, prepayments, purchase_orders, and repeating_invoices) do not support SCD type 2.
Automated schema evolution: New and deleted columns	Supported
Automated schema evolution: Data type changes	Not supported
Automated schema evolution: Column renames	Not supported Requires a full refresh.

Authentication methods

Authentication method	Availability
OAuth user-to-machine (U2M)	Supported Uses a Xero OAuth 2.0 app that you create.
OAuth machine-to-machine (M2M)	Not supported
Basic authentication (username/password)	Not supported
Basic authentication (API key)	Not supported

Authentication method	Availability
OAuth user-to-machine (U2M)	Supported Uses a Xero OAuth 2.0 app that you create.
OAuth machine-to-machine (M2M)	Not supported
Basic authentication (username/password)	Not supported
Basic authentication (API key)	Not supported

Ingest from Xero in 3 steps

note

Before starting, review the Databricks user persona, supported interfaces, ingestion frequency, and common patterns.

1. Configure Xero for ingestion (Admins): Set up Xero to authenticate with Databricks.
2. Create a Unity Catalog connection (Admins): Create a connection in Catalog Explorer to store credentials for Databricks to authenticate with Xero.
3. Create an ingestion pipeline (Admins or non-admins): Select any supported interface and create a pipeline from an existing connection.