› Configuration › Connections › Connecting to Xero

Connecting 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 your company's full web address 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 when setting up your connection in PSIcapture.

Connecting PSIcapture to Xero

From here, you can utilize all functions of the Xero portal to create custom forms to which PSIcapture can import and match corresponding metadata.

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

  1. Go to Configuration: Connections to create custom forms.
  2. Once a form is created, it can be linked to the Migration workflow step for a Xero Migration.

    See Xero.