Sign in
autocomplete

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

get/v1/autocomplete/piggy-banks-with-balance

Request

  • Base URL: https://demo.firefly-iii.org/api
  • URL: https://demo.firefly-iii.org/api/v1/autocomplete/piggy-banks-with-balance
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://demo.firefly-iii.org/oauth/authorize, token URL https://demo.firefly-iii.org/oauth/token)
    • HTTP bearer

Query parameters

querystring string

The autocomplete search query.

limitinteger

The number of items returned.

Headers

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

Unique identifier associated with this request.

Response

A list of piggy banks with very basic balance information.

idstring string required
namestring string required

Name of the piggy bank found by an auto-complete search.

name_with_balancestring string

Name of the piggy bank found by an auto-complete search, including the currently saved amount and the target amount.

currency_idstring string

Currency ID for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.

currency_codestring string

Currency code for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.

currency_symbolstring string

Currency symbol for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.

currency_decimal_placesinteger

Currency decimal places for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.

object_group_idstring string nullable

The group ID of the group this object is part of. NULL if no group.

object_group_titlestring string nullable

The name of the group. NULL if no group.

Example response

[
  {
    "id": "2",
    "name": "New couch",
    "name_with_balance": "New couch ($234.56 / $600)",
    "currency_id": "12",
    "currency_code": "EUR",
    "currency_symbol": "$",
    "currency_decimal_places": 2,
    "object_group_id": "5",
    "object_group_title": "Example Group"
  }
]

Changes

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