# FreshBooks

<!-- BEGIN GENERATED:intro -->

The FreshBooks connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for FreshBooks.

To create a new FreshBooks source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for FreshBooks-specific configuration and networking. For the complete property reference, see the [official FreshBooks driver documentation ↗](https://cdn.cdata.com/help/DFK/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

:::callout{theme="neutral" title="Beta"}
The FreshBooks connector is in the [beta](../../platform-overview/development-life-cycle/index.md) phase of development and may not be available on your enrollment. Functionality may change during active development.
:::

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟡 Beta |
| Batch syncs | 🟡 Beta |
| Incremental | 🟡 Beta |
| [OAuth 2.0 authentication](#oauth-20-authentication) | 🟡 Beta |
| [Table exports](#table-exports) | 🟡 Beta |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`AccountId` ↗](https://cdn.cdata.com/help/DFK/jdbc/RSBFreshBooks_p_AccountId.htm) | Recommended | The Account Id to connect to. If a value is not specified, the first one returned will be used. | — |
| [`CallbackURL` ↗](https://cdn.cdata.com/help/DFK/jdbc/RSBFreshBooks_p_CallbackURL.htm) | Recommended | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. | `https://localhost:33333/` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/DFK/jdbc/RSBFreshBooks_p_InitiateOAuth.htm) | Recommended | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. | `REFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/DFK/jdbc/RSBFreshBooks_p_OAuthClientId.htm) | Recommended | The client Id assigned when you register your application with an OAuth authorization server. | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/DFK/jdbc/RSBFreshBooks_p_OAuthClientSecret.htm) | Recommended | The client secret assigned when you register your application with an OAuth authorization server. | — |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| api.freshbooks.com | Always |
| my.freshbooks.com | Always |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:oauth -->

## OAuth 2.0 authentication

This connector supports OAuth 2.0 authentication. Follow the [OAuth 2.0 guidance for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#oauth-20-authentication) to configure and authorize the connection.

<!-- END GENERATED:oauth -->

<!-- BEGIN GENERATED:table-exports -->

## Table exports

This connector supports table exports. Learn how to [set up a table export](../../data-connection/export-overview/index.md#table-exports).

<!-- END GENERATED:table-exports -->