Set up the FreeAgent integration

Explore our API integration with FreeAgent.

🚧

FreeAgent Sandbox not supported

Codat's integration does not support linking to the FreeAgent sandbox.

Before you can access data from customers using FreeAgent for their accounting, you need to set up the FreeAgent integration in the Codat Portal. You'll need to:

  • Register a new application on FreeAgent’s developer site.
  • Retrieve your application's secure keys.
  • Add your secure keys in the Codat Portal.

Create a FreeAgent application and get your credentials

Create an application in FreeAgent and then retrieve the secure application credentials to use in Codat.

  1. Visit the FreeAgent developer site and sign in to your FreeAgent developer account.

  2. In the navigation bar, click My Apps, then click Create New App.

  3. Enter an app name and description.

  4. Enter the following URL in the OAuth Redirect URIs box: https://freeagent.codat.io/oauth/callback

    You don't need to select the Enable Accountancy Practice API box.

11881188
  1. Select Create App.

    The OAuth identifier and OAuth secret for this app are displayed. Copy these credentials because you will need them for the next stage of the process.

891891

Add your app's secure credentials to the integration

Next, add the secure credentials for your FreeAgent application to the FreeAgent integration in Codat.

In the Codat Portal:

  1. On the navigation bar, select Settings > Accounting.

  2. Find the FreeAgent integration, and select the Manage button next to it.

    The Integration settings page is displayed.

  3. Under Access to company data, configure the permitted sync frequency for the integration.

    Select Allow one-off data sync… or Allow continuous data sync.

  4. Enter the OAuth identifier for your FreeAgent app in the Client Id box.

  5. Enter the OAuth secret for your FreeAgent app in the Client Secret box

  6. Click Save.

Enable the FreeAgent integration

In the Codat Portal:

  1. On the navigation bar, select Settings > Commerce.

  2. Click the toggle next to FreeAgent to set the integration to Enabled.

You can also enable this integration directly from its Integration settings page. If the integration is enabled successfully, the switch remains set to Enabled. If authentication fails, an error displays and the switch reverts to Disabled. Check that your FreeAgent credentials were entered into the Portal correctly.

📘

Spaces in secure keys

Make sure that your secure keys don't contain any spaces.

Now that you've enabled the integration, you can create your first live company.

Linking to FreeAgent

When linking your FreeAgent application to Codat, you will be asked to approve the app's request to access your FreeAgent account data. Ensure to approve this request to link the application successfully.

For help with FreeAgent applications, refer to FreeAgent Quick Start in the FreeAgent documentation.