Xero

Version 24.2.8969


Xero


You can use the Xero connector from the CData Sync application to capture data from Xero and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Xero Connector

To enable Sync to use data from Xero, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the Xero row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Xero connector. For more information about installing new connectors, see Connections.

Authenticate to Xero

After you add the connector, you need to set the required properties.

On the New Connection page, enter the connection name of your choice.

CData Sync supports authenticating to Xero in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

OAuth

To connect with OAuth custom credentials, specify the following properties:

  • Auth Scheme – Select OAuth.

  • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

PKCE

CData Sync provides an embedded OAuth application with which to connect. To use the application, select PKCE for Auth Scheme. No additional properties are required.

OAuthClient

To connect with OAuth custom credentials, specify the following properties:

  • Auth Scheme – Select OAuthClient.

  • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

Complete Your Connection

To complete your connection:

  1. Specify the following properties:

    • Schema - Enter the Xero API that you want to access as a database schema, as listed below. The default schema is ACCOUNTING.

      • ACCOUNTING (default - the Accounting API)

      • ASSETS (the Assets API)

      • PAYROLLAUS (the Australian Payroll API)

      • FILES (the Files API)

      • PROJECTS (the Projects API)

    • Tenant (optional) - Enter the Xero organization to which you want to connect. You can specify either the name of the organization or its identifier.

      Note: Because multiple organizations can have the same name, CData recommends that you specify the identifier.

  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  3. Click Connect to Xero to connect to your Xero account.

  4. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Xero, see Xero Connector for CData Sync.