# Documentation

**URL:** https://api-discuss.freeagent.com/c/documentation/8.md?page=1

[Latest](https://api-discuss.freeagent.com/latest.md) · [Categories](https://api-discuss.freeagent.com/categories.md)

**Page:** 2

---

## [Issues with foreign\_currency\_value](https://api-discuss.freeagent.com/t/issues-with-foreign-currency-value/2972)

<div class="topic-metadata">

**Author:** [@iahmed](https://api-discuss.freeagent.com/u/iahmed)\
**Replies:** 0\
**Last updated:** [4 September 2022 02:22 UTC](https://api-discuss.freeagent.com/t/issues-with-foreign-currency-value/2972 "2022-09-04T02:22:58Z")

</div>

Hello The documentation for explaining bank transactions doesn’t specify foreign\_currency\_value as a required value for invoice payments but (I believe) it should be. Let’s say the invoice currency is in USD and the cu…

---

## [How does recording sales to different countries affects things like VAT reporting behind the scenes?](https://api-discuss.freeagent.com/t/how-does-recording-sales-to-different-countries-affects-things-like-vat-reporting-behind-the-scenes/2915)

<div class="topic-metadata">

**Author:** [@Joey](https://api-discuss.freeagent.com/u/Joey)\
**Replies:** 5\
**Last updated:** [9 August 2022 14:58 UTC](https://api-discuss.freeagent.com/t/how-does-recording-sales-to-different-countries-affects-things-like-vat-reporting-behind-the-scenes/2915 "2022-08-09T14:58:58Z")

</div>

We are currently generating a daily summarised invoice for a store for all orders within that day. Within the invoice we are separating this by tax amount but it has become apparent we may need to separate this by count…

---

## [Pulling Corporation Tax figures](https://api-discuss.freeagent.com/t/pulling-corporation-tax-figures/2409)

<div class="topic-metadata">

**Author:** [@Currently.Jason](https://api-discuss.freeagent.com/u/Currently.Jason)\
**Replies:** 2\
**Last updated:** [4 August 2022 14:02 UTC](https://api-discuss.freeagent.com/t/pulling-corporation-tax-figures/2409 "2022-08-04T14:02:33Z")

</div>

Hi All, Newbie here looking for some community help. I’m doing some work for a new client and I’m trying to pull in some data from Freeagnet in order to report with other data help in other sources. I have been shown …

---

## [Accountancy Practice API - client question](https://api-discuss.freeagent.com/t/accountancy-practice-api-client-question/2923)

<div class="topic-metadata">

**Author:** [@timjones96](https://api-discuss.freeagent.com/u/timjones96)\
**Replies:** 1\
**Last updated:** [26 July 2022 16:06 UTC](https://api-discuss.freeagent.com/t/accountancy-practice-api-client-question/2923 "2022-07-26T16:06:24Z")

</div>

I’m doing an integration that is leveraging the Accountancy Practice API. We’ve managed to create the OAuth connection successfully, bring back the different clients under the accountant and receive the categories (chart…

---

## [New Bills & Bill Items API clarification](https://api-discuss.freeagent.com/t/new-bills-bill-items-api-clarification/2512)

<div class="topic-metadata">

**Author:** [@ptgnet](https://api-discuss.freeagent.com/u/ptgnet)\
**Replies:** 9\
**Last updated:** [24 May 2022 10:33 UTC](https://api-discuss.freeagent.com/t/new-bills-bill-items-api-clarification/2512 "2022-05-24T10:33:54Z")

</div>

Hi, I’m hoping for some clarification on the new Bill API rollout. The original topic (https://api-discuss.freeagent.com/t/bill-changes-and-deprecations-bills-with-multiple-line-items/2424) seems to imply that we’re no…

---

## [Accountancy Practice Rate Limit](https://api-discuss.freeagent.com/t/accountancy-practice-rate-limit/2848)

<div class="topic-metadata">

**Author:** [@absalvamantejr](https://api-discuss.freeagent.com/u/absalvamantejr)\
**Replies:** 1\
**Last updated:** [21 April 2022 23:31 UTC](https://api-discuss.freeagent.com/t/accountancy-practice-rate-limit/2848 "2022-04-21T23:31:40Z")

</div>

Hi All, I would like to clarify the rate limits for Accountancy Practice/Account Manager users: When calling the https://api.freeagent.com/v2/clients to which limit is applied? I know that for AP rate limits applies …

---

## [Marking bill as 'Paid' via API](https://api-discuss.freeagent.com/t/marking-bill-as-paid-via-api/2837)

<div class="topic-metadata">

**Author:** [@OM\_TIL](https://api-discuss.freeagent.com/u/OM_TIL)\
**Replies:** 2\
**Last updated:** [5 April 2022 15:54 UTC](https://api-discuss.freeagent.com/t/marking-bill-as-paid-via-api/2837 "2022-04-05T15:54:05Z")

</div>

Dear FreeAgent support, Is it possible to mark a bill as paid via the api? I am looking to change the status to ‘Paid’ and also add a ‘paid\_on’ date. However, when I send the put request with the necessary json, these …

---

## [List of API Error responses](https://api-discuss.freeagent.com/t/list-of-api-error-responses/2809)

<div class="topic-metadata">

**Author:** [@Neutral\_Yukka](https://api-discuss.freeagent.com/u/Neutral_Yukka)\
**Replies:** 2\
**Last updated:** [21 February 2022 17:03 UTC](https://api-discuss.freeagent.com/t/list-of-api-error-responses/2809 "2022-02-21T17:03:52Z")

</div>

Greetings, I’d like to re-iterate this request and this one I’m maintaining some code written a few years ago by someone who has left the company. The response handling code, particularly for errors, is checking the re…

---

## [Category Nominal Code Mapping](https://api-discuss.freeagent.com/t/category-nominal-code-mapping/2706)

<div class="topic-metadata">

**Author:** [@Daniel\_Tzabar](https://api-discuss.freeagent.com/u/Daniel_Tzabar)\
**Replies:** 3\
**Last updated:** [5 January 2022 11:36 UTC](https://api-discuss.freeagent.com/t/category-nominal-code-mapping/2706 "2022-01-05T11:36:10Z")

</div>

According to the API docs here, the Nominal Code ranges can be used to determine if a category is Income, Cost of Sales etc: 001 to 049: Income 100 to 199: Cost of Sales 200 to 399: Admin Expenses 671 to 720: Current A…

---

## [CLARIFY: BILL sales tax defaults to Zero](https://api-discuss.freeagent.com/t/clarify-bill-sales-tax-defaults-to-zero/2577)

<div class="topic-metadata">

**Author:** [@captgiro](https://api-discuss.freeagent.com/u/captgiro)\
**Replies:** 6\
**Last updated:** [2 January 2022 12:13 UTC](https://api-discuss.freeagent.com/t/clarify-bill-sales-tax-defaults-to-zero/2577 "2022-01-02T12:13:46Z")

</div>

Dev guide on sales tax says… Expenses, Bills and Bill items Normally there is no need to specify the sales\_tax\_rate or the manual\_sales\_tax\_amount for an expense, bill or bill item yourself. If you leave both of these…

---

## [Updating status on new invoice through API](https://api-discuss.freeagent.com/t/updating-status-on-new-invoice-through-api/2397)

<div class="topic-metadata">

**Author:** [@gleighfield](https://api-discuss.freeagent.com/u/gleighfield)\
**Replies:** 5\
**Last updated:** [6 May 2021 09:56 UTC](https://api-discuss.freeagent.com/t/updating-status-on-new-invoice-through-api/2397 "2021-05-06T09:56:13Z")

</div>

Good afternoon, I’m hoping someone can assist me with what I believe… is something relatively straight forward. I’m creating an invoice through the API, and I simply want to set the status of that invoice to “Open” - wh…

---

## [Handling VAT post-Brexit](https://api-discuss.freeagent.com/t/handling-vat-post-brexit/2316)

<div class="topic-metadata">

**Author:** [@david.whitby](https://api-discuss.freeagent.com/u/david.whitby)\
**Replies:** 3\
**Last updated:** [22 November 2021 17:56 UTC](https://api-discuss.freeagent.com/t/handling-vat-post-brexit/2316 "2021-11-22T17:56:17Z")

</div>

Hi all, Just a quick note to say we’ve updated the API documentation with guidance on setting the VAT options (ec\_status) on bank transaction explanations, bills, credit notes, estimates, expenses and invoices. If the …

---

## [Category defaulting to Sundries (280) when creating an expense](https://api-discuss.freeagent.com/t/category-defaulting-to-sundries-280-when-creating-an-expense/2503)

<div class="topic-metadata">

**Author:** [@JofArnold](https://api-discuss.freeagent.com/u/JofArnold)\
**Replies:** 5\
**Last updated:** [10 August 2021 09:50 UTC](https://api-discuss.freeagent.com/t/category-defaulting-to-sundries-280-when-creating-an-expense/2503 "2021-08-10T09:50:05Z")

</div>

When I create a new expense, all fields seem to work (so far) accept category. For instance, from the documentation if I wanted to create a new Web Hosting expense I would expect the request body to be something like thi…

---

## [Sending an Invoice by email](https://api-discuss.freeagent.com/t/sending-an-invoice-by-email/2281)

<div class="topic-metadata">

**Author:** [@John\_Greenhalgh](https://api-discuss.freeagent.com/u/John_Greenhalgh)\
**Replies:** 5\
**Last updated:** [18 November 2020 10:46 UTC](https://api-discuss.freeagent.com/t/sending-an-invoice-by-email/2281 "2020-11-18T10:46:35Z")

</div>

Hi, I’m trying to sent an invoice via email through the API. Unfortunately there isn’t an example call in the documentation, just the fields required, which I believe I have put in place. Also, can anyone confirm if s…

---

## [Payroll profiles link broken on the API Docs changes page](https://api-discuss.freeagent.com/t/payroll-profiles-link-broken-on-the-api-docs-changes-page/2570)

<div class="topic-metadata">

**Author:** [@micdev42](https://api-discuss.freeagent.com/u/micdev42)\
**Replies:** 1\
**Last updated:** [26 October 2021 16:06 UTC](https://api-discuss.freeagent.com/t/payroll-profiles-link-broken-on-the-api-docs-changes-page/2570 "2021-10-26T16:06:54Z")

</div>

In this page FreeAgent Developer Dashboard The link to the payroll profiles docs under 12 October is broken: https://dev.freeagent.com/docs/docs/payroll\_profiles It should be FreeAgent Developer Dashboard

---

## [CLARIFY: "manual\_sales\_tax\_amount" in new BILL endpoint](https://api-discuss.freeagent.com/t/clarify-manual-sales-tax-amount-in-new-bill-endpoint/2574)

<div class="topic-metadata">

**Author:** [@captgiro](https://api-discuss.freeagent.com/u/captgiro)\
**Replies:** 1\
**Last updated:** [26 October 2021 10:19 UTC](https://api-discuss.freeagent.com/t/clarify-manual-sales-tax-amount-in-new-bill-endpoint/2574 "2021-10-26T10:19:37Z")

</div>

Is “manual\_sales\_tax\_amount” supported in the new BILL endpoint for bill\_items? Reason being… ‘manual\_sales\_tax\_amount’ is included in the deprecated Bill endpoint (both code & documentation), AND is still working in th…

---

## [Incorrect documentation for /cashflow](https://api-discuss.freeagent.com/t/incorrect-documentation-for-cashflow/2558)

<div class="topic-metadata">

**Author:** [@breakfast](https://api-discuss.freeagent.com/u/breakfast)\
**Replies:** 1\
**Last updated:** [6 October 2021 14:18 UTC](https://api-discuss.freeagent.com/t/incorrect-documentation-for-cashflow/2558 "2021-10-06T14:18:01Z")

</div>

Reading the documentation for the cashflow endpoint I notice that the dates in the example call are not in the format that the documentation recommends. The YYYY-MM-DD format seems to work, so it might be worth updating …

---

## [422 - Unprocessable Entity for invoices](https://api-discuss.freeagent.com/t/422-unprocessable-entity-for-invoices/2515)

<div class="topic-metadata">

**Author:** [@ben007](https://api-discuss.freeagent.com/u/ben007)\
**Replies:** 3\
**Last updated:** [2 September 2021 16:46 UTC](https://api-discuss.freeagent.com/t/422-unprocessable-entity-for-invoices/2515 "2021-09-02T16:46:58Z")

</div>

We have been calling the invoices endpoint for many months without issue. But last night we received the following error: status: 422, statusText: ‘Unprocessable Entity’, headers: { server: ‘nginx’, date: ‘Wed, 01 S…

---

## [Journal's updated\_at not updating when edited](https://api-discuss.freeagent.com/t/journals-updated-at-not-updating-when-edited/2350)

<div class="topic-metadata">

**Author:** [@Jeffrey](https://api-discuss.freeagent.com/u/Jeffrey)\
**Replies:** 4\
**Last updated:** [25 August 2021 08:51 UTC](https://api-discuss.freeagent.com/t/journals-updated-at-not-updating-when-edited/2350 "2021-08-25T08:51:50Z")

</div>

Hi, Can you confirm if this is a bug. When editing Manually created journals, the updated\_at doesn’t get updated and this is causing problem specially when we are getting records using the updated\_since parameter.

---

## [Vendor Invoice payments](https://api-discuss.freeagent.com/t/vendor-invoice-payments/2492)

<div class="topic-metadata">

**Author:** [@David\_Williams](https://api-discuss.freeagent.com/u/David_Williams)\
**Replies:** 1\
**Last updated:** [3 August 2021 13:29 UTC](https://api-discuss.freeagent.com/t/vendor-invoice-payments/2492 "2021-08-03T13:29:55Z")

</div>

Hi, I am not able to get the payments for bills or vendor invoices and Journal entries for all transactions. Please help.

---

## [New Tax Period value is incorrect](https://api-discuss.freeagent.com/t/new-tax-period-value-is-incorrect/2460)

<div class="topic-metadata">

**Author:** [@Currently.Jason](https://api-discuss.freeagent.com/u/Currently.Jason)\
**Replies:** 3\
**Last updated:** [14 July 2021 14:56 UTC](https://api-discuss.freeagent.com/t/new-tax-period-value-is-incorrect/2460 "2021-07-14T14:56:41Z")

</div>

Hi There, Thanks to the community help I have been able to pull the VAT figure from Trial Balance using the API. I am able to pull the correct figure for the period 1st April 2021- 29th June 2021 however, I am not able…

---

## [Extract Dividends](https://api-discuss.freeagent.com/t/extract-dividends/2410)

<div class="topic-metadata">

**Author:** [@Currently.Jason](https://api-discuss.freeagent.com/u/Currently.Jason)\
**Replies:** 4\
**Last updated:** [24 May 2021 09:06 UTC](https://api-discuss.freeagent.com/t/extract-dividends/2410 "2021-05-24T09:06:12Z")

</div>

Hi Everyone, I’m struggling fo the best way to extract dividend payments. I’m trying to use Bank transactions and filtering on category but the filter doesn’t seem to work https://api.freeagent.com/v2/bank\_transactions…

---

## [Updating Status and Paid Value via API](https://api-discuss.freeagent.com/t/updating-status-and-paid-value-via-api/2347)

<div class="topic-metadata">

**Author:** [@JD97](https://api-discuss.freeagent.com/u/JD97)\
**Replies:** 4\
**Last updated:** [22 February 2021 11:45 UTC](https://api-discuss.freeagent.com/t/updating-status-and-paid-value-via-api/2347 "2021-02-22T11:45:24Z")

</div>

Hi, I’m working on an integration with Salesforce and Stripe and I’m afraid I need to ask for help. We’re creating invoices via API based on a web form and Salesforce records, then need to mark them as ‘Paid’ for their …

---

## [POST Request for Create an Invoice - Required parameter missing: invoice](https://api-discuss.freeagent.com/t/post-request-for-create-an-invoice-required-parameter-missing-invoice/2269)

<div class="topic-metadata">

**Author:** [@Tom](https://api-discuss.freeagent.com/u/Tom)\
**Replies:** 3\
**Last updated:** [27 October 2020 16:43 UTC](https://api-discuss.freeagent.com/t/post-request-for-create-an-invoice-required-parameter-missing-invoice/2269 "2020-10-27T16:43:21Z")

</div>

Hi, I’m trying to create an Invoice, but I’m currently getting a response of “Required parameter missing: invoice”. I have checked back to the required content to be posted and I cannot see what the error response is r…

---

## [List projects returns nested contacts even when nested=false](https://api-discuss.freeagent.com/t/list-projects-returns-nested-contacts-even-when-nested-false/2204)

<div class="topic-metadata">

**Author:** [@matt.groves](https://api-discuss.freeagent.com/u/matt.groves)\
**Replies:** 4\
**Last updated:** [26 August 2020 13:59 UTC](https://api-discuss.freeagent.com/t/list-projects-returns-nested-contacts-even-when-nested-false/2204 "2020-08-26T13:59:48Z")

</div>

Calling https://api.freeagent.com/v2/projects?nested=false returns nested contacts, the same response structure as if calling nested=true Only excluding the nested parameter returns the expected response (no nested cont…

---

## [Invoice ec\_status valid values](https://api-discuss.freeagent.com/t/invoice-ec-status-valid-values/2158)

<div class="topic-metadata">

**Author:** [@SendOwl](https://api-discuss.freeagent.com/u/SendOwl)\
**Replies:** 5\
**Last updated:** [15 July 2020 09:17 UTC](https://api-discuss.freeagent.com/t/invoice-ec-status-valid-values/2158 "2020-07-15T09:17:35Z")

</div>

Hi there, I’ve been investigating a problem with our long running FreeAgent integration and noticed that in some cases our code passes a value of “Non-EC” to the endpoint when creating a new Invoice. According to the d…

---

## [Pagination not working](https://api-discuss.freeagent.com/t/pagination-not-working/2141)

<div class="topic-metadata">

**Author:** [@kunalkhin](https://api-discuss.freeagent.com/u/kunalkhin)\
**Replies:** 1\
**Last updated:** [10 July 2020 10:50 UTC](https://api-discuss.freeagent.com/t/pagination-not-working/2141 "2020-07-10T10:50:25Z")

</div>

Hi, As per the API documentation there is pagination possible with all the endpoints however when we are hitting the APIs we are not getting the response paginated. Below is an example for the TrialBalance API. Request…

---

## [Invoice Send Attachments](https://api-discuss.freeagent.com/t/invoice-send-attachments/2095)

<div class="topic-metadata">

**Author:** [@Jon\_Free](https://api-discuss.freeagent.com/u/Jon_Free)\
**Replies:** 2\
**Last updated:** [22 June 2020 09:32 UTC](https://api-discuss.freeagent.com/t/invoice-send-attachments/2095 "2020-06-22T09:32:30Z")

</div>

Can you add Attachments to the emails that send Invoices? Via the API. You can do it within the Web App but I can’t seem to see if you can via the API

---

## [Earliest date for cashflow](https://api-discuss.freeagent.com/t/earliest-date-for-cashflow/2058)

<div class="topic-metadata">

**Author:** [@urunotao](https://api-discuss.freeagent.com/u/urunotao)\
**Replies:** 2\
**Last updated:** [27 May 2020 10:53 UTC](https://api-discuss.freeagent.com/t/earliest-date-for-cashflow/2058 "2020-05-27T10:53:40Z")

</div>

Which date from the following (returned by /company) should I use as the from\_date for /cashflow - essentially I need the earliest possible date that Freeagent has cashflow data from? company\_start\_date Date the bus…

---

## ["Days late on average" via API?](https://api-discuss.freeagent.com/t/days-late-on-average-via-api/2008)

<div class="topic-metadata">

**Author:** [@andgira](https://api-discuss.freeagent.com/u/andgira)\
**Replies:** 1\
**Last updated:** [29 April 2020 10:51 UTC](https://api-discuss.freeagent.com/t/days-late-on-average-via-api/2008 "2020-04-29T10:51:58Z")

</div>

Hello, On the web-platform, for some “contacts” we see an interesting field showing “days late on average” regarding the payment of invoices. Example: Customer X is “6 days late on average” to pay invoices. Is it poss…

[Previous page](https://api-discuss.freeagent.com/c/documentation/8.md)

[Next page](https://api-discuss.freeagent.com/c/documentation/8.md?page=2)
