# Documentation

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

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

**Page:** 3

---

## [Support for Domestic reverse charge for UK clients](https://api-discuss.freeagent.com/t/support-for-domestic-reverse-charge-for-uk-clients/1931)

<div class="topic-metadata">

**Author:** [@ravirpandey](https://api-discuss.freeagent.com/u/ravirpandey)\
**Replies:** 1\
**Last updated:** [17 March 2020 11:22 UTC](https://api-discuss.freeagent.com/t/support-for-domestic-reverse-charge-for-uk-clients/1931 "2020-03-17T11:22:22Z")

</div>

Considering the Domestic reverse VAT charge, the UK government has outlined as per the link below, we are planning to provide this support for all our clients. https://www.gov.uk/guidance/the-vat-domestic-reverse-charge…

---

## [Send Invitation not working in user API](https://api-discuss.freeagent.com/t/send-invitation-not-working-in-user-api/1743)

<div class="topic-metadata">

**Author:** [@deepan.aquera](https://api-discuss.freeagent.com/u/deepan.aquera)\
**Replies:** 6\
**Last updated:** [8 January 2020 05:22 UTC](https://api-discuss.freeagent.com/t/send-invitation-not-working-in-user-api/1743 "2020-01-08T05:22:53Z")

</div>

I’m trying to create a user with send\_invitation as true. But I’m not receiving the invitation email. The same via UI is working fine.

---

## [Bank account without created\_at field](https://api-discuss.freeagent.com/t/bank-account-without-created-at-field/1805)

<div class="topic-metadata">

**Author:** [@Ilya\_Simonenko](https://api-discuss.freeagent.com/u/Ilya_Simonenko)\
**Replies:** 6\
**Last updated:** [6 January 2020 13:22 UTC](https://api-discuss.freeagent.com/t/bank-account-without-created-at-field/1805 "2020-01-06T13:22:57Z")

</div>

Hello Freeagent team, I’d like to know what are the cases when a bank account can have no “created\_at” field? Is it expected? Thanks, Ilya Simonenko Revolut

---

## [Unauthorised 401 when creating invoice](https://api-discuss.freeagent.com/t/unauthorised-401-when-creating-invoice/1782)

<div class="topic-metadata">

**Author:** [@thei](https://api-discuss.freeagent.com/u/thei)\
**Replies:** 2\
**Last updated:** [11 December 2019 14:05 UTC](https://api-discuss.freeagent.com/t/unauthorised-401-when-creating-invoice/1782 "2019-12-11T14:05:41Z")

</div>

Hi all, I receive a 401 Unauthorized response when trying to create an new invoice with the JSON at the bottom. The URI’s used are valid/exist. I am using https://developers.google.com/oauthplayground/ to send the POST …

---

## [Bank Transaction total value rejected](https://api-discuss.freeagent.com/t/bank-transaction-total-value-rejected/1766)

<div class="topic-metadata">

**Author:** [@Jon\_Free](https://api-discuss.freeagent.com/u/Jon_Free)\
**Replies:** 0\
**Last updated:** [2 December 2019 15:31 UTC](https://api-discuss.freeagent.com/t/bank-transaction-total-value-rejected/1766 "2019-12-02T15:31:44Z")

</div>

Hi, I’ve had a few cases of Bank Transaction’s failing to upload via the API recently because their value was wrong, only to be able to do exactly the same thing manually in the site. It’s happened a few times now hence…

---

## [Is user ID globally unique?](https://api-discuss.freeagent.com/t/is-user-id-globally-unique/1752)

<div class="topic-metadata">

**Author:** [@jan](https://api-discuss.freeagent.com/u/jan)\
**Replies:** 1\
**Last updated:** [25 November 2019 15:22 UTC](https://api-discuss.freeagent.com/t/is-user-id-globally-unique/1752 "2019-11-25T15:22:52Z")

</div>

Hi, I would like to know if the last part of url field at https://dev.freeagent.com/docs/users#get-personal-profile is a user id? In the docs I do see: “url”:“https://api.freeagent.com/v2/users/1”, so in this example 1 …

---

## [Recurring invoices via the API](https://api-discuss.freeagent.com/t/recurring-invoices-via-the-api/971)

<div class="topic-metadata">

**Author:** [@karolo](https://api-discuss.freeagent.com/u/karolo)\
**Replies:** 4\
**Last updated:** [22 November 2019 07:59 UTC](https://api-discuss.freeagent.com/t/recurring-invoices-via-the-api/971 "2019-11-22T07:59:37Z")

</div>

Seem to be getting strange behavior and incorrect data returned with the recurring\_invoices API, When getting a list of recurring\_invoices, the reference returned is of the base or latest invoice and not the 3 digit r…

---

## [How to update the type of a bank transaction explanation](https://api-discuss.freeagent.com/t/how-to-update-the-type-of-a-bank-transaction-explanation/1709)

<div class="topic-metadata">

**Author:** [@Ben\_Glynn](https://api-discuss.freeagent.com/u/Ben_Glynn)\
**Replies:** 1\
**Last updated:** [4 November 2019 13:09 UTC](https://api-discuss.freeagent.com/t/how-to-update-the-type-of-a-bank-transaction-explanation/1709 "2019-11-04T13:09:23Z")

</div>

Hello FreeAgent API forum! I would like to update the type of a bank transaction explanation. The docs don’t go into enough detail unfortunately. For example: an explanation has a type of “Payment” with a category of 2…

---

## [Invoice item\_type blank](https://api-discuss.freeagent.com/t/invoice-item-type-blank/1720)

<div class="topic-metadata">

**Author:** [@karolo](https://api-discuss.freeagent.com/u/karolo)\
**Replies:** 0\
**Last updated:** [4 November 2019 12:41 UTC](https://api-discuss.freeagent.com/t/invoice-item-type-blank/1720 "2019-11-04T12:41:23Z")

</div>

The documentation for invoice item\_type states to “Leave blank for ‘No Unit’” but the API throws an error “item\_type can’t be blank,is not an accepted value” I see there was a similar topic created 5 years ago

---

## [Retrieve Invoice Item Category via API](https://api-discuss.freeagent.com/t/retrieve-invoice-item-category-via-api/1636)

<div class="topic-metadata">

**Author:** [@markams](https://api-discuss.freeagent.com/u/markams)\
**Replies:** 0\
**Last updated:** [9 September 2019 14:24 UTC](https://api-discuss.freeagent.com/t/retrieve-invoice-item-category-via-api/1636 "2019-09-09T14:24:40Z")

</div>

https://dev.freeagent.com/docs/invoices#get-a-single-invoice document does not show that the invoice\_items collection contains the category\_id field for the line item. Can you confirm whether this field is available in …

---

## [Can I post a single bank transaction?](https://api-discuss.freeagent.com/t/can-i-post-a-single-bank-transaction/983)

<div class="topic-metadata">

**Author:** [@riggerthegeek](https://api-discuss.freeagent.com/u/riggerthegeek)\
**Replies:** 6\
**Last updated:** [31 July 2019 10:44 UTC](https://api-discuss.freeagent.com/t/can-i-post-a-single-bank-transaction/983 "2019-07-31T10:44:36Z")

</div>

According to the Bank Transactions page of the docs, the only way of posting a bank transaction is to upload the statement - is there any way of adding a single transaction to the API? Reason I'm asking - I want to mov…

---

## [Quickstart documentation](https://api-discuss.freeagent.com/t/quickstart-documentation/1569)

<div class="topic-metadata">

**Author:** [@Ammo99](https://api-discuss.freeagent.com/u/Ammo99)\
**Replies:** 0\
**Last updated:** [25 July 2019 16:17 UTC](https://api-discuss.freeagent.com/t/quickstart-documentation/1569 "2019-07-25T16:17:45Z")

</div>

I dont think the quick start documentation is up to date. For starters, I cant get the simple example to work to show the company details. Following your quick start, there are several areas which are not clear. First…

---

## [Invoice :: possible typo](https://api-discuss.freeagent.com/t/invoice-possible-typo/1519)

<div class="topic-metadata">

**Author:** [@Serhiy\_K](https://api-discuss.freeagent.com/u/Serhiy_K)\
**Replies:** 3\
**Last updated:** [17 June 2019 08:47 UTC](https://api-discuss.freeagent.com/t/invoice-possible-typo/1519 "2019-06-17T08:47:10Z")

</div>

Hello, working on the invoice API and noticed a possible typo. Delete an invoice route: DELETE https://api.freeagent.com/v2/estimates/:id See this screenshot http://prntscr.com/o2m9jc

---

## [Minor suggestion for bank explanation doc improvement](https://api-discuss.freeagent.com/t/minor-suggestion-for-bank-explanation-doc-improvement/1498)

<div class="topic-metadata">

**Author:** [@robd](https://api-discuss.freeagent.com/u/robd)\
**Replies:** 0\
**Last updated:** [4 June 2019 09:51 UTC](https://api-discuss.freeagent.com/t/minor-suggestion-for-bank-explanation-doc-improvement/1498 "2019-06-04T09:51:56Z")

</div>

On https://dev.freeagent.com/docs/bank\_transaction\_explanations, might be worth explicitly stating that it’s necessary to strip any base 64 preamble (eg data:image/png;base64,) for the data field for attachments: data …

---

## [Comments are not being returned in invoiceobject](https://api-discuss.freeagent.com/t/comments-are-not-being-returned-in-invoiceobject/1410)

<div class="topic-metadata">

**Author:** [@Gary\_Fairchild](https://api-discuss.freeagent.com/u/Gary_Fairchild)\
**Replies:** 2\
**Last updated:** [30 May 2019 08:58 UTC](https://api-discuss.freeagent.com/t/comments-are-not-being-returned-in-invoiceobject/1410 "2019-05-30T08:58:15Z")

</div>

Hi, We need to send through a custom id when creating an invoice and to be able to retrieve that id from the returned invoice object. i.e. before adding invoice items from our internal billing system. I have been tryin…

---

## [Adding Direct Debit Mandate](https://api-discuss.freeagent.com/t/adding-direct-debit-mandate/1403)

<div class="topic-metadata">

**Author:** [@ahmed](https://api-discuss.freeagent.com/u/ahmed)\
**Replies:** 0\
**Last updated:** [11 April 2019 22:27 UTC](https://api-discuss.freeagent.com/t/adding-direct-debit-mandate/1403 "2019-04-11T22:27:09Z")

</div>

Hi, Is there any way of retrieving the Gocardless status for contacts? The above post shows there was, however I am unable to find this information being returned in the api end-point for returning back contact data. …

---

## [Expenses API incorrect fieldtype in documentation](https://api-discuss.freeagent.com/t/expenses-api-incorrect-fieldtype-in-documentation/1399)

<div class="topic-metadata">

**Author:** [@mverstrepen](https://api-discuss.freeagent.com/u/mverstrepen)\
**Replies:** 0\
**Last updated:** [9 April 2019 07:21 UTC](https://api-discuss.freeagent.com/t/expenses-api-incorrect-fieldtype-in-documentation/1399 "2019-04-09T07:21:04Z")

</div>

In the documentation for expenses API calls (https://dev.freeagent.com/docs/expenses) the field recurring is listed as a boolean while the API returns string values (ie. Weekly).

---

## [Rate Limiting for the API](https://api-discuss.freeagent.com/t/rate-limiting-for-the-api/1368)

<div class="topic-metadata">

**Author:** [@apibossinsights.com](https://api-discuss.freeagent.com/u/apibossinsights.com)\
**Replies:** 1\
**Last updated:** [27 March 2019 11:03 UTC](https://api-discuss.freeagent.com/t/rate-limiting-for-the-api/1368 "2019-03-27T11:03:31Z")

</div>

Hi, is there any rate limiting protocols in place for the API? If there is, could someone tell me what it is as well as who it is applied for (per user, per IP, etc)? Thanks!

---

## [Czech Republic country name is different - now Czechia](https://api-discuss.freeagent.com/t/czech-republic-country-name-is-different-now-czechia/1005)

<div class="topic-metadata">

**Author:** [@ptgnet](https://api-discuss.freeagent.com/u/ptgnet)\
**Replies:** 5\
**Last updated:** [5 March 2019 13:35 UTC](https://api-discuss.freeagent.com/t/czech-republic-country-name-is-different-now-czechia/1005 "2019-03-05T13:35:08Z")

</div>

The Czech Republic is no longer called that. It is now Czechia. So if I set a contact's country to "Czech Republic" the API silently sets it to "United Kingdom". Big deal? Yes. Because we use the contact's country th…

---

## [Refresh token error](https://api-discuss.freeagent.com/t/refresh-token-error/1300)

<div class="topic-metadata">

**Author:** [@test](https://api-discuss.freeagent.com/u/test)\
**Replies:** 2\
**Last updated:** [12 February 2019 16:42 UTC](https://api-discuss.freeagent.com/t/refresh-token-error/1300 "2019-02-12T16:42:55Z")

</div>

Hi everyone, I am using the freeAgent API for a project but i’ve got some troubles refreshing the token. I’m doing it like in the documentation but i have an “invalide grant\_type” error. Here is my request, if you can …

---

## [Opening Balance per Financial Year](https://api-discuss.freeagent.com/t/opening-balance-per-financial-year/1318)

<div class="topic-metadata">

**Author:** [@x.xiao](https://api-discuss.freeagent.com/u/x.xiao)\
**Replies:** 0\
**Last updated:** [20 February 2019 11:32 UTC](https://api-discuss.freeagent.com/t/opening-balance-per-financial-year/1318 "2019-02-20T11:32:36Z")

</div>

Looking at the documentation for the Trial Balance Opening balance, I was wondering if there was any way of obtaining the opening balance per financial year?

---

## [Sales tax rate for EC Services](https://api-discuss.freeagent.com/t/sales-tax-rate-for-ec-services/1315)

<div class="topic-metadata">

**Author:** [@GuillaumeLB](https://api-discuss.freeagent.com/u/GuillaumeLB)\
**Replies:** 0\
**Last updated:** [19 February 2019 10:04 UTC](https://api-discuss.freeagent.com/t/sales-tax-rate-for-ec-services/1315 "2019-02-19T10:04:27Z")

</div>

Hi, When creating a new bank transaction explanation for an EC Services transaction what’s the value we should use for sales\_tax\_rate ? Thanks

---

## [Filter inactive clients](https://api-discuss.freeagent.com/t/filter-inactive-clients/1266)

<div class="topic-metadata">

**Author:** [@nick-iles](https://api-discuss.freeagent.com/u/nick-iles)\
**Replies:** 4\
**Last updated:** [18 February 2019 20:56 UTC](https://api-discuss.freeagent.com/t/filter-inactive-clients/1266 "2019-02-18T20:56:46Z")

</div>

Hi I would like to return a list of only active clients from the API as per in the practice dashboard drop down to view active clients. The logical place I would of expected would be from the Accountancy Practice API.…

---

## [Invalid JSON trying to create an invoice](https://api-discuss.freeagent.com/t/invalid-json-trying-to-create-an-invoice/1271)

<div class="topic-metadata">

**Author:** [@hassanahmaduk](https://api-discuss.freeagent.com/u/hassanahmaduk)\
**Replies:** 6\
**Last updated:** [28 January 2019 11:32 UTC](https://api-discuss.freeagent.com/t/invalid-json-trying-to-create-an-invoice/1271 "2019-01-28T11:32:52Z")

</div>

I’ve tried to create an invoice using your documentation and used the exact format being specified on this page: https://dev.freeagent.com/docs/invoices I’ve managed to successfully create a contact but so far no luck …

---

## [Enable Stripe for Sandbox account](https://api-discuss.freeagent.com/t/enable-stripe-for-sandbox-account/1216)

<div class="topic-metadata">

**Author:** [@siicockerill](https://api-discuss.freeagent.com/u/siicockerill)\
**Replies:** 3\
**Last updated:** [18 December 2018 13:15 UTC](https://api-discuss.freeagent.com/t/enable-stripe-for-sandbox-account/1216 "2018-12-18T13:15:15Z")

</div>

I’m trying to enable Stripe on my sandbox account so that I can test out the invoice API and get the payment\_url for an invoice… From within my sandbox FA account, I go to Settings \> Stripe and click ‘Enable Stripe’ … a…

---

## [Filtering bills and invoices by a particular day?](https://api-discuss.freeagent.com/t/filtering-bills-and-invoices-by-a-particular-day/1199)

<div class="topic-metadata">

**Author:** [@rikkipitt](https://api-discuss.freeagent.com/u/rikkipitt)\
**Replies:** 2\
**Last updated:** [4 December 2018 00:18 UTC](https://api-discuss.freeagent.com/t/filtering-bills-and-invoices-by-a-particular-day/1199 "2018-12-04T00:18:30Z")

</div>

Hi folks, Is it possible to retrieve all open and overdue invoices and bills by the date they are due? https://dev.freeagent.com/docs/bills https://dev.freeagent.com/docs/invoices Thanks, Rikki

---

## [Add invoice\_items when creating new invoice](https://api-discuss.freeagent.com/t/add-invoice-items-when-creating-new-invoice/1142)

<div class="topic-metadata">

**Author:** [@justinteractive](https://api-discuss.freeagent.com/u/justinteractive)\
**Replies:** 5\
**Last updated:** [31 October 2018 11:33 UTC](https://api-discuss.freeagent.com/t/add-invoice-items-when-creating-new-invoice/1142 "2018-10-31T11:33:38Z")

</div>

I’ve tried this every which way I can conjure up, but I cannot get the API to add a line item when creating a new invoice. The below array build creates the new invoice without a problem but it won’t add the invoice\_ite…

---

## [Date range validation on Trial Balance report](https://api-discuss.freeagent.com/t/date-range-validation-on-trial-balance-report/987)

<div class="topic-metadata">

**Author:** [@adionica](https://api-discuss.freeagent.com/u/adionica)\
**Replies:** 0\
**Last updated:** [1 May 2018 08:26 UTC](https://api-discuss.freeagent.com/t/date-range-validation-on-trial-balance-report/987 "2018-05-01T08:26:38Z")

</div>

Hi there, I'm curious what's the validation that's being performed on the from\_date and to\_date query parameters that the Trial Balance endpoint accepts. GET https://api.freeagent.com/v2/accounting/trial\_balance/sum…

---

## [Duplicate invoice references when creating multiple invoices](https://api-discuss.freeagent.com/t/duplicate-invoice-references-when-creating-multiple-invoices/931)

<div class="topic-metadata">

**Author:** [@ben007](https://api-discuss.freeagent.com/u/ben007)\
**Replies:** 5\
**Last updated:** [14 March 2018 15:19 UTC](https://api-discuss.freeagent.com/t/duplicate-invoice-references-when-creating-multiple-invoices/931 "2018-03-14T15:19:45Z")

</div>

When creating multiple invoices in a loop... ... one at a time via the API using route https://api.freeagent.com/v2/invoices \[POST\] ... although all those invoices are created perfectly... PROBLEM ... they are all al…

---

## [Accessing additional company fields](https://api-discuss.freeagent.com/t/accessing-additional-company-fields/887)

<div class="topic-metadata">

**Author:** [@BrianSmith](https://api-discuss.freeagent.com/u/BrianSmith)\
**Replies:** 1\
**Last updated:** [8 December 2017 15:24 UTC](https://api-discuss.freeagent.com/t/accessing-additional-company-fields/887 "2017-12-08T15:24:01Z")

</div>

Hi all, Is there a unique ID number for the company rather than the generic url? Thanks

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

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