Skip to main content

​
Add the Xero Connector

​
Authenticate to Xero

After you add the connector, you need to set the required properties. supports authenticating to 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

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

​
OAuth Client

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)
    • (Optional) Tenant: Enter the Xero organization to which you want to connect. You can specify either the name of the organization or its identifier.
      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 to connect to your account.
  4. Click Create & Test to create your connection.

​
More Information