# Freshbooks

![Freshbooks_Logo.svg](https://assets.relyanceuat.xyz/images/docs/10137256126221/10136958966285.svg)
FreshBooks is a web-based accounting software as a service (SaaS). It includes invoicing, accounts payable, expense tracking, time tracking, retainers, fixed asset depreciation, purchase orders, payroll integrations, mileage tracking, double-entry accounting, and industry-standard business and management reporting.

In order to integrate FreshBooks with Relyance AI you will need a **Client ID**, **Client Secret**, and to follow an OAuth2 flow.

#### In FreshBooks:

1. Login to your FreshBooks account.
2. Go here: [https://my.freshbooks.com/#/developer](https://my.freshbooks.com/#/developer)
3. Click the **Create New App** button.
4. Use the following settings for your App: **Application Name**: Provide a meaningful name ( *e.g. Relyance AI* ) **Application Type**: Private App **Scopes**: **Redirect URL**: [https://root.relyance.ai/api/oauth2](https://root.relyance.ai/api/oauth2) ( *ensure you press the checkmark button to accept* ) **Logo** (optional): Use the attached [logo](https://support.relyance.ai/hc/en-us/article_attachments/10146770594445/Relyance_logo.png).

![Freshbooks-3.png](https://assets.relyanceuat.xyz/images/docs/10137256126221/10145697252237.png)

5. Click **Save**.
6. Go back into your newly created App and copy the **Client ID** and **Client Secret** to be used in Relyance.

#### In the Relyance AI application:

1. Login to your Relyance account.
2. Navigate to the **Settings** Menu in the bottom left-hand side.
3. Select **Integrations**.
4. Click on the **Vendor Integration** tab.
5. Find the **FreshBooks** integration card and click it to open its connections.
6. Under **Authentication Method**, choose **OAuth2 / App Token**.
8. Paste the **Client ID** and **Client Secret** into their respective fields.

![FreshBooks-1.png](https://assets.relyanceuat.xyz/images/docs/10137256126221/10137173608205.png)

9. Click **Authenticate**.
10. This will bring your to FreshBooks to authorize Relyance AI. Click **Allow**.

![Freshbooks-4.png](https://assets.relyanceuat.xyz/images/docs/10137256126221/10146988772365.png)

11. At this point, you should see the following result on the **Vendor** Integrations page:

![FreshBooks-2.png](https://assets.relyanceuat.xyz/images/docs/10137256126221/10137173603853.png)

12. Congratulations, you are now connected to **FreshBooks**.

<!-- failure-modes:begin (generated from the integration catalog; do not hand-edit) -->

## If the connection reports Connected but returns nothing

These are the ways this integration comes back empty without reporting an error. Generated from the integration catalog, so it tracks what the connection actually asks for.

1. **Authorised, then empty.** The connection carries an authorisation, not a password: it stops returning data if the account that granted it loses access, its own permissions narrow, or the grant is revoked at the vendor. None of that reports an error here -- the connection keeps its last status until the next scan.
2. **A credential rotated at the vendor is not picked up here.** **Client Secret** is stored when you save the connection, so regenerating the value at the vendor breaks the next scan until it is re-pasted here. Recording the expiry on the connection means Relyance warns you before it lapses.

<!-- failure-modes:end -->

<!-- terraform-examples:begin (generated from the integration catalog; do not hand-edit) -->

## Manage this integration with Terraform

Connections for this integration can be managed as code with the [Relyance Terraform provider](https://registry.terraform.io/providers/Relyance/relyance/latest). Non-secret fields go in `auth.params`; secret fields go in `auth.secrets_wo`, which is write-only — never stored in Terraform state. Rotate secrets by bumping `auth.secrets_wo_version`.

The **OAuth (browser authorization)** method uses a browser authorization flow, so the connection is created in the Relyance app. Manage it in Terraform afterwards by importing it (`terraform import relyance_integration_connection.example freshbooks/<connection_id>`) or reading it with the `relyance_integration_connection` data source.

<!-- terraform-examples:end -->
