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

\CurrenciesApi

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

Method	HTTP request	Description
default_currency	POST /v1/currencies/{code}/default	Make currency default currency.
delete_currency	DELETE /v1/currencies/{code}	Delete a currency.
disable_currency	POST /v1/currencies/{code}/disable	Disable a currency.
enable_currency	POST /v1/currencies/{code}/enable	Enable a single currency.
get_currency	GET /v1/currencies/{code}	Get a single currency.
get_default_currency	GET /v1/currencies/default	Get the user's default currency.
list_account_by_currency	GET /v1/currencies/{code}/accounts	List all accounts with this currency.
list_available_budget_by_currency	GET /v1/currencies/{code}/available-budgets	List all available budgets with this currency.
list_bill_by_currency	GET /v1/currencies/{code}/bills	List all bills with this currency.
list_budget_limit_by_currency	GET /v1/currencies/{code}/budget_limits	List all budget limits with this currency
list_currency	GET /v1/currencies	List all currencies.
list_recurrence_by_currency	GET /v1/currencies/{code}/recurrences	List all recurring transactions with this currency.
list_rule_by_currency	GET /v1/currencies/{code}/rules	List all rules with this currency.
list_transaction_by_currency	GET /v1/currencies/{code}/transactions	List all transactions with this currency.
store_currency	POST /v1/currencies	Store a new currency
update_currency	PUT /v1/currencies/{code}	Update existing currency.

default_currency

models::CurrencySingle default_currency(code, x_trace_id) Make currency default currency.

Make this currency the default currency for the user. If the currency is not enabled, it will be enabled as well.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

delete_currency

delete_currency(code, x_trace_id) Delete a currency.

Delete a currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

(empty response body)

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]

disable_currency

models::CurrencySingle disable_currency(code, x_trace_id) Disable a currency.

Disable a currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

enable_currency

models::CurrencySingle enable_currency(code, x_trace_id) Enable a single currency.

Enable a single currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

get_currency

models::CurrencySingle get_currency(code, x_trace_id) Get a single currency.

Get a single currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

get_default_currency

models::CurrencySingle get_default_currency(x_trace_id) Get the user's default currency.

Get the user's default currency.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

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]

list_account_by_currency

models::AccountArray list_account_by_currency(code, x_trace_id, limit, page, date, r#type) List all accounts with this currency.

List all accounts with this currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.
date	Option<String>	A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day.
r#type	Option<AccountTypeFilter>	Optional filter on the account type(s) returned

Return type

models::AccountArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_available_budget_by_currency

models::AvailableBudgetArray list_available_budget_by_currency(code, x_trace_id, limit, page) List all available budgets with this currency.

List all available budgets with this currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::AvailableBudgetArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_bill_by_currency

models::BillArray list_bill_by_currency(code, x_trace_id, limit, page) List all bills with this currency.

List all bills with this currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::BillArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_budget_limit_by_currency

models::BudgetLimitArray list_budget_limit_by_currency(code, x_trace_id, limit, page, start, end) List all budget limits with this currency

List all budget limits with this currency

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.
start	Option<String>	Start date for the budget limit list.
end	Option<String>	End date for the budget limit list.

Return type

models::BudgetLimitArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_currency

models::CurrencyArray list_currency(x_trace_id, limit, page) List all currencies.

List all currencies.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::CurrencyArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_recurrence_by_currency

models::RecurrenceArray list_recurrence_by_currency(code, x_trace_id, limit, page) List all recurring transactions with this currency.

List all recurring transactions with this currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::RecurrenceArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_rule_by_currency

models::RuleArray list_rule_by_currency(code, x_trace_id, limit, page) List all rules with this currency.

List all rules with this currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::RuleArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

list_transaction_by_currency

models::TransactionArray list_transaction_by_currency(code, x_trace_id, limit, page, start, end, r#type) List all transactions with this currency.

List all transactions with this currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.
start	Option<String>	A date formatted YYYY-MM-DD, to limit the list of transactions.
end	Option<String>	A date formatted YYYY-MM-DD, to limit the list of transactions.
r#type	Option<TransactionTypeFilter>	Optional filter on the transaction type(s) returned

Return type

models::TransactionArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json, application/json

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

store_currency

models::CurrencySingle store_currency(currency_store, x_trace_id) Store a new currency

Creates a new currency. The data required can be submitted as a JSON body or as a list of parameters.

Parameters

Name	Type	Description	Required	Notes
currency_store	CurrencyStore	JSON array or key=value pairs with the necessary currency information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded
• Accept: application/vnd.api+json, application/json

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

update_currency

models::CurrencySingle update_currency(code, currency_update, x_trace_id) Update existing currency.

Update existing currency.

Parameters

Name	Type	Description	Required	Notes
code	String	The currency code.	[required]
currency_update	CurrencyUpdate	JSON array with updated currency information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::CurrencySingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

• Content-Type: application/vnd.api+json, application/x-www-form-urlencoded
• Accept: application/json

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