> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FreshBooks OAuth 2.0 connector profile – StackOne setup guide

> Set up a connector profile using OAuth 2.0 for FreshBooks in StackOne to allow users to link their accounts.

Select Actions to adjust the guideSome actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.

Select all
Clear

ActionScope(s)

Loading actions...No actions match your search.

Dynamic Guide URL

Copy URL

Scopes Selected

<pre role="textbox" aria-readonly="true" tabIndex="0" />

Separator

Copy scopes

## Register an OAuth application

Create an application in the FreshBooks Developer portal to obtain the **Client ID** and\
**Client Secret** that StackOne uses to connect.

**1. Sign in to FreshBooks**

Sign in to your [FreshBooks account](https://my.freshbooks.com/#/developer).

<ul>
  <li>The Developer portal opens on the **Apps** page.</li>
</ul>

![The FreshBooks log in screen with the email, password and Log In fields highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-sign-in.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=961f7061606bafd6f412d717326ff3bf)

**2. Create a new app**

On the **Apps** page, click **Create New App**.

<ul>
  <li>Existing applications are listed under **All Apps**.</li>
</ul>

![The Apps page with the Create New App button highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-create-new-app.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=27080396480c8af046eb4ec08d6d5a25)

**3. Fill in the application details**

Complete the **Create Application** form.

<ul>
  <li>**Application Name** — a descriptive name of your choice, for example `StackOne Integration`</li>
  <li>**Application Type** — select **Private App**, described as **Not listed in the app store**</li>
  <li>**Description** — a short summary of the integration, up to the **Max 140 characters** limit</li>
</ul>

![The Create Application form with the Application Name, Application Type and Description fields highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-application-details.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=90e91817cf52dad39fe2c505352844d3)

**4. Add the application URLs**

Both URL fields are optional for StackOne and are shown to FreshBooks users rather than\
used by the integration.

<ul>
  <li>**Website URL** — where people can learn more about the application</li>
  <li>**Application Settings URL** — where users can go to update their application settings</li>
</ul>

![The Website URL and Application Settings URL fields highlighted on the Create Application form](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-application-urls.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=bf1f540dc731de3c67e03870764be626)

## Configure permissions

Scopes control which parts of a FreshBooks account the application can reach.

**1. Add the required scopes**

Enables actions: Archive Client, Archive Credit, Archive Estimate, Archive Expense, Archive Invoice, Archive Item, Archive Payment, Create Account, Create Client, Create Credit, Create Estimate, Create Expense, Create Invoice, Create Item, Create Journal Entry, Create Other Income, Create Payment, Create Project, Create Service, Create Service Rate, Create Tax, Create Time Entry, Delete Other Income, Delete Project, Delete Tax, Delete Time Entry, Get Account, Get Account Aging Report, Get Balance Sheet Report, Get Cash Flow Report, Get Client, Get Credit, Get Current User, Get Estimate, Get Expense, Get Expense Category, Get Expense Details Report, Get General Ledger Report, Get Invoice, Get Item, Get Other Income, Get Payment, Get Project, Get Service, Get Service Rate, Get Staff, Get Tax, Get Team Member, Get Time Entry, Get Unified Credentials, Get Unified Organization, Get Unified Role, Get Unified User, List Accounts, List Bill Payments, List Bills, List Clients, List Credits, List Estimates, List Expense Categories, List Expenses, List Invoices, List Items, List Journal Entries, List Journal Entries By Account, List Other Income, List Payments, List Projects, List Services, List Staff, List Taxes, List Team Members, List Time Entries, List Unified Organizations, List Unified Roles, List Unified Users, Update Client, Update Credit, Update Estimate, Update Expense, Update Invoice, Update Item, Update Journal Entry, Update Other Income, Update Payment, Update Project, Update Service Rate, Update Tax, Update Time Entry

Under **Scopes**, click **Add Scope**, then use **Choose Scope to be added** to select each scope below; the picker reopens after each selection. `user:profile:read` is the scope required for the account connection — StackOne calls the FreshBooks identity endpoint with it to resolve the account and business identifiers every action needs — and FreshBooks adds it to every new application with no **Remove** button. Calling an endpoint without its scope fails that request, so grant every scope the actions you plan to use require.

![The Scopes section with the scope search box open and the list of available scopes](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-add-scope.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=98a2552a1bed12944ffdaaecd7f909de)

<ul>
  <li>
    user:profile:read
  </li>

  <li>
    user:clients:read
  </li>

  <li>
    user:clients:write
  </li>

  <li>
    user:invoices:read
  </li>

  <li>
    user:invoices:write
  </li>

  <li>
    user:estimates:read
  </li>

  <li>
    user:estimates:write
  </li>

  <li>
    user:credit\_notes:read
  </li>

  <li>
    user:credit\_notes:write
  </li>

  <li>
    user:payments:read
  </li>

  <li>
    user:payments:write
  </li>

  <li>
    user:expenses:read
  </li>

  <li>
    user:expenses:write
  </li>

  <li>
    user:bills:read
  </li>

  <li>
    user:bill\_payments:read
  </li>

  <li>
    user:projects:read
  </li>

  <li>
    user:projects:write
  </li>

  <li>
    user:time\_entries:read
  </li>

  <li>
    user:time\_entries:write
  </li>

  <li>
    user:billable\_items:read
  </li>

  <li>
    user:billable\_items:write
  </li>

  <li>
    user:account:read
  </li>

  <li>
    user:account:write
  </li>

  <li>
    user:journal\_entries:read
  </li>

  <li>
    user:journal\_entries:write
  </li>

  <li>
    user:other\_income:read
  </li>

  <li>
    user:other\_income:write
  </li>

  <li>
    user:taxes:read
  </li>

  <li>
    user:taxes:write
  </li>

  <li>
    user:reports:read
  </li>

  <li>
    user:teams:read
  </li>
</ul>

**2. Review the added scopes**

Each scope you pick appears under **ADDED SCOPES** with a **Remove** button. The scopes\
below are the full set this connector's actions use — add the ones your integration needs.

<ul>
  <li>Required for the connection — `user:profile:read`, already listed under **ADDED SCOPES** with no **Remove** button because FreshBooks adds it to every application</li>
  <li>Clients and invoicing — `user:clients:read`, `user:clients:write`, `user:invoices:read`, `user:invoices:write`, `user:estimates:read`, `user:estimates:write`, `user:credit_notes:read`, `user:credit_notes:write`</li>
  <li>Payments and expenses — `user:payments:read`, `user:payments:write`, `user:expenses:read`, `user:expenses:write`, `user:bills:read`, `user:bill_payments:read`</li>
  <li>Projects and time tracking — `user:projects:read`, `user:projects:write`, `user:time_entries:read`, `user:time_entries:write`, `user:billable_items:read`, `user:billable_items:write`</li>
  <li>Accounting — `user:account:read`, `user:account:write`, `user:journal_entries:read`, `user:journal_entries:write`, `user:other_income:read`, `user:other_income:write`, `user:taxes:read`, `user:taxes:write`, `user:reports:read`</li>
  <li>Team — `user:teams:read`</li>
</ul>

![The ADDED SCOPES list showing selected scopes with Remove buttons and the Add Scope button](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-added-scopes.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=927945f7790a1c0a6f1019db3676777b)

## Add the redirect URI and save

The redirect URI is where FreshBooks returns the user after they authorize the application.\
It must match StackOne's callback exactly.

**1. Add the redirect URI**

Under **Redirect URIs**, enter StackOne's callback URL and click the green check button to\
add it to the list.

<ul>
  <li>Redirect URI: the **Callback URL** from your Connector Profile</li>
  <li>Once added, the URI is listed with **Edit** and **Remove** buttons.</li>
</ul>

![The Redirect URIs field containing the StackOne callback URL with the confirm button highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-redirect-uri.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=d05da6550a8da9fb34f1ec216fda1c53)

**2. Save the application**

Click **Save** at the top of the **Create Application** form.

![The Create Application form with the Save button highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-save-application.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=00bfa8bfc40736b893bc2d36f06e736d)

## Copy the client credentials

The **Client ID** and **Client Secret** are shown on the application's own page, not on the\
apps list.

**1. Open the app from the apps list**

You are returned to the **All Apps** list after saving. Click the name of the application\
you just created to open it.

![The All Apps list with the newly created application highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-all-apps-list.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=593157abe8f5196148cb97c3671a3ab9)

**2. Copy the client credentials**

Scroll to the bottom of the application page and copy both values using the copy buttons\
beside them. Store them securely for use later.

<ul>
  <li>**Client ID** — the public identifier of your application; click the copy button beside it, then paste it into the **Client ID** field in the StackOne Connector profile.</li>
  <li>**Client Secret** — the private key of your application; click the eye button to reveal it and the copy button to copy it, then paste it into the **Client Secret** field in the StackOne Connector profile.</li>
  <li>**Scopes** — optionally paste the same space-separated scope list you added above into the **Scopes** field in the StackOne Connector profile; leave it empty to use the connector's default scopes. StackOne always requests `user:profile:read` as well, because the connection reads your account and business IDs with it.</li>
  <li>Treat the **Client Secret** like a password and never commit it to source control or share it publicly.</li>
</ul>

![The application page showing the Client ID and Client Secret rows with their reveal and copy buttons highlighted](https://mintcdn.com/stackone-60/vX_dTtrI8dVdZLUo/connectors/freshbooks/images/oauth2-setup-client-credentials.png?fit=max\&auto=format\&n=vX_dTtrI8dVdZLUo\&q=85\&s=ff849f82d8d697669048d98b38e3e307)

## Create the StackOne Connector Profile

**1. Create a Connector Profile**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

**2. Link an Account**

Once the Connector Profile is created, continue to [link an account](https://docs.stackone.com/connectors/freshbooks/guides/link-account/oauth-2-0.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.