Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: Copy data from Xero description: Learn how to copy data from Xero to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline. titleSuffix: Azure Data Factory & Azure Synapse author: jianleishen ms.subservice: data-movement ms.custom: synapse ms.topic: conceptual ms.date: 12/10/2025 ms.author: jianleishen --- # Copy data from Xero using Azure Data Factory or Synapse Analytics [!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)] This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Xero. It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity. > [!NOTE] > The Xero connector requires OAuth authentication and is not intended for server-to-server use. > [!IMPORTANT] > The Xero connector version 2.0 provides improved native Xero support. If you are using Xero connector version 1.0 in your solution, please [upgrade the Xero connector](#upgrade-the-xero-connector-from-version-10-to-version-20) before **March 31, 2026**. Refer to this [section](#xero-connector-lifecycle-and-upgrade) for details on the difference between version 2.0 and version 1.0. ## Supported capabilities This Xero connector is supported for the following capabilities: | Supported capabilities|IR | |---------| --------| |[Copy activity](copy-activity-overview.md) (source/-)|&#9312; &#9313;| |[Lookup activity](control-flow-lookup-activity.md)|&#9312; &#9313;| *&#9312; Azure integration runtime &#9313; Self-hosted integration runtime* For a list of data stores that are supported as sources/sinks, see the [Supported data stores](connector-overview.md#supported-data-stores) table. Specifically, this Xero connector supports: - OAuth 2.0 authentication. - All Xero tables (API endpoints) except "Reports". - Windows versions in this [article](create-self-hosted-integration-runtime.md#prerequisites). >[!NOTE] >Due to the [sunset of OAuth 1.0 authentication in Xero](https://devblog.xero.com/an-update-on-why-we-are-saying-goodbye-oauth-1-0a-hello-oauth-2-0-6a839230908f), please [upgrade to OAuth 2.0 authentication type](#linked-service-properties) if you are currently using OAuth 1.0 authentication type. ## Getting started [!INCLUDE [data-factory-v2-connector-get-started](includes/data-factory-v2-connector-get-started.md)] ## Create a linked service to Xero using UI Use the following steps to create a linked service to Xero in the Azure portal UI. 1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New: # [Azure Data Factory](#tab/data-factory) :::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Create a new linked service with Azure Data Factory UI."::: # [Azure Synapse](#tab/synapse-analytics) :::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Create a new linked service with Azure Synapse UI."::: 2. Search for Xero and select the Xero connector. :::image type="content" source="media/connector-xero/xero-connector.png" alt-text="Select the Xero connector."::: 1. Configure the service details, test the connection, and create the new linked service. :::image type="content" source="media/connector-xero/configure-xero-linked-service.png" alt-text="Configure a linked service to Xero."::: ## Connector configuration details The following sections provide details about properties that are used to define Data Factory entities specific to Xero connector. ## Linked service properties The Xero connector now supports version 2.0. Refer to this [section](#upgrade-the-xero-connector-from-version-10-to-version-20) to upgrade your Xero connector version from version 1.0. For the property details, see the corresponding sections. - [Version 2.0](#version-20) - [Version 1.0](#version-10) ### Version 2.0 The Xero linked service supports the following properties when applying version 2.0: | Property | Description | Required | |:--- |:--- |:--- | | type | The type property must be set to: **Xero** | Yes | | version | The version that you specify. The value is `2.0`. | Yes | | host | The endpoint of the Xero server (`api.xero.com`). | Yes | | consumerKey | Specify the **client ID** for your Xero application.<br>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes | | privateKey | Specify the **client secret** for your Xero application.<br/>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes | | tenantId | The tenant ID associated with your Xero application. Applicable for OAuth 2.0 authentication.<br>Learn how to get the tenant ID from [Check the tenants you're authorized to access section](https://developer.xero.com/documentation/oauth2/auth-flow). | Yes | | refreshToken | The OAuth 2.0 refresh token is associated with the Xero application and used to refresh the access token; the access token expires after 30 minutes. Learn about how the Xero authorization flow works and how to get the refresh token from [this article](https://developer.xero.com/documentation/oauth2/auth-flow). To get a refresh token, you must request the [offline_access scope](https://developer.xero.com/documentation/oauth2/scopes). <br/>**Know limitation**: Note Xero resets the refresh token after it's used for access token refresh. For operationalized workload, before each copy activity run, you need to set a valid refresh token for the service to use.<br/>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes | | connectVia | The [integration runtime](concepts-integration-runtime.md) to be used to connect to the data store. If no value is specified, the property uses the default Azure integration runtime. You can use the self-hosted integration runtime and its version should be 5.61 or above. | No | **Example:** ```json { "name": "XeroLinkedService", "properties": { "type": "Xero", "typeProperties": { "host": "api.xero.com", "consumerKey": "<client ID>", "privateKey": { "type": "SecureString", "value": "<client secret>" }, "tenantId": "<tenant ID>", "refreshToken": { "type": "SecureString", "value": "<refresh token>" }, "authenticationType":"OAuth_2.0", "version": "2.0"          } } } ``` ### Version 1.0 The Xero linked service supports the following properties when applying version 1.0: | Property | Description | Required | |:--- |:--- |:--- | | type | The type property must be set to: **Xero** | Yes | | connectionProperties | A group of properties that defines how to connect to Xero. | Yes | | ***Under `connectionProperties`:*** | | | | host | The endpoint of the Xero server (`api.xero.com`). | Yes | | authenticationType | Allowed values are `OAuth_2.0` and `OAuth_1.0`. | Yes | | consumerKey | For OAuth 2.0, specify the **client ID** for your Xero application.<br>For OAuth 1.0, specify the consumer key associated with the Xero application.<br>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes | | privateKey | For OAuth 2.0, specify the **client secret** for your Xero application.<br>For OAuth 1.0, specify the private key from the .pem file that was generated for your Xero private application. Note to **generate the privatekey.pem with numbits of 512** using `openssl genrsa -out privatekey.pem 512`, 1024 is not supported. Include all the text from the .pem file including the Unix line endings(\n), see sample below.<br/><br>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes | | tenantId | The tenant ID associated with your Xero application. Applicable for OAuth 2.0 authentication.<br>Learn how to get the tenant ID from [Check the tenants you're authorized to access section](https://developer.xero.com/documentation/oauth2/auth-flow). | Yes for OAuth 2.0 authentication | | refreshToken | Applicable for OAuth 2.0 authentication.<br/>The OAuth 2.0 refresh token is associated with the Xero application and used to refresh the access token; the access token expires after 30 minutes. Learn about how the Xero authorization flow works and how to get the refresh token from [this article](https://developer.xero.com/documentation/oauth2/auth-flow). To get a refresh token, you must request the [offline_access scope](https://developer.xero.com/documentation/oauth2/scopes). <br/>**Know limitation**: Note Xero resets the refresh token after it's used for access token refresh. For operationalized workload, before each copy activity run, you need to set a valid refresh token for the service to use.<br/>Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes for OAuth 2.0 authentication | | useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | No | | useHostVerification | Specifies whether the host name is required in the server's certificate to match the host name of the server when connecting over TLS. The default value is true. | No | | usePeerVerification | Specifies whether to verify the identity of the server when connecting over TLS. The default value is true. | No | **Example: OAuth 2.0 authentication** ```json { "name": "XeroLinkedService", "properties": { "type": "Xero", "typeProperties": { "connectionProperties": { "host": "api.xero.com", "authenticationType":"OAuth_2.0", "consumerKey": { "type": "SecureString", "value": "<client ID>" }, "privateKey": { "type": "SecureString", "value": "<client secret>" }, "tenantId": "<tenant ID>", "refreshToken": { "type": "SecureString", "value": "<refresh token>" }, "useEncryptedEndpoints": true, "useHostVerification": true, "usePeerVerification": true }             } } } ``` **Example: OAuth 1.0 authentication** ```json { "name": "XeroLinkedService", "properties": { "type": "Xero", "typeProperties": { "connectionProperties": { "host": "api.xero.com", "authenticationType":"OAuth_1.0", "consumerKey": { "type": "SecureString", "value": "<consumer key>" }, "privateKey": { "type": "SecureString", "value": "<private key>" }, "useEncryptedEndpoints": true, "useHostVerification": true, "usePeerVerification": true             } } } } ``` **Sample private key value:** Include all the text from the .pem file including the Unix line endings(\n). ``` "-----BEGIN RSA PRIVATE KEY-----\nMII***************************************************P\nbu****************************************************s\nU/****************************************************B\nA*****************************************************W\njH****************************************************e\nsx*****************************************************l\nq******************************************************X\nh*****************************************************i\nd*****************************************************s\nA*****************************************************dsfb\nN*****************************************************M\np*****************************************************Ly\nK*****************************************************Y=\n-----END RSA PRIVATE KEY-----" ``` ## Dataset properties For a full list of sections and properties available for defining datasets, see the [datasets](concepts-datasets-linked-services.md) article. This section provides a list of properties supported by Xero dataset. To copy data from Xero, set the type property of the dataset to **XeroObject**. The following properties are supported: | Property | Description | Required | |:--- |:--- |:--- | | type | The type property of the dataset must be set to: **XeroObject** | Yes | | table | Name of the table. Table names use the object name, for example: `Accounts`. This property is only supported in version 2.0. | Yes | | tableName | Name of the table. Table names use object names with prefix, for example, `"Global"."Accounts"`. This property is only supported in version 1.0. | No (if "query" in activity source is specified) | **Example** ```json { "name": "XeroDataset", "properties": { "type": "XeroObject", "typeProperties": {}, "schema": [], "linkedServiceName": { "referenceName": "<Xero linked service name>", "type": "LinkedServiceReference" } } } ``` The connector version 2.0 supports the following Xero tables: - Accounts - Bank_Transactions - Bank_Transaction_Line_Items - Bank_Transfers - Budgets - Contacts - Contacts_Addresses - Contact_Groups - Contact_Group_Contacts - Contacts_Phones - Credit_Notes - Credit_Note_Line_Items - Credit_Notes_Line_Items_Tracking - Currencies - Invoices - Invoices_Credit_Notes - Invoice_Line_Items - Invoice_Line_Items_Tracking - Invoices_Overpayments - Invoices_Prepayments - Items - Journals - Journal_Lines - Journal_Line_Tracking_Categories - Manual_Journals - Manual_Journal_Lines - Organisations - Overpayments - Payments - Prepayments - Prepayments_Allocations - Prepayment_Line_Items - Projects - ProjectUsers - Purchase_Orders - Purchase_Order_Line_Items - Receipts - Tax_Rates - Tracking_Categories - Tracking_Categories_Options - Users ## Copy activity properties For a full list of sections and properties available for defining activities, see the [Pipelines](concepts-pipelines-activities.md) article. This section provides a list of properties supported by Xero source. ### Xero as source To copy data from Xero, set the source type in the copy activity to **XeroSource**. The following properties are supported in the copy activity **source** section: | Property | Description | Required | |:--- |:--- |:--- | | type | The type property of the copy activity source must be set to: **XeroSource** | Yes | | query | Use the custom SQL query to read data. For example: `"SELECT * FROM Contacts"`. | No (if "tableName" in dataset is specified) | > [!NOTE] > `query` is not supported in version 2.0. **Example:** ```json "activities":[ { "name": "CopyFromXero", "type": "Copy", "inputs": [ { "referenceName": "<Xero input dataset name>", "type": "DatasetReference" } ], "outputs": [ { "referenceName": "<output dataset name>", "type": "DatasetReference" } ], "typeProperties": { "source": { "type": "XeroSource", "query": "SELECT * FROM Contacts" }, "sink": { "type": "<sink type>" } } } ] ``` Note the following when specifying the Xero query: - Tables with complex items will be split to multiple tables. For example, Bank transactions has a complex data structure "LineItems", so data of bank transaction is mapped to table `Bank_Transaction` and `Bank_Transaction_Line_Items`, with `Bank_Transaction_ID` as foreign key to link them together. - Xero data is available through two schemas: `Minimal` (default) and `Complete`. The Complete schema contains prerequisite call tables which require additional data (e.g. ID column) before making the desired query. The following tables have the same information in the Minimal and Complete schema. To reduce the number of API calls, use Minimal schema (default). - Bank_Transactions - Contact_Groups - Contacts - Contacts_Sales_Tracking_Categories - Contacts_Phones - Contacts_Addresses - Contacts_Purchases_Tracking_Categories - Credit_Notes - Credit_Notes_Allocations - Expense_Claims - Expense_Claim_Validation_Errors - Invoices - Invoices_Credit_Notes - Invoices_ Prepayments - Invoices_Overpayments - Manual_Journals - Overpayments - Overpayments_Allocations - Prepayments - Prepayments_Allocations - Receipts - Receipt_Validation_Errors - Tracking_Categories The following tables can only be queried with complete schema: - Complete.Bank_Transaction_Line_Items - Complete.Bank_Transaction_Line_Item_Tracking - Complete.Contact_Group_Contacts - Complete.Contacts_Contact_ Persons - Complete.Credit_Note_Line_Items - Complete.Credit_Notes_Line_Items_Tracking - Complete.Expense_Claim_ Payments - Complete.Expense_Claim_Receipts - Complete.Invoice_Line_Items - Complete.Invoices_Line_Items_Tracking - Complete.Manual_Journal_Lines - Complete.Manual_Journal_Line_Tracking - Complete.Overpayment_Line_Items - Complete.Overpayment_Line_Items_Tracking - Complete.Prepayment_Line_Items - Complete.Prepayment_Line_Item_Tracking - Complete.Receipt_Line_Items - Complete.Receipt_Line_Item_Tracking - Complete.Tracking_Category_Options ## Data type mapping for Xero When you copy data from Xero, the following mappings apply from Xero's data types to the internal data types used by the service. To learn about how the copy activity maps the source schema and data type to the sink, see [Schema and data type mappings](copy-activity-schema-and-type-mapping.md). | Xero data type | Interim service data type (for version 2.0) | Interim service data type (for version 1.0) | |-------------------|-------------------------------------------|---------------------------------------------| | String | String | String | | Date | String | Date | | DateTime | String | String | | Boolean | Boolean | Boolean | | Number (standard) | Int32 | Int32 | | Number (large) | Int64 | Int64 | ## Lookup activity properties To learn details about the properties, check [Lookup activity](control-flow-lookup-activity.md). ## Xero connector lifecycle and upgrade The following table shows the release stage and change logs for different versions of the Xero connector: | Version | Release stage | Change log | | :----------- | :------- |:------- | | Version 1.0 | End of support announced | / | | Version 2.0 | GA version available |• Use `table` instead of `tableName`. <br><br>• The value for `table` is the object name, for example: `Accounts`. <br><br>• The self-hosted integration runtime version should be 5.61 or above. <br><br>• Date is read as String data type. <br><br>• `useEncryptedEndpoints`, `useHostVerification`, `usePeerVerification` are not supported in the linked service. <br><br> • `query` is not supported. <br><br> • OAuth 1.0 authentication is not supported. <br><br> • Support specific Xero tables. For the supported table list, go to [Dataset properties](#dataset-properties).| ### Upgrade the Xero connector from version 1.0 to version 2.0 1. In **Edit linked service** page, select version 2.0 and configure the linked service by referring to [Linked service properties version 2.0](#version-20). 1. The data type mapping for the Xero linked service version 2.0 is different from that for the version 1.0. To learn the latest data type mapping, see [Data type mapping for Xero](#data-type-mapping-for-xero). 1. If you use the self-hosted integration runtime, its version should be 5.61 or above. 1. Use `table` instead of `tableName` in version 2.0. For the detailed configuration, go to [Dataset properties](#dataset-properties). 1. `query` is only supported in version 1.0. You should use the `table` instead of `query` in version 2.0. 1. Note that version 2.0 supports specific Xero tables. For the supported table list, go to [Dataset properties](#dataset-properties). ## Related content For a list of supported data stores by the copy activity, see [supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).