# Documentation **URL:** https://api-discuss.freeagent.com/c/documentation/8.md [Latest](https://api-discuss.freeagent.com/latest.md) · [Categories](https://api-discuss.freeagent.com/categories.md) --- ## [About the Documentation category](https://api-discuss.freeagent.com/t/about-the-documentation-category/633)
**Author:** [@Olly](https://api-discuss.freeagent.com/u/Olly)\ **Replies:** 0
This category is for discussions relating to our API documentation. --- ## [Batch-create expenses, and Estimate status inconsistencies](https://api-discuss.freeagent.com/t/batch-create-expenses-and-estimate-status-inconsistencies/6753)
**Author:** [@George\_JTL](https://api-discuss.freeagent.com/u/George_JTL)\ **Replies:** 1\ **Last updated:** [1 October 2026 13:42 UTC](https://api-discuss.freeagent.com/t/batch-create-expenses-and-estimate-status-inconsistencies/6753 "2026-10-01T13:42:26Z")
We’re building an import tool against the FreeAgent v2 API (sandbox) and ran into three things worth flagging to the docs/API team - one missing documentation, two behaviours that don’t match what’s documented. All reque… --- ## [OpenAPI (Swagger) Definition For FreeAgent API?](https://api-discuss.freeagent.com/t/openapi-swagger-definition-for-freeagent-api/2815)
**Author:** [@tictag](https://api-discuss.freeagent.com/u/tictag)\ **Replies:** 6\ **Last updated:** [24 September 2026 12:17 UTC](https://api-discuss.freeagent.com/t/openapi-swagger-definition-for-freeagent-api/2815 "2026-09-24T12:17:14Z")
There have been many previous requests for an OpenAPI (Swagger) Definition for the FreeAgent API over the years (e.g. here, here, here and more recently here). Was this ever created? Similar to previous requests, I am … --- ## [API and Account](https://api-discuss.freeagent.com/t/api-and-account/6652)
**Author:** [@Isaac35](https://api-discuss.freeagent.com/u/Isaac35)\ **Replies:** 1\ **Last updated:** [10 August 2026 08:07 UTC](https://api-discuss.freeagent.com/t/api-and-account/6652 "2026-08-10T08:07:20Z")
Hi, Just to check can we access all the accounts values and report in the API? Thanks, --- ## [Bank Account Type List](https://api-discuss.freeagent.com/t/bank-account-type-list/6596)
**Author:** [@Yoshi](https://api-discuss.freeagent.com/u/Yoshi)\ **Replies:** 2\ **Last updated:** [22 July 2026 18:14 UTC](https://api-discuss.freeagent.com/t/bank-account-type-list/6596 "2026-07-22T18:14:08Z")
Hi, is there a list of types of Bank Account of Bank Account API? API document only lists 3 types, but I’m sure that more type values are used. Thanks in advance, --- ## [Sandbox testing with stripe test mode](https://api-discuss.freeagent.com/t/sandbox-testing-with-stripe-test-mode/6577)
**Author:** [@Grahamne\_Muir](https://api-discuss.freeagent.com/u/Grahamne_Muir)\ **Replies:** 1\ **Last updated:** [17 June 2026 09:52 UTC](https://api-discuss.freeagent.com/t/sandbox-testing-with-stripe-test-mode/6577 "2026-06-17T09:52:39Z")
Hey folks Im just wondering if theres any guidance on how to connect a bank feed in the sandbox to a test mode stripe account so I can test my invoicing flows locally. Im able to create invoices ok but I cant figure out… --- ## [Customer Invoices API - Max Number of Invoices Lines](https://api-discuss.freeagent.com/t/customer-invoices-api-max-number-of-invoices-lines/6121)
**Author:** [@cegan](https://api-discuss.freeagent.com/u/cegan)\ **Replies:** 2\ **Last updated:** [2 June 2026 16:56 UTC](https://api-discuss.freeagent.com/t/customer-invoices-api-max-number-of-invoices-lines/6121 "2026-06-02T16:56:40Z")
Hello Team, What is the MAX number of Customer Invoices Lines can I create for one Customer Invoice using Freeagent apis? I have a client who may become interested in FreeAgent but they have over 5,000 lines on a single … --- ## [GoCardless Invoicing via API](https://api-discuss.freeagent.com/t/gocardless-invoicing-via-api/6247)
**Author:** [@midmania](https://api-discuss.freeagent.com/u/midmania)\ **Replies:** 2\ **Last updated:** [24 November 2025 17:10 UTC](https://api-discuss.freeagent.com/t/gocardless-invoicing-via-api/6247 "2025-11-24T17:10:27Z")
Hi, I can see in the documentation that you can take a payment via GoCardless using the API Take Payment using GoCardless Direct Debit Mandate POST https://api.freeagent.com/v2/invoices/:id/direct\_debit Only availabl… --- ## [Filtering bank\_transaction\_explanations](https://api-discuss.freeagent.com/t/filtering-bank-transaction-explanations/6238)
**Author:** [@invisibledragon](https://api-discuss.freeagent.com/u/invisibledragon)\ **Replies:** 2\ **Last updated:** [8 November 2025 20:02 UTC](https://api-discuss.freeagent.com/t/filtering-bank-transaction-explanations/6238 "2025-11-08T20:02:49Z")
Hi, Is there any documentation on filtering the bank\_transaction\_explanations API? I’d like to get a more accurate date to sync invoice payments against my system after FreeAgent has an explained transaction on it’s si… --- ## [Missing exchange rate and currency gain/loss fields in FreeAgent API](https://api-discuss.freeagent.com/t/missing-exchange-rate-and-currency-gain-loss-fields-in-freeagent-api/6226)
**Author:** [@Sanjay\_1999](https://api-discuss.freeagent.com/u/Sanjay_1999)\ **Replies:** 0\ **Last updated:** [30 October 2025 13:39 UTC](https://api-discuss.freeagent.com/t/missing-exchange-rate-and-currency-gain-loss-fields-in-freeagent-api/6226 "2025-10-30T13:39:04Z")
Hi FreeAgent Team, I’m integrating the FreeAgent API to extract multicurrency data (bills and payments). In the FreeAgent web UI, I can clearly see exchange rate (from XE.com) and currency gain/loss details under each b… --- ## [1GB file limit for Files area or all attachments?](https://api-discuss.freeagent.com/t/1gb-file-limit-for-files-area-or-all-attachments/5980)
**Author:** [@vsharha](https://api-discuss.freeagent.com/u/vsharha)\ **Replies:** 1\ **Last updated:** [31 July 2025 14:58 UTC](https://api-discuss.freeagent.com/t/1gb-file-limit-for-files-area-or-all-attachments/5980 "2025-07-31T14:58:20Z")
Does the 1GB limit include attachments to expenses/bank transactions? I couldn’t find any concrete information in the documentation. Also, can attachments be reused through the API or do they need to be uploaded twice i… --- ## [Capital asset json format](https://api-discuss.freeagent.com/t/capital-asset-json-format/5952)
**Author:** [@vsharha](https://api-discuss.freeagent.com/u/vsharha)\ **Replies:** 3\ **Last updated:** [28 July 2025 19:24 UTC](https://api-discuss.freeagent.com/t/capital-asset-json-format/5952 "2025-07-28T19:24:37Z")
I’m making a script using python to upload expenses based on extracted receipt information. The script uploads each receipt as either a capital asset or expense. However, I haven’t been able to upload capital assets yet. … --- ## [Unable to get Freeagent Sandbox and Sandbox Stripe Connect](https://api-discuss.freeagent.com/t/unable-to-get-freeagent-sandbox-and-sandbox-stripe-connect/5610)
**Author:** [@Ross\_Arnott](https://api-discuss.freeagent.com/u/Ross_Arnott)\ **Replies:** 1\ **Last updated:** [7 April 2025 12:44 UTC](https://api-discuss.freeagent.com/t/unable-to-get-freeagent-sandbox-and-sandbox-stripe-connect/5610 "2025-04-07T12:44:42Z")
Our live site currently utilises FA with Stripe Connect to produce invoices. I wanted to try extending functionality of our site to automatically update our FA books when purchases made with stripe. got my FA sandbox s… --- ## [Is Smart Capture Available in the API?](https://api-discuss.freeagent.com/t/is-smart-capture-available-in-the-api/5631)
**Author:** [@TheMacGuyRocks](https://api-discuss.freeagent.com/u/TheMacGuyRocks)\ **Replies:** 3\ **Last updated:** [11 April 2025 09:04 UTC](https://api-discuss.freeagent.com/t/is-smart-capture-available-in-the-api/5631 "2025-04-11T09:04:44Z")
I’ve been working on a script that i’d like to add smart capture integration into. I can’t see the API definitions for smart capture so I assume that either i’m looking in the wrong place or they’ve not opened up the sma… --- ## [Adding attachments to Bank Transaction Explanations via the API](https://api-discuss.freeagent.com/t/adding-attachments-to-bank-transaction-explanations-via-the-api/2328)
**Author:** [@ptburkis](https://api-discuss.freeagent.com/u/ptburkis)\ **Replies:** 10\ **Last updated:** [5 February 2025 08:08 UTC](https://api-discuss.freeagent.com/t/adding-attachments-to-bank-transaction-explanations-via-the-api/2328 "2025-02-05T08:08:02Z")
I would like to “Update” existing Bank Transaction Explanations via the API and add attachments to them. Unfortunately, although I can work out what the attachment data needs to look like, ie: “attachment”: { “file\_n… --- ## [Can't receive all users via API endpoint](https://api-discuss.freeagent.com/t/cant-receive-all-users-via-api-endpoint/3321)
**Author:** [@timjones96](https://api-discuss.freeagent.com/u/timjones96)\ **Replies:** 1\ **Last updated:** [28 August 2023 11:55 UTC](https://api-discuss.freeagent.com/t/cant-receive-all-users-via-api-endpoint/3321 "2023-08-28T11:55:36Z")
Hi FreeAgent, We have a customer experiencing issues when trying to publish their journals. I’ve managed to narrow down the issue to the creation of a user for the individual journal lines. In this business situation, I… --- ## [Updating Invoice Items failings](https://api-discuss.freeagent.com/t/updating-invoice-items-failings/3135)
**Author:** [@John\_Greenhalgh](https://api-discuss.freeagent.com/u/John_Greenhalgh)\ **Replies:** 1\ **Last updated:** [10 January 2023 14:53 UTC](https://api-discuss.freeagent.com/t/updating-invoice-items-failings/3135 "2023-01-10T14:53:43Z")
Hi, I’m trying to update some invoices to remove VAT. They’re international orders, but are incorrectly set to include VAT. So, I’ve created a process to retrieve the invoice, remove the payment, set the invoice to dra… --- ## [Change invoice status via API](https://api-discuss.freeagent.com/t/change-invoice-status-via-api/3581)
**Author:** [@Malcolm\_Featherstone](https://api-discuss.freeagent.com/u/Malcolm_Featherstone)\ **Replies:** 1\ **Last updated:** [21 April 2024 15:18 UTC](https://api-discuss.freeagent.com/t/change-invoice-status-via-api/3581 "2024-04-21T15:18:17Z")
Is it possible to change the invoice status to open or sent via api? Im sending the invoice via other means so it does not need to be sent directly from freeagent, just need to change the status. Thanks --- ## [Integration Options for FreeAgent Accounting Package](https://api-discuss.freeagent.com/t/integration-options-for-freeagent-accounting-package/4316)
**Author:** [@aamir](https://api-discuss.freeagent.com/u/aamir)\ **Replies:** 3\ **Last updated:** [4 September 2024 14:35 UTC](https://api-discuss.freeagent.com/t/integration-options-for-freeagent-accounting-package/4316 "2024-09-04T14:35:09Z")
Noticed that for the xero accounting package, there’s a GitHub repository at https://github.com/XeroAPI that we can use to directly integrate their methods into our code. Is there something similar available for FreeAgen… --- ## [When to expect written\_off\_date](https://api-discuss.freeagent.com/t/when-to-expect-written-off-date/1842)
**Author:** [@Jon\_Free](https://api-discuss.freeagent.com/u/Jon_Free)\ **Replies:** 2\ **Last updated:** [31 July 2024 16:13 UTC](https://api-discuss.freeagent.com/t/when-to-expect-written-off-date/1842 "2024-07-31T16:13:38Z")
I’m using the API to grab the written\_off\_date from Invoices. Except for some Invoices (that are written off) it’s not provided. The only difference I can see is that possibly these Invoices are Part Written Off. Either … --- ## [403 error in categories API](https://api-discuss.freeagent.com/t/403-error-in-categories-api/3622)
**Author:** [@dhiraj\_2024](https://api-discuss.freeagent.com/u/dhiraj_2024)\ **Replies:** 4\ **Last updated:** [24 June 2024 04:59 UTC](https://api-discuss.freeagent.com/t/403-error-in-categories-api/3622 "2024-06-24T04:59:38Z")
Hello All, I have done freeagent integration in our product. For some business we are not able to access the categories API and gettitng 403 error from freeagent. Business country is US. API: (https://api.freeagent.com… --- ## [API Integration Scope](https://api-discuss.freeagent.com/t/api-integration-scope/3484)
**Author:** [@Jack\_Shopblocks](https://api-discuss.freeagent.com/u/Jack_Shopblocks)\ **Replies:** 3\ **Last updated:** [13 March 2024 16:25 UTC](https://api-discuss.freeagent.com/t/api-integration-scope/3484 "2024-03-13T16:25:33Z")
I am looking to create an integration with FreeAgent that fulfils the following: My client wants to be able to pull all order information into their accounting platform, FreeAgent. Important order information for them … --- ## [Profit & Loss endpoint issue](https://api-discuss.freeagent.com/t/profit-loss-endpoint-issue/2376)
**Author:** [@nick.upswot2021](https://api-discuss.freeagent.com/u/nick.upswot2021)\ **Replies:** 4\ **Last updated:** [9 October 2023 15:16 UTC](https://api-discuss.freeagent.com/t/profit-loss-endpoint-issue/2376 "2023-10-09T15:16:16Z")
I have a problem with the Profit & Loss endpoint. Even if I change parameters from, to in the request, I get the same response. For example, with such a request (accounting/profit\_and\_loss/summary?from=2019-02-01&to=2019… --- ## [Avoiding re-inventing the wheel](https://api-discuss.freeagent.com/t/avoiding-re-inventing-the-wheel/3309)
**Author:** [@notdodgy](https://api-discuss.freeagent.com/u/notdodgy)\ **Replies:** 6\ **Last updated:** [4 July 2023 12:12 UTC](https://api-discuss.freeagent.com/t/avoiding-re-inventing-the-wheel/3309 "2023-07-04T12:12:12Z")
Hello I am new to FreeAgent. I have experience of APIs but not used this one yet. Background. I am using it for a charity which gets donations into PayPal, Stripe and Go-Cardless (and other payment providers). Free… --- ## [Definition for financial year end](https://api-discuss.freeagent.com/t/definition-for-financial-year-end/3316)
**Author:** [@45h3r](https://api-discuss.freeagent.com/u/45h3r)\ **Replies:** 0\ **Last updated:** [4 July 2023 08:47 UTC](https://api-discuss.freeagent.com/t/definition-for-financial-year-end/3316 "2023-07-04T08:47:36Z")
Is this the source of truth for financial year end? FreeAgent Developer Dashboard → company.first\_accounting\_year\_end --- ## [How to differentiate between "general\_categories"](https://api-discuss.freeagent.com/t/how-to-differentiate-between-general-categories/3172)
**Author:** [@apibossinsights.com](https://api-discuss.freeagent.com/u/apibossinsights.com)\ **Replies:** 0\ **Last updated:** [6 February 2023 18:28 UTC](https://api-discuss.freeagent.com/t/how-to-differentiate-between-general-categories/3172 "2023-02-06T18:28:15Z")
Hi, when fetching categories using “https://api.freeagent.com/v2/categories?sub\_accounts=true” I noticed that assets, liabilities, and equity are under “general\_catigores”. However, I do not see a way to differentiate we… --- ## [Getting invoice and all associated credit note/transaction data](https://api-discuss.freeagent.com/t/getting-invoice-and-all-associated-credit-note-transaction-data/3038)
**Author:** [@bpursglove](https://api-discuss.freeagent.com/u/bpursglove)\ **Replies:** 1\ **Last updated:** [20 October 2022 11:50 UTC](https://api-discuss.freeagent.com/t/getting-invoice-and-all-associated-credit-note-transaction-data/3038 "2022-10-20T11:50:34Z")
Hi, We’re using your API to gather customer data for internal use. The aim is to get, for a given customer and within a given date range, a list of all invoices as well as all credit notes and bank transaction explanati… --- ## [BUG: INVOICE "bank\_account" is not String](https://api-discuss.freeagent.com/t/bug-invoice-bank-account-is-not-string/3034)
**Author:** [@captgiro](https://api-discuss.freeagent.com/u/captgiro)\ **Replies:** 1\ **Last updated:** [18 October 2022 08:49 UTC](https://api-discuss.freeagent.com/t/bug-invoice-bank-account-is-not-string/3034 "2022-10-18T08:49:45Z")
…as described in the API documentation - it’s a URI. We learned the hard way. :man\_facepalming: --- ## [Country name to ISO code mapping](https://api-discuss.freeagent.com/t/country-name-to-iso-code-mapping/3012)
**Author:** [@brng](https://api-discuss.freeagent.com/u/brng)\ **Replies:** 0\ **Last updated:** [30 September 2022 10:43 UTC](https://api-discuss.freeagent.com/t/country-name-to-iso-code-mapping/3012 "2022-09-30T10:43:29Z")
Is there anywhere I can get the current ISO code to Country Name mapping list? Apologies if I’ve missed it in the documentation. --- ## [Create Invoice from Estimate](https://api-discuss.freeagent.com/t/create-invoice-from-estimate/1706)
**Author:** [@karolo](https://api-discuss.freeagent.com/u/karolo)\ **Replies:** 4\ **Last updated:** [29 September 2022 11:43 UTC](https://api-discuss.freeagent.com/t/create-invoice-from-estimate/1706 "2022-09-29T11:43:19Z")
Is it possible to create an Invoice from an Estimate and set the Estimate status to Invoiced via the API? The documentation doesn’t provide a way to do this, and setting the Status to “Invoiced” results in an “status is… [Next page](https://api-discuss.freeagent.com/c/documentation/8.md?page=1)