Cloud-based accounting software for freelancers and small businesses
Toolkit · freeagent
v1
01Cashflow summary for a date rangetool
02Convert Estimate to Invoicetool
03Convert Invoice to Credit Notetool
04Create a Journal Settool
OAuth2 · verified
76T · 0TR
freeagent
Supported tools and triggers
Each tool is a typed function your agent can call. Each trigger fires an agent run when something changes upstream.
Cashflow summary for a date range
Tool to retrieve cashflow summary for a given date range from FreeAgent. Use when you need to analyze cash inflow and outflow over a specific period. Provides net cashflow balance, incoming and outgoing totals, and monthly breakdowns.
TOOL
Convert Estimate to Invoice
Tool to convert an estimate to an invoice in FreeAgent. Use when an estimate has been approved and needs to be converted into a billable invoice. The estimate's status will transition to 'Invoiced' and a new invoice will be created automatically.
TOOL
Convert Invoice to Credit Note
Tool to convert a draft negative invoice to a credit note in FreeAgent. Use when you need to transform a draft invoice with a negative value into a credit note. The invoice must be in draft status and have a negative value before conversion.
TOOL
Create a Journal Set
Tool to create a journal set in FreeAgent. Use when you need to create manual journal entries for accounting corrections or adjustments. All journal entries must balance to zero (total debits equal total credits).
TOOL
Create A Timeslip
Tool to create a new timeslip in FreeAgent. Use when you need to log time worked on a project task by a specific user on a given date.
TOOL
Create a User
Tool to create a new user in FreeAgent. Use when you need to add a new team member with specific role and permissions. Requires 'Tax, Accounting & Users' permission level.
TOOL
Create Bank Account
Tool to create a bank account in FreeAgent. Use when you need to add a new bank account, PayPal account, or credit card account to track financial transactions.
TOOL
Create Bill with Attachment
Tool to create a bill with optional attachment in FreeAgent. Use when you need to record a supplier bill with line items and optionally attach supporting documentation.
TOOL
Create Category
Tool to create a custom category in FreeAgent. Use when you need to add a new category for classifying income or costs. Note that tax_reporting_name is required for cost_of_sales, admin_expenses, current_assets, and liabilities. The allowable_for_tax field is required for cost_of_sales and admin_expenses.
TOOL
Create Contact
Tool to create a new contact in FreeAgent. Use when you need to add a new client, supplier, or business contact with their details.
TOOL
Create Credit Note
Tool to create a credit note in FreeAgent. Use when you need to issue a credit note to a contact for refunds or adjustments. The credit note is created with 'Draft' status.
TOOL
Create Credit Note Reconciliation
Tool to create a credit note reconciliation in FreeAgent. Use when you need to reconcile a credit note against an invoice, offsetting the invoice amount with the credit note.
TOOL
Create Estimate
Tool to create a new estimate in FreeAgent. Use when you need to create an estimate, quote, or proposal for a client. Requires contact, reference, date, type, status, and at least one estimate item with position, item_type, quantity, price, and description.
TOOL
Create Estimate Item
Tool to create an estimate item in FreeAgent. Use when you need to add a line item to an existing estimate with details like position, type, quantity, price, and optional description.
TOOL
Create Invoice
Tool to create an invoice in FreeAgent. Use when you need to generate a new invoice for a contact. The invoice will be created in 'Draft' status and can be modified or sent later.
TOOL
Create Invoice Item
Tool to create an invoice item in FreeAgent. Use when you need to add a line item to an existing invoice with details like type, quantity, price, and description.
TOOL
Create Note
Tool to create a note for a contact or project in FreeAgent. Use when you need to add documentation, reminders, or context to contacts or projects.
TOOL
Create Price List Item
Tool to create a price list item in FreeAgent. Use when you need to add a new item to the price list with code, description, pricing, and tax information.
TOOL
Create Project
Tool to create a project in FreeAgent. Use when you need to set up a new project for tracking time, expenses, and billing against a specific client or internal initiative.
TOOL
Create Sales Tax Period
Tool to create a sales tax period in FreeAgent. Use when you need to establish a new sales tax period with specific rates and settings for tax reporting.
TOOL
Create Task Under Project
Tool to create a task under a specific project in FreeAgent. Use when you need to add a new task to an existing project for tracking billable or non-billable work.
TOOL
Delete Bank Transaction Explanation
Tool to delete a bank transaction explanation in FreeAgent. Use when you need to remove an explanation from a bank transaction.
TOOL
Delete Estimates Default Additional Text
Tool to delete default additional text for estimates in FreeAgent. Use when you need to remove the default additional text that appears on estimates.
TOOL
Delete Note
Tool to delete a note by its ID. Use when you need to permanently remove a note from FreeAgent.
TOOL
Duplicate Estimate
Tool to duplicate an existing estimate in FreeAgent. Use when you need to create a copy of an estimate. The duplicated estimate will always have status=Draft, the next reference in the sequence, and dated_on set to today.
TOOL
Duplicate Invoice
Tool to duplicate an existing invoice in FreeAgent. Use when you need to create a new invoice based on an existing one. The duplicated invoice is always created with status 'Draft', today's date, and the next reference number in sequence.
TOOL
Get Balance Sheet
Tool to retrieve the balance sheet for a FreeAgent account. Use when you need to get financial position data including assets, liabilities, and equity. Returns balance sheet data for the specified date or current date if not specified.
TOOL
Get Company Details
Tool to retrieve company details from FreeAgent. Use when you need information about the company's registration, accounting periods, or settings.
TOOL
Get Default Additional Text
Tool to get the default additional text shown on all invoices. Use when you need to retrieve the default invoice text.
TOOL
Get Default Estimates Additional Text
Tool to retrieve the default additional text for estimates. Use when you need to get the default text that appears on all estimate documents.
TOOL
Get Invoice Timeline
Tool to retrieve invoice timeline showing chronological record of invoice-related events. Use when you need to track invoice payment history and related activities.
TOOL
Get Mileage Settings
Tool to retrieve mileage settings including engine type/size options and reimbursement rates. Use when you need to determine valid engine configurations or current mileage rates for expense claims.
TOOL
Get Opening Balances
Tool to retrieve the Opening Balances journal set for a company. Use when you need to access initial account balances including journal entries, bank accounts, and stock items.
TOOL
Get Opening Balances
Tool to retrieve opening balances for the balance sheet from FreeAgent. Use when you need to get the initial financial position values including capital assets, current assets, liabilities, and equity.
TOOL
Get Personal Profile
Tool to retrieve the authenticated user's personal profile from FreeAgent. Use when you need information about the current user's details, role, or permissions.
TOOL
Get the Opening Balances
Tool to retrieve the opening balances from the trial balance summary. Use when you need to get the initial balance amounts for all account categories at the start of the accounting period.
TOOL
Get the P&L summary
Tool to retrieve the Profit and Loss summary for a specified period from FreeAgent. Use when you need financial performance overview including income, expenses, and retained profit.
TOOL
Get Trial Balance Summary
Tool to get the trial balance summary from FreeAgent. Use when you need to retrieve the trial balance report data for accounting purposes.
TOOL
List Accounting Transactions
Tool to list all accounting transactions from FreeAgent. Use when you need to retrieve transaction history for accounting purposes. Filter by date range or nominal code to narrow results.
TOOL
List All CIS Bands
Tool to list all CIS (Construction Industry Scheme) bands for a company. Use when you need to retrieve the available CIS bands configured for a UK company enrolled in CIS for Subcontractors. The bands include gross, standard, and higher rate bands with their respective deduction rates and nominal codes.
TOOL
List All Expenses
Tool to list all expenses from FreeAgent. Use when you need to retrieve expense records, optionally filtered by view type (recent/recurring), date range, project, or last update timestamp.
TOOL
List All Price List Items
Tool to list all price list items from FreeAgent. Use when you need to retrieve all price list items with optional sorting by creation date, code, or update date.
TOOL
List All Properties
Tool to list all properties in FreeAgent. Use when you need to retrieve property records for UK unincorporated landlord companies. Supports pagination for large result sets.
TOOL
List All Recurring Invoices
Tool to retrieve a list of recurring invoices from FreeAgent. Use when you need to query recurring invoices by status or contact. Supports filtering by draft, active, or inactive status and can include nested invoice line items.
TOOL
List All Sales Tax Periods
Tool to list all sales tax periods for a company in FreeAgent. Use when you need to retrieve sales tax configuration history including rates, registration status, and effective dates. Available for US and Universal companies only.
TOOL
List All Stock Items
Tool to list all stock items from FreeAgent. Use when you need to retrieve stock items with optional sorting by creation date, description, or update date.
TOOL
List All Tasks
Tool to list all tasks in FreeAgent. Use when you need to retrieve tasks with optional filtering by status, project, or update date, and sorting options.
TOOL
List All Timeslips
Tool to list all timeslips from FreeAgent. Use when you need to retrieve time tracking records with optional filtering by date range, user, project, task, billing status, or last update timestamp.
TOOL
List All Users
Tool to list users in FreeAgent. Use when you need to retrieve users with optional filtering by type (all, staff, advisors). Requires 'Tax, Accounting & Users' permission scope.
TOOL
List Bank Accounts
Tool to list bank accounts in FreeAgent. Use when you need to retrieve all bank accounts or filter by account type (standard, credit card, or PayPal).
TOOL
List Bank Feeds
Tool to list all bank feeds for a company. Use when you need to retrieve the list of bank feeds and their current status.
TOOL
List Bank Transactions
Tool to list all bank transactions under a certain bank account in FreeAgent. Use when you need to retrieve transaction history, reconcile accounts, or find specific transactions for a bank account.
TOOL
List Bills
Tool to retrieve a list of bills from FreeAgent. Use when you need to view bills with optional filters by status, date range, contact, or project.
TOOL
List Business Categories
Tool to retrieve all available business categories from FreeAgent. Use when you need to get the complete list of industry classifications for company categorization.
TOOL
List Categories
Tool to retrieve all categories for the current FreeAgent company. Categories are used to classify income or costs for estimate items, invoice items, expenses, bills, and bank transaction explanations. Returns four category sets: admin expenses, cost of sales, income, and general. Use sub_accounts parameter to include sub-accounts instead of top-level accounts.
TOOL
List Contacts
Tool to list contacts in FreeAgent. Use when you need to retrieve contacts with optional filtering by type, sort order, or update date.
TOOL
List Credit Note Reconciliations
Tool to retrieve all credit note reconciliations from FreeAgent. Use when you need to list credit notes that have been reconciled against invoices. Optionally filter by update timestamp or date range.
TOOL
List Credit Notes
Tool to list credit notes from FreeAgent. Use when you need to retrieve credit notes with optional filtering by contact, project, status, or date range. Requires 'Estimates and Invoices' permission.
TOOL
List EC MOSS Sales Tax Rates
Tool to retrieve EC VAT MOSS sales tax rates for a specific EU country and date. Use when you need to determine the applicable VAT rates for cross-border digital services within the EU.
TOOL
List Estimates
Tool to list estimates in FreeAgent. Use when you need to retrieve estimates with optional filtering by status, date range, contact, project, or invoice. Set nested_estimate_items to true to include estimate items in the response.
TOOL
List Final Accounts Reports
Tool to list final accounts reports for a company in FreeAgent. Use when you need to retrieve all final accounts reports with their filing status and period dates.
TOOL
List Hire Purchases
Tool to retrieve all hire purchases for the authorized FreeAgent account. Use when you need to view existing hire purchase agreements. Requires 'Bills' access level and is only available for UK companies.
TOOL
List Notes
Tool to retrieve a list of notes for a contact or project. Use when you need to view all notes associated with a specific contact or project.
TOOL
List Projects
Tool to list projects in FreeAgent. Use when you need to retrieve projects with optional filtering by status and sorting. Requires 'Contacts and Projects' permission scope.
TOOL
List VAT Returns
Tool to list VAT returns for a company in FreeAgent. Use when you need to retrieve VAT return records, their filing status, and payment information.
TOOL
Send Estimate Email
Tool to email an estimate in FreeAgent. Use when you need to send an estimate to a contact via email with customizable subject, body, and attachments. You can use an existing email template (use_template=true) or provide manual email fields.
TOOL
Show Tax Timeline
Tool to retrieve the company's tax timeline showing upcoming tax events and deadlines. Use when you need to view VAT returns, corporation tax payments, Companies House filings, and other tax-related events with their due dates and amounts.
TOOL
Update a Journal Set
Tool to update a journal set in FreeAgent. Use when you need to modify journal entries, change description, date, or tag. Can add new entries, modify existing ones, or remove entries using _destroy flag.
TOOL
Update Bank Transaction Explanation
Tool to update a bank transaction explanation in FreeAgent. Use when you need to modify an existing explanation's details such as description, category, amounts, or tax information.
TOOL
Update Estimates Default Additional Text
Tool to update the default additional text for estimates in FreeAgent. Use when you need to set or change the standard text that appears on all estimates.
TOOL
Update Expense
Tool to update an existing expense in FreeAgent. Use when you need to modify expense details such as description, amount, date, category, or tax information. Only the fields you provide will be updated; omitted fields remain unchanged.
TOOL
Update Invoices Default Additional Text
Tool to update the default additional text shown on all invoices. Use when you need to set or change the default invoice text that appears at the bottom of all invoices.
TOOL
Update Note
Tool to update an existing note in FreeAgent. Use when you need to modify the text content of a note attached to a contact or project.
TOOL
Update Personal Profile
Tool to update the authenticated user's personal profile in FreeAgent. Use when you need to modify user details such as name, email, role, or tax information.
TOOL
Update Price List Item
Tool to update a price list item in FreeAgent. Use when you need to modify existing price list item fields like description, price, code, quantity, or tax settings.
TOOL
Upload a Bank Statement
Tool to upload a bank statement to FreeAgent. Use when you need to import multiple bank transactions at once for a specific bank account.