Sign in

v1

latestOpenAPI 3.0.12026-07-135618141.0 KB
Transaction Accounts

Update transaction account

Updates the transaction account by its ID.

put/transaction_accounts/{id}

Path parameters

idinteger required

The unique identifier of the transaction account.

Request body

institution_idinteger

The unique identifier of a new institution for the transaction account.

starting_balancenumber

The starting balance amount of the transaction account.

starting_balance_datestring

The starting balance date of the transaction account.

Example request

{
  "institution_id": 42,
  "starting_balance": 3547.45,
  "starting_balance_date": "2015-03-15"
}

Response

Success

idinteger
namestring
numberstring
current_balancenumber
current_balance_datestring
current_balance_in_base_currencynumber

The current balance of the transaction account in the user's base currency.

current_balance_exchange_ratenumber

The exchange rate between the transaction account's currency and the user's base currency, when different. If the currencies are the same, null is returned.

safe_balancenumber

The current safe balance, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned.

safe_balance_in_base_currencynumber

The current safe balance in the user's base currency, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned.

starting_balancenumber
starting_balance_datestring
created_atstring
updated_atstring
currency_codestring

The currency that the account is in. This is determined by the account that the transaction account belongs to.

type'bank' | 'credits' | 'cash' | 'stocks' | 'mortgage' | 'loans' | 'vehicle' | 'property' | 'insurance' | 'other_asset' | 'other_liability'

The type of the transaction account.

Example response

{
  "id": 96027,
  "name": "Sample Credit",
  "number": "ASBCRD44554",
  "current_balance": 2694.39,
  "current_balance_date": "2015-07-03",
  "current_balance_in_base_currency": 4041.59,
  "current_balance_exchange_rate": 1.5,
  "safe_balance": 2694.39,
  "safe_balance_in_base_currency": 4041.59,
  "starting_balance": 3547.45,
  "starting_balance_date": "2015-03-15",
  "created_at": "2015-03-17T02:42:10Z",
  "updated_at": "2015-07-02T22:14:49Z",
  "institution": {
    "currency_code": "NZD",
    "title": "Bank of Foo",
    "updated_at": "2015-04-21T22:42:22Z",
    "created_at": "2015-04-21T22:42:22Z",
    "id": 57
  },
  "currency_code": "NZD",
  "type": "bank"
}