Actions

105 actions

Action

Description

List Bank Accounts

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

Get Bank Account

Retrieve a single bank account by its unique ID

Create Bank Account

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

Update Bank Account

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

Delete Bank Account

Permanently delete a bank account from FreeAgent

List Bank Transactions

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

Get Bank Transaction

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

Delete Bank Transaction

Permanently delete a bank transaction from FreeAgent

Upload Bank Statement

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

List Bills

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

Get Bill

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

Create Bill

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

Update Bill

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

Delete Bill

Permanently delete a bill and its associated bill items from FreeAgent

List Categories

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

Get Category

Retrieve a single accounting category by its nominal code

Create Category

Create a custom accounting category in FreeAgent

Update Category

Update a custom accounting category by nominal code

Delete Category

Delete a user-created accounting category by nominal code

Get Company

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

List Business Categories

Retrieve all available business category values for the company profile

Get Tax Timeline

Retrieve upcoming tax events and deadlines for the company

List Contacts

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

Get Contact

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

Create Contact

Create a new contact (client or supplier) in FreeAgent

Update Contact

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

Delete Contact

Permanently delete a contact from FreeAgent

List Credit Notes

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

Get Credit Note

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

Get Credit Note PDF

Download a credit note as a base64-encoded PDF

Create Credit Note

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

Update Credit Note

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

Delete Credit Note

Permanently delete a credit note from FreeAgent

Email Credit Note

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

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

Transition a credit note back to Draft status

List Estimates

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

Get Estimate

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

Get Estimate PDF

Download an estimate as a base64-encoded PDF

Create Estimate

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

Update Estimate

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

Delete Estimate

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

Duplicate Estimate

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

Email Estimate

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

Mark Estimate As Sent

Transition an estimate to Sent status

Mark Estimate As Draft

Transition an estimate back to Draft status

Mark Estimate As Approved

Transition an estimate to Approved status

Mark Estimate As Rejected

Transition an estimate to Rejected status

Convert Estimate To Invoice

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

Create Estimate Item

Add a new line item to an existing estimate

Update Estimate Item

Update an existing estimate line item

Delete Estimate Item

Remove a line item from an estimate

Get Default Estimate Additional Text

Retrieve the default additional text shown on all estimates

Update Default Estimate Additional Text

Update the default additional text shown on all estimates

Delete Default Estimate Additional Text

Remove the default additional text from all estimates

List Expenses

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

Get Expense

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

Create Expense

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

Update Expense

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

Delete Expense

Permanently delete an expense from FreeAgent

Get Mileage Settings

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

List Invoices

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

Get Invoice

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

Get Invoice PDF

Download an invoice as a base64-encoded PDF

Create Invoice

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

Update Invoice

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

Delete Invoice

Permanently delete an invoice from FreeAgent

Duplicate Invoice

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

Email Invoice

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

Mark Invoice As Sent

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

Mark Invoice As Scheduled

Transition an invoice to Scheduled To Email status

Mark Invoice As Draft

Transition an invoice back to Draft status

Mark Invoice As Cancelled

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

Convert Invoice To Credit Note

Convert a draft negative invoice to a credit note

Take Direct Debit Payment

Take payment for an invoice using a GoCardless Direct Debit Mandate

Get Invoice Timeline

Retrieve a timeline of invoice payment events and activities

Get Default Invoice Additional Text

Retrieve the default additional text shown on all invoices

Update Default Invoice Additional Text

Update the default additional text shown on all invoices

Delete Default Invoice Additional Text

Remove the default additional text from all invoices

List Projects

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

Get Project

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

Create Project

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

Update Project

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

Delete Project

Permanently delete a project from FreeAgent

List Recurring Invoices

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

Get Recurring Invoice

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

List Tasks

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

Get Task

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

Create Task

Create a new task under a specific project in FreeAgent

Update Task

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

Delete Task

Permanently delete a task from FreeAgent

List Timeslips

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

Get Timeslip

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

Create Timeslip

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

Update Timeslip

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

Delete Timeslip

Permanently delete a timeslip from FreeAgent

Start Timer

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

Stop Timer

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

List Users

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

Get User

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

Get Current User

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

Create User

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

Update User

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

Update Current User

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

Delete User

Permanently delete a user from FreeAgent