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

# FreeAgent

> How to set up the FreeAgent connector, plus the actions that are available.

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

v1.1.4[See changelog](https://docs.stackone.com/connectors/freeagent/changelog.md)

[105 actions](#actions) · 1 auth method

Accounting

## 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/freeagent/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an app at the FreeAgent Developer Dashboard. Access tokens expire after 1 hour and are refreshed au...

**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/freeagent/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

105 actions

ActionDescription

List Bank Accounts`freeagent_list_bank_accounts`

Retrieve all bank accounts linked to the FreeAgent company, filterable by account type

Get Bank Account`freeagent_get_bank_account`

Retrieve a single bank account by its unique ID

Create Bank Account`freeagent_create_bank_account`

Create a new bank account in FreeAgent with a specified type, currency, and opening balance

Update Bank Account`freeagent_update_bank_account`

Update an existing bank account's name, bank name, or personal flag

Delete Bank Account`freeagent_delete_bank_account`

Permanently delete a bank account from FreeAgent

List Bank Transactions`freeagent_list_bank_transactions`

Retrieve all bank transactions for a specific bank account, with optional date, status, and upload filters

Get Bank Transaction`freeagent_get_bank_transaction`

Retrieve a single bank transaction by its unique ID, including full explanation details

Delete Bank Transaction`freeagent_delete_bank_transaction`

Permanently delete a bank transaction from FreeAgent

Upload Bank Statement`freeagent_upload_bank_statement`

Upload bank transactions as a JSON array to a specific bank account

List Bills`freeagent_list_bills`

Retrieve all bills (accounts payable) with optional filtering by contact, project, payment status, and date range

Get Bill`freeagent_get_bill`

Retrieve a single bill by ID, including bill items, payment status, and attachment details

Create Bill`freeagent_create_bill`

Create a new bill (accounts payable) in FreeAgent with one or more line items

Update Bill`freeagent_update_bill`

Update an existing bill's details, line items, or add/remove bill items

Delete Bill`freeagent_delete_bill`

Permanently delete a bill and its associated bill items from FreeAgent

List Categories`freeagent_list_categories`

Retrieve all accounting categories grouped by type (admin expenses, cost of sales, income, general)

Get Category`freeagent_get_category`

Retrieve a single accounting category by its nominal code

Create Category`freeagent_create_category`

Create a custom accounting category in FreeAgent

Update Category`freeagent_update_category`

Update a custom accounting category by nominal code

Delete Category`freeagent_delete_category`

Delete a user-created accounting category by nominal code

Get Company`freeagent_get_company`

Retrieve the authenticated company's profile, settings, and tax configuration

List Business Categories`freeagent_list_business_categories`

Retrieve all available business category values for the company profile

Get Tax Timeline`freeagent_get_tax_timeline`

Retrieve upcoming tax events and deadlines for the company

List Contacts`freeagent_list_contacts`

Retrieve all contacts (clients and suppliers) with optional filtering by type, status, and activity

Get Contact`freeagent_get_contact`

Retrieve a single contact by ID with full profile, balance, and CIS details

Create Contact`freeagent_create_contact`

Create a new contact (client or supplier) in FreeAgent

Update Contact`freeagent_update_contact`

Update an existing contact's details, address, invoice settings, or CIS configuration

Delete Contact`freeagent_delete_contact`

Permanently delete a contact from FreeAgent

List Credit Notes`freeagent_list_credit_notes`

Retrieve all credit notes with optional filtering by contact, project, status, and date

Get Credit Note`freeagent_get_credit_note`

Retrieve a single credit note by ID with full line item and payment details

Get Credit Note PDF`freeagent_get_credit_note_pdf`

Download a credit note as a base64-encoded PDF

Create Credit Note`freeagent_create_credit_note`

Create a new credit note in Draft status for a specified contact

Update Credit Note`freeagent_update_credit_note`

Update an existing credit note's details, line items, or display settings

Delete Credit Note`freeagent_delete_credit_note`

Permanently delete a credit note from FreeAgent

Email Credit Note`freeagent_email_credit_note`

Send a credit note via email (credit note must be in Open status, not Draft)

Mark Credit Note As Sent`freeagent_mark_credit_note_as_sent`

Transition a credit note from Draft to Open status, or re-open a cancelled credit note

Mark Credit Note As Draft`freeagent_mark_credit_note_as_draft`

Transition a credit note back to Draft status

List Estimates`freeagent_list_estimates`

Retrieve all estimates with optional filtering by contact, project, invoice, status, and date range

Get Estimate`freeagent_get_estimate`

Retrieve a single estimate by ID with full line items, status, and VAT details

Get Estimate PDF`freeagent_get_estimate_pdf`

Download an estimate as a base64-encoded PDF

Create Estimate`freeagent_create_estimate`

Create a new estimate, quote, or proposal in FreeAgent for a specified contact

Update Estimate`freeagent_update_estimate`

Update an existing estimate's details, notes, or display settings

Delete Estimate`freeagent_delete_estimate`

Permanently delete an estimate from FreeAgent (cannot delete estimates with Invoiced status)

Duplicate Estimate`freeagent_duplicate_estimate`

Create a copy of an existing estimate with Draft status and today's date

Email Estimate`freeagent_email_estimate`

Send an estimate via email with optional attachments or using an email template

Mark Estimate As Sent`freeagent_mark_estimate_as_sent`

Transition an estimate to Sent status

Mark Estimate As Draft`freeagent_mark_estimate_as_draft`

Transition an estimate back to Draft status

Mark Estimate As Approved`freeagent_mark_estimate_as_approved`

Transition an estimate to Approved status

Mark Estimate As Rejected`freeagent_mark_estimate_as_rejected`

Transition an estimate to Rejected status

Convert Estimate To Invoice`freeagent_convert_estimate_to_invoice`

Convert an approved estimate to an invoice, setting estimate status to Invoiced

Create Estimate Item`freeagent_create_estimate_item`

Add a new line item to an existing estimate

Update Estimate Item`freeagent_update_estimate_item`

Update an existing estimate line item

Delete Estimate Item`freeagent_delete_estimate_item`

Remove a line item from an estimate

Get Default Estimate Additional Text`freeagent_get_default_estimate_additional_text`

Retrieve the default additional text shown on all estimates

Update Default Estimate Additional Text`freeagent_update_default_estimate_additional_text`

Update the default additional text shown on all estimates

Delete Default Estimate Additional Text`freeagent_delete_default_estimate_additional_text`

Remove the default additional text from all estimates

List Expenses`freeagent_list_expenses`

Retrieve all out-of-pocket expenses with optional filtering by user, project, status, and date range

Get Expense`freeagent_get_expense`

Retrieve a single expense by ID with full category, tax, rebill, and attachment details

Create Expense`freeagent_create_expense`

Create a new out-of-pocket expense or mileage claim in FreeAgent

Update Expense`freeagent_update_expense`

Update an existing expense's details, tax, rebill settings, or recurring schedule

Delete Expense`freeagent_delete_expense`

Permanently delete an expense from FreeAgent

Get Mileage Settings`freeagent_get_mileage_settings`

Retrieve mileage rates and engine type/size options for expense claims

List Invoices`freeagent_list_invoices`

Retrieve all invoices with optional filtering by contact, project, status, date range, and sort order

Get Invoice`freeagent_get_invoice`

Retrieve a single invoice by ID with full line items, payment status, and payment methods

Get Invoice PDF`freeagent_get_invoice_pdf`

Download an invoice as a base64-encoded PDF

Create Invoice`freeagent_create_invoice`

Create a new draft invoice in FreeAgent with line items and optional auto-billing of timeslips, expenses, or estimates

Update Invoice`freeagent_update_invoice`

Update an existing invoice's details, line items, payment methods, or display settings

Delete Invoice`freeagent_delete_invoice`

Permanently delete an invoice from FreeAgent

Duplicate Invoice`freeagent_duplicate_invoice`

Create a copy of an existing invoice with Draft status and today's date

Email Invoice`freeagent_email_invoice`

Send an invoice via email with optional attachments, expense receipts, or using a template

Mark Invoice As Sent`freeagent_mark_invoice_as_sent`

Transition an invoice from Draft to Open status, or re-open a cancelled invoice

Mark Invoice As Scheduled`freeagent_mark_invoice_as_scheduled`

Transition an invoice to Scheduled To Email status

Mark Invoice As Draft`freeagent_mark_invoice_as_draft`

Transition an invoice back to Draft status

Mark Invoice As Cancelled`freeagent_mark_invoice_as_cancelled`

Write off an invoice as unpaid (must be sent with due date in the past)

Convert Invoice To Credit Note`freeagent_convert_invoice_to_credit_note`

Convert a draft negative invoice to a credit note

Take Direct Debit Payment`freeagent_take_invoice_direct_debit_payment`

Take payment for an invoice using a GoCardless Direct Debit Mandate

Get Invoice Timeline`freeagent_get_invoice_timeline`

Retrieve a timeline of invoice payment events and activities

Get Default Invoice Additional Text`freeagent_get_default_invoice_additional_text`

Retrieve the default additional text shown on all invoices

Update Default Invoice Additional Text`freeagent_update_default_invoice_additional_text`

Update the default additional text shown on all invoices

Delete Default Invoice Additional Text`freeagent_delete_default_invoice_additional_text`

Remove the default additional text from all invoices

List Projects`freeagent_list_projects`

Retrieve all projects with optional filtering by contact, status, sort order, and nested contact details

Get Project`freeagent_get_project`

Retrieve a single project by ID with full budget, billing, and IR35 details

Create Project`freeagent_create_project`

Create a new project in FreeAgent linked to a contact with budget, billing rate, and IR35 settings

Update Project`freeagent_update_project`

Update an existing project's name, status, budget, billing rate, or other settings

Delete Project`freeagent_delete_project`

Permanently delete a project from FreeAgent

List Recurring Invoices`freeagent_list_recurring_invoices`

Retrieve all recurring invoice profiles with optional filtering by contact, project, and status

Get Recurring Invoice`freeagent_get_recurring_invoice`

Retrieve a single recurring invoice by ID with full schedule, line items, and payment methods

List Tasks`freeagent_list_tasks`

Retrieve all tasks with optional filtering by project, status, date, and sort order

Get Task`freeagent_get_task`

Retrieve a single task by ID with full billing rate, status, and deletability info

Create Task`freeagent_create_task`

Create a new task under a specific project in FreeAgent

Update Task`freeagent_update_task`

Update an existing task's name, billing rate, status, or billable flag

Delete Task`freeagent_delete_task`

Permanently delete a task from FreeAgent

List Timeslips`freeagent_list_timeslips`

Retrieve all timeslips (time entries) with optional filtering by user, project, task, status, and date range

Get Timeslip`freeagent_get_timeslip`

Retrieve a single timeslip by ID with full hours, billing, and timer details

Create Timeslip`freeagent_create_timeslip`

Create a new timeslip (time entry) in FreeAgent for a user, task, and project

Update Timeslip`freeagent_update_timeslip`

Update an existing timeslip's hours, date, task, project, user, or comment

Delete Timeslip`freeagent_delete_timeslip`

Permanently delete a timeslip from FreeAgent

Start Timer`freeagent_start_timer`

Start a running timer on a timeslip to track time in real-time

Stop Timer`freeagent_stop_timer`

Stop a running timer on a timeslip and record the elapsed time

List Users`freeagent_list_users`

Retrieve all users with optional filtering by role type (staff, advisors, active)

Get User`freeagent_get_user`

Retrieve a single user by ID with full role, permissions, and tax details

Get Current User`freeagent_get_me`

Retrieve the authenticated user's personal profile (minimum Time access)

Create User`freeagent_create_user`

Create a new user with a specified role and permission level in FreeAgent

Update User`freeagent_update_user`

Update an existing user's details, role, or permissions

Update Current User`freeagent_update_me`

Update the authenticated user's own profile (minimum Time access)

Delete User`freeagent_delete_user`

Permanently delete a user from FreeAgent


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