> ## 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

> How to set up the FreshBooks connector, plus the actions and events that are available.

![FreshBooks](https://stackone-logos.com/api/freshbooks/filled/svg)

Previewv2.3.0[See changelog](https://docs.stackone.com/connectors/freshbooks/changelog.md)

[89 actions](#actions) · [48 events](#events) · 1 auth method

Accounting
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

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).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/freshbooks/guides/connector-profile/oauth-2-0.md)
>
> Connect your FreshBooks account to access your accounting data.

Optionally, configure receiving Events for FreshBooks into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/freshbooks/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/freshbooks/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

user:account:read

user:account:write

user:bill\_payments:read

user:billable\_items:read

user:billable\_items:write

user:bills:read

user:clients:read

user:clients:write

user:credit\_notes:read

user:credit\_notes:write

user:estimates:read

user:estimates:write

user:expenses:read

user:expenses:write

user:invoices:read

user:invoices:write

user:journal\_entries:read

user:journal\_entries:write

user:other\_income:read

user:other\_income:write

user:payments:read

user:payments:write

user:profile:read

user:projects:read

user:projects:write

user:reports:read

user:taxes:read

user:taxes:write

user:teams:read

user:time\_entries:read

user:time\_entries:write

No scopes found

89 actions

ActionDescriptionRequired scopes

List Bills`freshbooks_list_bills`

Retrieve a paginated list of vendor bills for the account.

`user:bills:read`

List Bill Payments`freshbooks_list_bill_payments`

Retrieve a paginated list of bill payments for the account.

`user:bill_payments:read`

List Accounts`freshbooks_list_accounts`

Retrieve a paginated list of chart of accounts entries for the business.

`user:account:read`

Get Account`freshbooks_get_account`

Retrieve a single chart of accounts entry by UUID.

`user:account:read`

Create Account`freshbooks_create_account`

Create a new account in the chart of accounts.

`user:account:write`

List Clients`freshbooks_list_clients`

Retrieve a paginated list of clients for the account.

`user:clients:read`

Get Client`freshbooks_get_client`

Retrieve a single client by ID.

`user:clients:read`

Create Client`freshbooks_create_client`

Create a new client in the account.

`user:clients:write`

Update Client`freshbooks_update_client`

Update an existing client's information.

`user:clients:write`

Archive Client`freshbooks_archive_client`

Archive a client by setting their visibility state to deleted.

`user:clients:write`

List Credits`freshbooks_list_credits`

Retrieve a paginated list of credit notes for the account.

`user:credit_notes:read`

Get Credit`freshbooks_get_credit`

Retrieve a single credit note by ID.

`user:credit_notes:read`

Create Credit`freshbooks_create_credit`

Create a new credit note for a client.

`user:credit_notes:write`

Update Credit`freshbooks_update_credit`

Update an existing credit note.

`user:credit_notes:write`

Archive Credit`freshbooks_archive_credit`

Archive a credit note by setting its visibility state to deleted.

`user:credit_notes:write`

List Estimates`freshbooks_list_estimates`

Retrieve a paginated list of estimates for the account.

`user:estimates:read`

Get Estimate`freshbooks_get_estimate`

Retrieve a single estimate by ID.

`user:estimates:read`

Create Estimate`freshbooks_create_estimate`

Create a new estimate for a client.

`user:estimates:write`

Update Estimate`freshbooks_update_estimate`

Update an existing estimate's details.

`user:estimates:write`

Archive Estimate`freshbooks_archive_estimate`

Archive an estimate by setting its visibility state to deleted.

`user:estimates:write`

List Expense Categories`freshbooks_list_expense_categories`

Retrieve a paginated list of expense categories for the account.

`user:expenses:read`

Get Expense Category`freshbooks_get_expense_category`

Retrieve a single expense category by ID.

`user:expenses:read`

List Expenses`freshbooks_list_expenses`

Retrieve a paginated list of expenses for the account.

`user:expenses:read`

Get Expense`freshbooks_get_expense`

Retrieve a single expense record by ID.

`user:expenses:read`

Create Expense`freshbooks_create_expense`

Create a new expense record.

`user:expenses:write`

Update Expense`freshbooks_update_expense`

Update an existing expense record.

`user:expenses:write`

Archive Expense`freshbooks_archive_expense`

Archive an expense by setting its visibility state to deleted.

`user:expenses:write`

Get Unified Credentials`freshbooks_unified_get_me`

Get the current FreshBooks connection's unified credentials and identity.

`user:profile:read`

List Unified Organizations`freshbooks_unified_list_organizations`

List every FreshBooks business the connection can access.

`user:profile:read`

Get Unified Organization`freshbooks_unified_get_organization`

Get a single FreshBooks business by ID, mapped to the IAM unified organization schema.

`user:profile:read`

List Unified Roles`freshbooks_unified_list_roles`

List the synthesized workspace-level unified roles for FreshBooks.

`user:profile:read`

Get Unified Role`freshbooks_unified_get_role`

Get a unified FreshBooks role by its stable synthesized key.

`user:profile:read`

List Unified Users`freshbooks_unified_list_users`

List unified users (team members) in FreshBooks.

`user:teams:read`

Get Unified User`freshbooks_unified_get_user`

Get a unified FreshBooks team member by ID.

`user:teams:read`

Get Current User`freshbooks_get_current_user`

Retrieve the authenticated user's identity, profile, and business memberships.

`user:profile:read`

List Invoices`freshbooks_list_invoices`

Retrieve a paginated list of invoices for the account.

`user:invoices:read`

Get Invoice`freshbooks_get_invoice`

Retrieve a single invoice by ID.

`user:invoices:read`

Create Invoice`freshbooks_create_invoice`

Create a new invoice for a client.

`user:invoices:write`

Update Invoice`freshbooks_update_invoice`

Update an existing invoice's details.

`user:invoices:write`

Archive Invoice`freshbooks_archive_invoice`

Archive an invoice by setting its visibility state to deleted.

`user:invoices:write`

List Items`freshbooks_list_items`

Retrieve a paginated list of items (products and services) for the account.

`user:billable_items:read`

Get Item`freshbooks_get_item`

Retrieve a single item by ID.

`user:billable_items:read`

Create Item`freshbooks_create_item`

Create a new item (product or service) for the account.

`user:billable_items:write`

Update Item`freshbooks_update_item`

Update an existing item's details.

`user:billable_items:write`

Archive Item`freshbooks_archive_item`

Archive an item by setting its visibility state to deleted.

`user:billable_items:write`

List Journal Entries`freshbooks_list_journal_entries`

Retrieve a paginated list of adjustment journal entries.

`user:journal_entries:read`

Create Journal Entry`freshbooks_create_journal_entry`

Create a new adjustment journal entry.

`user:journal_entries:write`

Update Journal Entry`freshbooks_update_journal_entry`

Update an existing adjustment journal entry.

`user:journal_entries:write`

List Journal Entries By Account`freshbooks_list_journal_entries_by_account`

Retrieve journal entries for a specific account.

`user:journal_entries:read`

List Other Income`freshbooks_list_other_income`

Retrieve a paginated list of other income entries for the account.

`user:other_income:read`

Get Other Income`freshbooks_get_other_income`

Retrieve a single other income entry by ID.

`user:other_income:read`

Create Other Income`freshbooks_create_other_income`

Create a new other income entry.

`user:other_income:write`

Update Other Income`freshbooks_update_other_income`

Update an existing other income entry.

`user:other_income:write`

Delete Other Income`freshbooks_delete_other_income`

Delete (soft-delete) an other income entry.

`user:other_income:write`

List Payments`freshbooks_list_payments`

Retrieve a paginated list of payments applied to invoices.

`user:payments:read`

Get Payment`freshbooks_get_payment`

Retrieve a single payment record by ID.

`user:payments:read`

Create Payment`freshbooks_create_payment`

Record a new payment applied to an invoice.

`user:payments:write`

Update Payment`freshbooks_update_payment`

Update an existing payment record.

`user:payments:write`

Archive Payment`freshbooks_archive_payment`

Archive a payment by setting its visibility state to deleted.

`user:payments:write`

Get Account Aging Report`freshbooks_get_account_aging_report`

Retrieve the account aging report showing overdue invoice amounts by time interval.

`user:reports:read`

Get Balance Sheet Report`freshbooks_get_balance_sheet_report`

Retrieve the balance sheet report showing assets, liabilities, and equity.

`user:reports:read`

Get Cash Flow Report`freshbooks_get_cash_flow_report`

Retrieve the cash flow report showing operating, investing, and financing activities.

`user:reports:read`

Get Expense Details Report`freshbooks_get_expense_details_report`

Retrieve the expense details report showing all expenses grouped by category, client, vendor, or author.

`user:reports:read`

Get General Ledger Report`freshbooks_get_general_ledger_report`

Retrieve the general ledger report showing all account transactions with debits and credits.

`user:reports:read`

List Projects`freshbooks_list_projects`

Retrieve a paginated list of projects for the business.

`user:projects:read`

Get Project`freshbooks_get_project`

Retrieve a single project by ID.

`user:projects:read`

Create Project`freshbooks_create_project`

Create a new project for a client.

`user:projects:write`

Update Project`freshbooks_update_project`

Update an existing project's details.

`user:projects:write`

Delete Project`freshbooks_delete_project`

Delete (soft-delete) a project.

`user:projects:write`

List Services`freshbooks_list_services`

Retrieve a paginated list of services for the business.

`user:billable_items:read`

Get Service`freshbooks_get_service`

Retrieve a single service by ID.

`user:billable_items:read`

Create Service`freshbooks_create_service`

Create a new service for the business.

`user:billable_items:write`

Get Service Rate`freshbooks_get_service_rate`

Retrieve the hourly rate for a service.

`user:billable_items:read`

Create Service Rate`freshbooks_create_service_rate`

Set the hourly rate for a service.

`user:billable_items:write`

Update Service Rate`freshbooks_update_service_rate`

Update the hourly rate for a service.

`user:billable_items:write`

List Staff`freshbooks_list_staff`

Retrieve a paginated list of staff members for the account.

`user:teams:read`

Get Staff`freshbooks_get_staff`

Retrieve a single staff member by ID.

`user:teams:read`

List Taxes`freshbooks_list_taxes`

Retrieve a list of tax definitions for the account.

`user:taxes:read`

Get Tax`freshbooks_get_tax`

Retrieve a single tax definition by ID.

`user:taxes:read`

Create Tax`freshbooks_create_tax`

Create a new tax definition for the account.

`user:taxes:write`

Update Tax`freshbooks_update_tax`

Update an existing tax definition.

`user:taxes:write`

Delete Tax`freshbooks_delete_tax`

Permanently delete a tax definition.

`user:taxes:write`

List Team Members`freshbooks_list_team_members`

Retrieve a paginated list of team members for the business.

`user:teams:read`

Get Team Member`freshbooks_get_team_member`

Retrieve a single team member by UUID.

`user:teams:read`

List Time Entries`freshbooks_list_time_entries`

Retrieve a paginated list of time entries for the business.

`user:time_entries:read`

Get Time Entry`freshbooks_get_time_entry`

Retrieve a single time entry by ID.

`user:time_entries:read`

Create Time Entry`freshbooks_create_time_entry`

Log a new time entry for a project or client.

`user:time_entries:write`

Update Time Entry`freshbooks_update_time_entry`

Update an existing time entry's details.

`user:time_entries:write`

Delete Time Entry`freshbooks_delete_time_entry`

Delete (soft-delete) a time entry.

`user:time_entries:write`

## Events

Tags

Select all
|
Clear

Bill Vendors

Bills

Clients

Credit Notes

Estimates

Expense Categories

Expenses

Health Checks

Invoices

Items

Payments

Projects

Recurring Invoices

Services

Taxes

Time Entries

Webhooks

No tags found

48 events

EventDescriptionTags

Active Check`freshbooks_webhook_active_check`

Answers FreshBooks' callback verification request, sent to the webhook URL after StackOne registers each callback, by co...

Health ChecksWebhooks

Invoice Created`freshbooks_webhook_invoice_create`

Fires when an invoice is created in FreshBooks (invoice.create).

InvoicesWebhooks

Invoice Updated`freshbooks_webhook_invoice_update`

Fires when an invoice is updated in FreshBooks (invoice.update).

InvoicesWebhooks

Invoice Deleted`freshbooks_webhook_invoice_delete`

Fires when an invoice is deleted in FreshBooks (invoice.delete).

InvoicesWebhooks

Invoice Sent by Email`freshbooks_webhook_invoice_send_by_email`

Fires when an invoice is sent to a client by email in FreshBooks (invoice.sendByEmail).

InvoicesWebhooks

Recurring Invoice Profile Created`freshbooks_webhook_recurring_create`

Fires when a recurring invoice profile is created in FreshBooks (recurring.create).

Recurring InvoicesWebhooks

Recurring Invoice Profile Updated`freshbooks_webhook_recurring_update`

Fires when a recurring invoice profile is updated in FreshBooks (recurring.update).

Recurring InvoicesWebhooks

Recurring Invoice Profile Deleted`freshbooks_webhook_recurring_delete`

Fires when a recurring invoice profile is deleted in FreshBooks (recurring.delete).

Recurring InvoicesWebhooks

Estimate Created`freshbooks_webhook_estimate_create`

Fires when an estimate is created in FreshBooks (estimate.create).

EstimatesWebhooks

Estimate Updated`freshbooks_webhook_estimate_update`

Fires when an estimate is updated in FreshBooks (estimate.update).

EstimatesWebhooks

Estimate Deleted`freshbooks_webhook_estimate_delete`

Fires when an estimate is deleted in FreshBooks (estimate.delete).

EstimatesWebhooks

Estimate Sent by Email`freshbooks_webhook_estimate_send_by_email`

Fires when an estimate is sent to a client by email in FreshBooks (estimate.sendByEmail).

EstimatesWebhooks

Credit Note Created`freshbooks_webhook_credit_note_create`

Fires when a credit note is created in FreshBooks (credit\_note.create).

Credit NotesWebhooks

Credit Note Updated`freshbooks_webhook_credit_note_update`

Fires when a credit note is updated in FreshBooks (credit\_note.update).

Credit NotesWebhooks

Credit Note Deleted`freshbooks_webhook_credit_note_delete`

Fires when a credit note is deleted in FreshBooks (credit\_note.delete).

Credit NotesWebhooks

Payment Created`freshbooks_webhook_payment_create`

Fires when an invoice payment is created in FreshBooks (payment.create).

PaymentsWebhooks

Payment Updated`freshbooks_webhook_payment_update`

Fires when an invoice payment is updated in FreshBooks (payment.update).

PaymentsWebhooks

Payment Deleted`freshbooks_webhook_payment_delete`

Fires when an invoice payment is deleted in FreshBooks (payment.delete).

PaymentsWebhooks

Client Created`freshbooks_webhook_client_create`

Fires when a client is created in FreshBooks (client.create).

ClientsWebhooks

Client Updated`freshbooks_webhook_client_update`

Fires when a client is updated in FreshBooks (client.update).

ClientsWebhooks

Client Deleted`freshbooks_webhook_client_delete`

Fires when a client is deleted in FreshBooks (client.delete).

ClientsWebhooks

Expense Created`freshbooks_webhook_expense_create`

Fires when an expense is created in FreshBooks (expense.create).

ExpensesWebhooks

Expense Updated`freshbooks_webhook_expense_update`

Fires when an expense is updated in FreshBooks (expense.update).

ExpensesWebhooks

Expense Deleted`freshbooks_webhook_expense_delete`

Fires when an expense is deleted in FreshBooks (expense.delete).

ExpensesWebhooks

Expense Category Created`freshbooks_webhook_category_create`

Fires when an expense category is created in FreshBooks (category.create).

Expense CategoriesWebhooks

Expense Category Updated`freshbooks_webhook_category_update`

Fires when an expense category is updated in FreshBooks (category.update).

Expense CategoriesWebhooks

Expense Category Deleted`freshbooks_webhook_category_delete`

Fires when an expense category is deleted in FreshBooks (category.delete).

Expense CategoriesWebhooks

Bill Created`freshbooks_webhook_bill_create`

Fires when a vendor bill is created in FreshBooks (bill.create).

BillsWebhooks

Bill Updated`freshbooks_webhook_bill_update`

Fires when a vendor bill is updated in FreshBooks (bill.update).

BillsWebhooks

Bill Deleted`freshbooks_webhook_bill_delete`

Fires when a vendor bill is deleted in FreshBooks (bill.delete).

BillsWebhooks

Bill Vendor Created`freshbooks_webhook_bill_vendor_create`

Fires when a bill vendor is created in FreshBooks (bill\_vendor.create).

Bill VendorsWebhooks

Bill Vendor Updated`freshbooks_webhook_bill_vendor_update`

Fires when a bill vendor is updated in FreshBooks (bill\_vendor.update).

Bill VendorsWebhooks

Bill Vendor Deleted`freshbooks_webhook_bill_vendor_delete`

Fires when a bill vendor is deleted in FreshBooks (bill\_vendor.delete).

Bill VendorsWebhooks

Item Created`freshbooks_webhook_item_create`

Fires when a billable item is created in FreshBooks (item.create).

ItemsWebhooks

Item Updated`freshbooks_webhook_item_update`

Fires when a billable item is updated in FreshBooks (item.update).

ItemsWebhooks

Item Deleted`freshbooks_webhook_item_delete`

Fires when a billable item is deleted in FreshBooks (item.delete).

ItemsWebhooks

Service Created`freshbooks_webhook_service_create`

Fires when a service is created in FreshBooks (service.create).

ServicesWebhooks

Service Updated`freshbooks_webhook_service_update`

Fires when a service is updated in FreshBooks (service.update).

ServicesWebhooks

Service Deleted`freshbooks_webhook_service_delete`

Fires when a service is deleted in FreshBooks (service.delete).

ServicesWebhooks

Tax Created`freshbooks_webhook_tax_create`

Fires when a tax is created in FreshBooks (tax.create).

TaxesWebhooks

Tax Updated`freshbooks_webhook_tax_update`

Fires when a tax is updated in FreshBooks (tax.update).

TaxesWebhooks

Tax Deleted`freshbooks_webhook_tax_delete`

Fires when a tax is deleted in FreshBooks (tax.delete).

TaxesWebhooks

Project Created`freshbooks_webhook_project_create`

Fires when a project is created in FreshBooks (project.create).

ProjectsWebhooks

Project Updated`freshbooks_webhook_project_update`

Fires when a project is updated in FreshBooks (project.update).

ProjectsWebhooks

Project Deleted`freshbooks_webhook_project_delete`

Fires when a project is deleted in FreshBooks (project.delete).

ProjectsWebhooks

Time Entry Created`freshbooks_webhook_time_entry_create`

Fires when a time entry is created in FreshBooks (time\_entry.create).

Time EntriesWebhooks

Time Entry Updated`freshbooks_webhook_time_entry_update`

Fires when a time entry is updated in FreshBooks (time\_entry.update).

Time EntriesWebhooks

Time Entry Deleted`freshbooks_webhook_time_entry_delete`

Fires when a time entry is deleted in FreshBooks (time\_entry.delete).

Time EntriesWebhooks


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