FIfirefly-iii
autocomplete

Returns all accounts of the user returned in a basic auto-complete array.

get/v1/autocomplete/accounts

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/autocomplete/accounts
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Query parameters

querystring string

The autocomplete search query.

limitinteger

The number of items returned.

datestring string

If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date.

typesAccountTypeFilter[]

Optional filter on the account type(s) used in the autocomplete.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of accounts with very basic information.

idstring string required
namestring string required

Name of the account found by an auto-complete search.

name_with_balancestring string required

Asset accounts and liabilities have a second field with the given date's account balance in the account currency or primary currency.

typestring string required

Account type of the account found by the auto-complete search.

currency_idstring string required

ID for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

currency_namestring string required

Currency name for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

currency_codestring string required

Currency code for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

currency_symbolstring string required

Currency symbol for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

currency_decimal_placesinteger required

Number of decimal places for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

account_currency_idstring string

ID for the currency used by this account. Even if "convertToPrimary" is on, the account currency ID is displayed here.

account_currency_namestring string

Name for the currency used by this account. Even if "convertToPrimary" is on, the account currency name is displayed here.

account_currency_codestring string

Code for the currency used by this account. Even if "convertToPrimary" is on, the account currency code is displayed here.

account_currency_symbolstring string

Code for the currency used by this account. Even if "convertToPrimary" is on, the account currency code is displayed here.

account_currency_decimal_placesinteger

Number of decimal places for the currency used by this account. Even if "convertToPrimary" is on, the account currency code is displayed here.

Example response

[
  {
    "id": "2",
    "name": "Checking Account",
    "name_with_balance": "Checking Account ($123.45)",
    "type": "Asset account",
    "currency_id": "12",
    "currency_name": "Euro",
    "currency_code": "EUR",
    "currency_symbol": "$",
    "currency_decimal_places": 2,
    "account_currency_id": "2",
    "account_currency_name": "US Dollar",
    "account_currency_code": "USD",
    "account_currency_symbol": "$",
    "account_currency_decimal_places": 2
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.