Skip to content

Latest commit

 

History

History
190 lines (134 loc) · 7.24 KB

AvailableBudgetsApi.md

File metadata and controls

190 lines (134 loc) · 7.24 KB

firefly_iii_client.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

AvailableBudgetSingle get_available_budget(id, x_trace_id=x_trace_id)

Get a single available budget.

Get a single available budget, by ID.

Example

  • OAuth Authentication (firefly_iii_auth):
  • Bearer Authentication (local_bearer_auth):
import firefly_iii_client
from firefly_iii_client.models.available_budget_single import AvailableBudgetSingle
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.AvailableBudgetsApi(api_client)
    id = '123' # str | The ID of the available budget.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

    try:
        # Get a single available budget.
        api_response = api_instance.get_available_budget(id, x_trace_id=x_trace_id)
        print("The response of AvailableBudgetsApi->get_available_budget:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AvailableBudgetsApi->get_available_budget: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the available budget.
x_trace_id str Unique identifier associated with this request. [optional]

Return type

AvailableBudgetSingle

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The requested available budget -
400 Bad request -
401 Unauthenticated -
404 Page not found -
500 Internal exception -

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

list_available_budget

AvailableBudgetArray list_available_budget(x_trace_id=x_trace_id, limit=limit, page=page, start=start, end=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.

Example

  • OAuth Authentication (firefly_iii_auth):
  • Bearer Authentication (local_bearer_auth):
import firefly_iii_client
from firefly_iii_client.models.available_budget_array import AvailableBudgetArray
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.AvailableBudgetsApi(api_client)
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    limit = 10 # int | Number of items per page. The default pagination is per 50 items. (optional)
    page = 1 # int | Page number. The default pagination is per 50 items. (optional)
    start = 'Mon Sep 17 00:00:00 UTC 2018' # date | A date formatted YYYY-MM-DD.  (optional)
    end = 'Mon Dec 31 00:00:00 UTC 2018' # date | A date formatted YYYY-MM-DD.  (optional)

    try:
        # List all available budget amounts.
        api_response = api_instance.list_available_budget(x_trace_id=x_trace_id, limit=limit, page=page, start=start, end=end)
        print("The response of AvailableBudgetsApi->list_available_budget:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AvailableBudgetsApi->list_available_budget: %s\n" % e)

Parameters

Name Type Description Notes
x_trace_id str Unique identifier associated with this request. [optional]
limit int Number of items per page. The default pagination is per 50 items. [optional]
page int Page number. The default pagination is per 50 items. [optional]
start date A date formatted YYYY-MM-DD. [optional]
end date A date formatted YYYY-MM-DD. [optional]

Return type

AvailableBudgetArray

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of available budget amounts. -
400 Bad request -
401 Unauthenticated -
404 Page not found -
500 Internal exception -

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