banks2ff/firefly-iii-api/docs/AutocompleteApi.md

\AutocompleteApi

All URIs are relative to https://demo.firefly-iii.org/api

Method	HTTP request	Description
get_accounts_ac	GET /v1/autocomplete/accounts	Returns all accounts of the user returned in a basic auto-complete array.
get_bills_ac	GET /v1/autocomplete/bills	Returns all bills of the user returned in a basic auto-complete array.
get_budgets_ac	GET /v1/autocomplete/budgets	Returns all budgets of the user returned in a basic auto-complete array.
get_categories_ac	GET /v1/autocomplete/categories	Returns all categories of the user returned in a basic auto-complete array.
get_currencies_ac	GET /v1/autocomplete/currencies	Returns all currencies of the user returned in a basic auto-complete array.
get_currencies_code_ac	GET /v1/autocomplete/currencies-with-code	Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
get_object_groups_ac	GET /v1/autocomplete/object-groups	Returns all object groups of the user returned in a basic auto-complete array.
get_piggies_ac	GET /v1/autocomplete/piggy-banks	Returns all piggy banks of the user returned in a basic auto-complete array.
get_piggies_balance_ac	GET /v1/autocomplete/piggy-banks-with-balance	Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
get_recurring_ac	GET /v1/autocomplete/recurring	Returns all recurring transactions of the user returned in a basic auto-complete array.
get_rule_groups_ac	GET /v1/autocomplete/rule-groups	Returns all rule groups of the user returned in a basic auto-complete array.
get_rules_ac	GET /v1/autocomplete/rules	Returns all rules of the user returned in a basic auto-complete array.
get_tag_ac	GET /v1/autocomplete/tags	Returns all tags of the user returned in a basic auto-complete array.
get_transaction_types_ac	GET /v1/autocomplete/transaction-types	Returns all transaction types returned in a basic auto-complete array. English only.
get_transactions_ac	GET /v1/autocomplete/transactions	Returns all transaction descriptions of the user returned in a basic auto-complete array.
get_transactions_idac	GET /v1/autocomplete/transactions-with-id	Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.

get_accounts_ac

Vecmodels::AutocompleteAccount get_accounts_ac(x_trace_id, query, limit, date, types) Returns all accounts of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.
date	Option<String>	If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date.
types	Option<Vecmodels::AccountTypeFilter>	Optional filter on the account type(s) used in the autocomplete.

Return type

Vecmodels::AutocompleteAccount

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_bills_ac

Vecmodels::AutocompleteBill get_bills_ac(x_trace_id, query, limit) Returns all bills of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteBill

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_budgets_ac

Vecmodels::AutocompleteBudget get_budgets_ac(x_trace_id, query, limit) Returns all budgets of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteBudget

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_categories_ac

Vecmodels::AutocompleteCategory get_categories_ac(x_trace_id, query, limit) Returns all categories of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteCategory

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_currencies_ac

Vecmodels::AutocompleteCurrency get_currencies_ac(x_trace_id, query, limit) Returns all currencies of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteCurrency

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_currencies_code_ac

Vecmodels::AutocompleteCurrencyCode get_currencies_code_ac(x_trace_id, query, limit) Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteCurrencyCode

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_object_groups_ac

Vecmodels::AutocompleteObjectGroup get_object_groups_ac(x_trace_id, query, limit) Returns all object groups of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteObjectGroup

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_piggies_ac

Vecmodels::AutocompletePiggy get_piggies_ac(x_trace_id, query, limit) Returns all piggy banks of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompletePiggy

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_piggies_balance_ac

Vecmodels::AutocompletePiggyBalance get_piggies_balance_ac(x_trace_id, query, limit) Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompletePiggyBalance

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_recurring_ac

Vecmodels::AutocompleteRecurrence get_recurring_ac(x_trace_id, query, limit) Returns all recurring transactions of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteRecurrence

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rule_groups_ac

Vecmodels::AutocompleteRuleGroup get_rule_groups_ac(x_trace_id, query, limit) Returns all rule groups of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteRuleGroup

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rules_ac

Vecmodels::AutocompleteRule get_rules_ac(x_trace_id, query, limit) Returns all rules of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteRule

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tag_ac

Vecmodels::AutocompleteTag get_tag_ac(x_trace_id, query, limit) Returns all tags of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteTag

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_transaction_types_ac

Vecmodels::AutocompleteTransactionType get_transaction_types_ac(x_trace_id, query, limit) Returns all transaction types returned in a basic auto-complete array. English only.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteTransactionType

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_transactions_ac

Vecmodels::AutocompleteTransaction get_transactions_ac(x_trace_id, query, limit) Returns all transaction descriptions of the user returned in a basic auto-complete array.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteTransaction

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_transactions_idac

Vecmodels::AutocompleteTransactionId get_transactions_idac(x_trace_id, query, limit) Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
query	Option<String>	The autocomplete search query.
limit	Option<i32>	The number of items returned.

Return type

Vecmodels::AutocompleteTransactionId

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]