› Configuration › Connections › Connect to Xero

Connect to Xero

This topic describes how to connect a Xero Application, created in the Xero web portal, to the Connections tab within the Configuration menu. First, create the application and record the corresponding connection info. Next, create a custom form within the Xero web portal to suit the migration and the needs of the business. Finally, place the information into the Connections tab.

Set up your Xero account

  1. If you do not already have a Xero account, sign up for a demo account at https://www.xero.com/signup/api/.
  2. Go to the Xero Developer website, and search for "Development accounts" with Docs search.
  3. Use the instructions to enable the Xero demo company for your demo account.

Create an application in Xero to identify PSIcapture

For PSIcapture to connect to your account, you must configure it in Xero and obtain a client ID.

  1. While logged in to Xero, navigate to My Apps in Xero Developer.
  2. Click the New app button in the upper right corner of the screen.

    The Add a new app screen appears.

  3. Enter a name for the application, such as "PSIcapture".
  4. Select Mobile or desktop app as the integration type.
  5. Enter the full web address of your company in the Company or application URL field.

    For example: "https://www.kofax.com/".

  6. Set the redirect URL to "http://localhost:8888/callback".

    PSIcapture uses this location and port to receive the callback information returned through the Xero SDK.

    There is no need for IIS to be installed locally, and the use of HTTP is acceptable. This URL is just a mechanism for the local API DLLs to transfer data received securely from Xero. The API is geared for web applications, and this localhost connection is how the local API talks to a Windows application or service.
  7. Confirm that you have read the terms and conditions, then click the Create app button.

    You are redirected to the App Details screen.

  8. Using the navigation pane on the left, switch to the Configuration screen.
  9. Copy the client ID to your clipboard.

    You need this function when setting up your connection in PSIcapture.

Connect PSIcapture to Xero

Use the Xero portal through your web browser to create custom forms that PSIcapture can import and then match to corresponding index fields and other metadata.

For more information about configuring custom form fields, search for "Field mappings for custom document templates" in the Xero Central website.

Before adding or re-authorizing a connection, we recommend that you to log in to your Xero account using your web browser to ensure your login is current and any 2FA prompts are accepted. The login may take time, so log in before working with a connection in PSIcapture to prevent timeouts.
  1. Go to Configuration: Connections to create custom forms linked to a Xero Connection Profile.
  2. Under Connection Type, select Xero.
    A list of unique Xero connection fields appears.
  3. Enter a Display Name to identify the connection.
  4. Enter the Xero Client ID, Application URL and Port (default: 8888). These settings should be identical to those configured through the Xero portal.

    The Xero Client ID is set up when configuring PSIcapture as an authorized application on the Xero Developer website.

  5. Select Scope to modify the scope settings for the Xero connection. Input entries one per line. The scope contains information corresponding to the entered Site URL. For example: https://<tenant>.sharepoint.com/.default where the <tenant> will be replaced by the appropriate subdomain unique to your organization.

    Use the Reset button to clear the list.

  6. Click the Authorize button.

    Your default web browser appears with a connection confirmation.

  7. In the web browser, click the Allow Access button to approve the connection.

    After a few seconds, you can view the access information, and PSIcapture displays a message box reporting a successful connection.

    PSIcapture may be hidden by the browser window. Do not close the web browser until the message box is displayed. The maximum wait time is 90 seconds before the attempt times out.

    Once authorized, the Tenant field displays a list of companies.

  8. Close the web browser window.
  9. Select the appropriate company from the Tenant field and click the Save button.

    If you receive an "invalid grant" error for a connection, Edit the connection and click the Authorize button to re-authorize the connection.

  10. Once your Xero Connection profile is complete, it can be linked to the migration workflow step for a Xero Migration.

    See Xero.