Set up your FreshBooks integration

Before you can access data from your customers who use FreshBooks for their accounting, you need to set up the FreshBooks integration.

You'll need to:

  • Create a FreshBooks application.
  • Add the application's secure keys to the Codat Portal.

Create a FreshBooks application

Create and configure an application in the FreshBooks Developer Portal.

  1. Log in to freshbooks.com

  2. On the Dashboard, click the cog icon then select Apps & Integrations from the menu. Scroll to the bottom of the page and click Get Started with the Developer Portal.

  3. In the Developer Portal, click Create New App.

  4. Enter the following information in the Create Application window:

    • Application Name: Enter a name for your application. This is displayed to your users when they authorize your access to their accounting data, so choose a name that clearly identifies your organization.

    • Application Type: Select Private App.

    • Scopes: Add the scopes listed in FreshBooks application scopes on this page.

    • Redirect URIs: Enter https://freshbooks.codat.io/oauth/callback then click the check mark icon to save the URI.

  5. Click Save to create your app.

  6. Select your new app from the All Apps list. Locate the app's Client ID and Client Secret at the bottom of the page.

FreshBooks application scopes

The following table lists the recommended scopes to set for your FreshBooks application.

These are the minimum scopes needed to allow read (pull) access to the FreshBooks objects that are supported by Codat. If you want to push data to FreshBooks, also select the corresponding write scopes for the objects you need to push. If the scopes you require change in future, all connected companies will need to reauthenticate with your app.

user:profile:read
user:bills:read
user:bill_payments:read
user:business:read
user:bill_vendors:read
user:clients:read
user:credit_notes:read

user:estimates:read
user:expenses:read
user:journal_entries:read
user:online_payments:read
user:payments:read
user:projects:read
user:retainers:read

user:taxes:read
user:billable_items:read
user:invoices:read
user:other_income:read
user:reports:read
user:teams:read

Add your secure keys to Codat

After you've created and configured a FreshBooks application, add the application's keys to the FreshBooks integration. When you're ready, enable the integration.

Perform these steps in the Codat Portal.

  1. In the navigation bar, go to Integrations > Accounting.

  2. Find the FreshBooks integration, then select Manage.

  3. Select One-off or Continuous to choose what type of access to company data the integration will have.

  4. Enter the Client ID and Client Secret from your FreshBooks app, then click Save. Secure keys cannot contain spaces.

  5. Enable the integration by setting the FreshBooks toggle from Disabled to Enabled.


Did this page help you?