Xero


Xero


Prerequisites

Before you use the Xero connector, you must configure your own custom OAuth application through the Xero developer portal.

In the Xero developer portal:

  1. Navigate to My Apps > Add Application.

  2. Choose the application type of Auth Code.

  3. Enter a name for your application and the URL of your company. This information is displayed to users when they connect.

  4. Add the CData redirect URI (https://oauth.cdata.com/oauth/).

  5. Click Save. Xero displays the OAuth Client ID of the new application. Copy this value and paste it into the Add Connection screen.

  6. Create a new OAuth Client Secret. Copy this value and paste it into the Add Connection screen.

Setup Guide

Follow these steps to connect Xero to your CData Connect Cloud account:

  1. Open the Connections page of the CData Connect Cloud dashboard.

  2. Click + Add Connection in the upper-right corner.

  3. Type Xero into the search field, then click the data source name.

  4. On the Basic Settings tab of the new connection, enter a connection name or keep the default name.

  5. Select the Authentication method, then proceed to the relevant section and follow those instructions.

Authentication Methods

OAuth

  1. Paste the OAuth Client Id that you created in the prerequisites.

  2. Paste the OAuth Client Secret that you created in the prerequisites.

  3. Select the Xero Schema to connect to.

  4. (Optional) Set a Tenant Id to connect to. If left blank, the connection will use the first available tenant.

  5. Click Sign in to connect securely through OAuth. This action opens the Xero sign-in page in a new tab.

  6. Log in to your Xero account and provide the requested permissions (if applicable).

  7. At the top of the CData Connect Cloud Add Xero Connection page, click Save & Test.

    • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

    • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

PKCE

  1. Select the Xero Schema to connect to.

  2. (Optional) Set a Tenant Id to connect to. If left blank, the connection will use the first available tenant.

  3. Click Sign in to connect securely through OAuth. This action opens the Xero sign-in page in a new tab.

  4. Log in to your Xero account and provide the requested permissions (if applicable).

  5. At the top of the CData Connect Cloud Add Xero Connection page, click Save & Test.

    • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

    • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

OAuthClient

  1. Paste the OAuth Client Id that you created in the prerequisites.

  2. Paste the OAuth Client Secret that you created in the prerequisites.

  3. Select the Xero Schema to connect to.

  4. (Optional) Set a Tenant Id to connect to. If left blank, the connection will use the first available tenant.

  5. At the top of the CData Connect Cloud Add Xero Connection page, click Save & Test.

    • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

    • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

More Information

For more information about interactions between CData Connect Cloud and Xero, see this information page.