Skip to content

Latest commit

 

History

History
400 lines (227 loc) · 13.9 KB

AutocompleteApi.md

File metadata and controls

400 lines (227 loc) · 13.9 KB
Raw

\AutocompleteApi

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

Method HTTP request Description
get_accounts_ac GET /api/v1/autocomplete/accounts All accounts of the user returned in a basic auto-complete array.
get_bills_ac GET /api/v1/autocomplete/bills All bills of the user returned in a basic auto-complete array.
get_budgets_ac GET /api/v1/autocomplete/budgets All budgets of the user returned in a basic auto-complete array.
get_categories_ac GET /api/v1/autocomplete/categories All categories of the user returned in a basic auto-complete array.
get_currencies_ac GET /api/v1/autocomplete/currencies All currencies of the user returned in a basic auto-complete array.
get_currencies_code_ac GET /api/v1/autocomplete/currencies-with-code All currencies of the user returned in a basic auto-complete array.
get_object_groups_ac GET /api/v1/autocomplete/object-groups All object groups of the user returned in a basic auto-complete array.
get_rule_groups_ac GET /api/v1/autocomplete/rule-groups All rule groups of the user returned in a basic auto-complete array.
get_rules_ac GET /api/v1/autocomplete/rules All rules of the user returned in a basic auto-complete array.
get_tag_ac GET /api/v1/autocomplete/tags All tags of the user returned in a basic auto-complete array.
get_transaction_types_ac GET /api/v1/autocomplete/transaction-types All transaction types returned in a basic auto-complete array. English only.
get_transactions_ac GET /api/v1/autocomplete/transactions All transaction descriptions of the user returned in a basic auto-complete array.
get_transactions_idac GET /api/v1/autocomplete/transactions-with-id All transactions, complemented with their ID, of the user returned in a basic auto-complete array.

get_accounts_ac

Veccrate::models::AutocompleteAccount get_accounts_ac(query, limit, date, _type) All accounts of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned
date Option<String> For asset accounts, returns the balance on this date.
_type Option<crate::models::AccountTypeFilter> Optional filter on the account type(s) returned

Return type

Veccrate::models::AutocompleteAccount

Authorization

firefly_iii_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

Veccrate::models::AutocompleteBill get_bills_ac(query, limit) All bills of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteBill

Authorization

firefly_iii_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

Veccrate::models::AutocompleteBudget get_budgets_ac(query, limit) All budgets of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteBudget

Authorization

firefly_iii_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

Veccrate::models::AutocompleteCategory get_categories_ac(query, limit) All categories of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteCategory

Authorization

firefly_iii_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

Veccrate::models::AutocompleteCurrency get_currencies_ac(query, limit) All currencies of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteCurrency

Authorization

firefly_iii_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

Veccrate::models::AutocompleteCurrencyCode get_currencies_code_ac(query, limit) All currencies of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteCurrencyCode

Authorization

firefly_iii_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

Veccrate::models::AutocompleteObjectGroup get_object_groups_ac(query, limit) All object groups of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteObjectGroup

Authorization

firefly_iii_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

Veccrate::models::AutocompleteRuleGroup get_rule_groups_ac(query, limit) All rule groups of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteRuleGroup

Authorization

firefly_iii_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

Veccrate::models::AutocompleteRule get_rules_ac(query, limit) All rules of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteRule

Authorization

firefly_iii_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

Veccrate::models::AutocompleteTag get_tag_ac(query, limit) All tags of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteTag

Authorization

firefly_iii_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

Veccrate::models::AutocompleteTransactionType get_transaction_types_ac(query, limit) All transaction types returned in a basic auto-complete array. English only.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteTransactionType

Authorization

firefly_iii_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

Veccrate::models::AutocompleteTransaction get_transactions_ac(query, limit) All transaction descriptions of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteTransaction

Authorization

firefly_iii_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

Veccrate::models::AutocompleteTransactionId get_transactions_idac(query, limit) All transactions, complemented with their ID, of the user returned in a basic auto-complete array.

Parameters

Name Type Description Required Notes
query Option<String> The autocomplete search query.
limit Option<i32> The autocomplete number of items returned

Return type

Veccrate::models::AutocompleteTransactionId

Authorization

firefly_iii_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]