API StatusProduct RoadmapGet API KeysBack to Railz.ai

Setup FreshBooks

Explore our API integration with FreshBooks

Suggest Edits

Before you can access data from users using FreshBooks for their accounting, you need to set up a FreshBooks integration in the Railz Dashboard™. You'll need to:

  1. Create a FreshBooks developer application.
  2. Add your secure keys to Railz.

Create a FreshBooks Developer Application

  1. Create an account at freshbooks.com.
  2. Once logged in, visit FreshBooks Developer portal and click Create an App.
1046

Create an App in the FreshBooks developer portal. Click to Expand.

  1. Enter your app details.
    1. The Application Name is displayed to your users, so it should identify you.
    2. Select Private App as Application Type.
    3. The Redirect URIs must read: https://auth.railz.ai/freshbooks/railzConnect
FreshBooks Developer Portal - Edit Application. Click to Expand.

Edit the application in FreshBooks' developer portal. Click to Expand.

  1. Set the Scopes to the following list to allow Read access for the data types that Railz supports.
Read ScopesWrite Scopes
user:account:readuser:account:write
user:bill_payments:readuser:bill_payments:write
user:bill_vendors:readuser:bill_vendors:write
user:bills:readuser:bills:write
user:billable_items:readuser:billable_items:write
user:clients:readuser:clients:write
user:credit_notes:readuser:credit_notes:write
user:estimates:readuser:estimates:write
user:expenses:readuser:expenses:write
user:invoices:readuser:invoices:write
user:journal_entries:readuser:journal_entries:write
user:online_payments:readuser:online_payments:write
user:other_income:readuser:other_income:write
user:payments:readuser:payments:write
user:teams:readuser:teams:write
user:taxes:readuser:taxes:write
user:uploads:readuser:uploads:write
user:business:read
user:profile:read
user:reports:read

❗

Scopes for Pushing Data

If you need to push data to Freshbooks you will need to select the corresponding write scope. If the scopes you need are changed then businesses will need to re-authenticate with your app for the new scopes to be applied. We recommend setting all read and write scopes on setup to avoid reauthentication.

  1. Click Save to create your app.
  2. Select the small arrow next to the newly created app to display your secure keys. You'll need these for the next stage of the process.
553

FreshBooks Developer Portal - Client ID & Secret. Click to Expand.

Add your Secure Keys to Railz

  1. Open the Railz Dashboard™ and log in.
  2. In the left sidebar navigation menu, go to Integrations > Accounting.
  3. Scroll down to the FreshBooks integration and click Configure.
Railz Integration Settings. Click to Expand.

Accounting integrations page in Railz Dashboard. Click to Expand.

  1. Paste in your Client ID and Client Secret, and then click Save & Enable.
Railz Manage Accounting Integration. Click to Expand.

Configure the FreshBooks integration modal. Click to Expand.

How to set up - User Guide

Step-by-step guide on how to integrate with FreshBooks

How to connect- User Guide

Updated 5 months ago