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

\AvailableBudgetsApi

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

Method	HTTP request	Description
get_available_budget	GET /v1/available-budgets/{id}	Get a single available budget.
list_available_budget	GET /v1/available-budgets	List all available budget amounts.

get_available_budget

models::AvailableBudgetSingle get_available_budget(id, x_trace_id) Get a single available budget.

Get a single available budget, by ID.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the available budget.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::AvailableBudgetSingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

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

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

list_available_budget

models::AvailableBudgetArray list_available_budget(x_trace_id, limit, page, start, end) List all available budget amounts.

Firefly III allows users to set the amount that is available to be budgeted in so-called "available budgets". For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set.

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.
start	Option<String>	A date formatted YYYY-MM-DD.
end	Option<String>	A date formatted YYYY-MM-DD.

Return type

models::AvailableBudgetArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

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

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