Bank Transactions

Minimum access level: Banking, unless stated otherwise.

Attributes

Attribute Description Kind
url The unique identifier for the bank transaction URI
amount Total amount in the company's native currency Decimal
bank_account Transaction's bank account URI
dated_on Date of transaction in YYYY-MM-DD format Date
description Free-text description String
uploaded_at When the transaction was uploaded to FreeAgent Timestamp
unexplained_amount Amount yet to be explained Decimal
is_manual true if transaction was manually added (i.e. not from a statement or bank feed), false otherwise Boolean
bank_transaction_explanations Entries that fully or partially explain this transaction. See Bank Transaction Explanations. Array

List all bank transactions under a certain bank account

GET https://api.freeagent.com/v2/bank_transactions?bank_account=:bank_account

Date Filters

GET https://api.freeagent.com/v2/bank_transactions?bank_account=:bank_account&from_date=2012-01-01&to_date=2012-03-31
GET https://api.freeagent.com/v2/bank_transactions?bank_account=:bank_account&updated_since=2017-05-22T09:00:00.000Z
  • from_date
  • to_date
  • updated_since

View Filters

GET https://api.freeagent.com/v2/bank_transactions?bank_account=:bank_account&view=unexplained
  • all (default)
  • unexplained
  • explained
  • manual
  • imported
  • marked_for_review

Filtering by latest statement upload

Returns only transactions that are part of the last statement that has been uploaded.
Note that this may have been uploaded via the API or by a user via the web interface.

GET https://api.freeagent.com/v2/bank_transactions?bank_account=:bank_account&last_uploaded=true

Response

Status: 200 OK
{ "bank_transactions":[
  {
    "url":"https://api.freeagent.com/v2/bank_transactions/8",
    "amount":"-730.0",
    "bank_account":"https://api.freeagent.com/v2/bank_accounts/1",
    "dated_on":"2010-05-01",
    "description":".Reichert, Kautzer and Schultz/.harness end-to-end e-business 665-454-0057 x55609",
    "unexplained_amount":"0.0",
    "is_manual":false
  },
  {
    "url":"https://api.freeagent.com/v2/bank_transactions/15",
    "amount":"-350.0",
    "bank_account":"https://api.freeagent.com/v2/bank_accounts/1",
    "dated_on":"2010-06-14",
    "description":".Ledner Inc/.mesh enterprise platforms (246)942-9558",
    "unexplained_amount":"0.0",
    "is_manual":false
  }
]}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <bank-transactions type="array">
    <bank-transaction>
      <url>https://api.freeagent.com/v2/bank_transactions/8</url>
      <amount type="decimal">-730.0</amount>
      <bank-account>https://api.freeagent.com/v2/bank_accounts/1</bank-account>
      <dated-on type="date">2010-05-01</dated-on>
      <description>.Reichert, Kautzer and Schultz/.harness end-to-end e-business 665-454-0057 x55609</description>
      <unexplained-amount type="decimal">0.0</unexplained-amount>
      <is-manual type="boolean">false</is-manual>
    </bank-transaction>
    <bank-transaction>
      <url>https://api.freeagent.com/v2/bank_transactions/15</url>
      <amount type="decimal">-350.0</amount>
      <bank-account>https://api.freeagent.com/v2/bank_accounts/1</bank-account>
      <dated-on type="date">2010-06-14</dated-on>
      <description>.Ledner Inc/.mesh enterprise platforms (246)942-9558</description>
      <unexplained-amount type="decimal">0.0</unexplained-amount>
      <is-manual type="boolean">false</is-manual>
    </bank-transaction>
  </bank-transactions>
</freeagent>
Show as JSON

Get a single bank transaction

GET https://api.freeagent.com/v2/bank_transactions/:id

Response

Status: 200 OK
{ "bank_transaction":
  {
    "amount":"-730.0",
    "bank_account":"https://api.freeagent.com/v2/bank_accounts/1",
    "dated_on":"2010-05-01",
    "description":".Reichert, Kautzer and Schultz/.harness end-to-end e-business 665-454-0057 x55609",
    "unexplained_amount":"0.0",
    "is_manual":false,
    "bank_transaction_explanations":[
      {
        "url":"https://api.freeagent.com/v2/bank_transaction_explanations/8",
        "bank_transaction":"https://api.freeagent.com/v2/bank_transactions/8",
        "bank_account":"https://api.freeagent.com/v2/bank_accounts/1",
        "dated_on":"2010-05-01",
        "description":"harness end-to-end e-business",
        "entry_type":"Business Entertaining",
        "gross_value":"-730.0",
      }
    ]
  }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <bank-transaction>
    <amount type="decimal">-730.0</amount>
    <bank-account>https://api.freeagent.com/v2/bank_accounts/1</bank-account>
    <dated-on type="date">2010-05-01</dated-on>
    <description>.Reichert, Kautzer and Schultz/.harness end-to-end e-business 665-454-0057 x55609</description>
    <unexplained-amount type="decimal">0.0</unexplained-amount>
    <is-manual type="boolean">false</is-manual>
    <bank-transaction-explanations type="array">
      <bank-transaction-explanation>
        <url>https://api.freeagent.com/v2/bank_transaction_explanations/8</url>
        <bank-transaction>https://api.freeagent.com/v2/bank_transactions/8</bank-transaction>
        <bank-account>https://api.freeagent.com/v2/bank_accounts/1</bank-account>
        <dated-on type="date">2010-05-01</dated-on>
        <description>harness end-to-end e-business</description>
        <entry-type>Business Entertaining</entry-type>
        <gross-value type="decimal">-730.0</gross-value>
      </bank-transaction-explanation>
    </bank-transaction-explanations>
  </bank-transaction>
</freeagent>
Show as JSON

Upload a bank account statement to a certain bank account

POST https://api.freeagent.com/v2/bank_transactions/statement?bank_account=:bank_account

Input

  • statement (Required) We strongly recommend using OFX, sometimes referred to as QBO or Quickbooks or MS Money 2005. We also support QIF format and some CSV formats.

Response

Status: 200 OK