firefly_iii_client.PiggyBanksApi

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

Method	HTTP request	Description
delete_piggy_bank	DELETE /v1/piggy-banks/{id}	Delete a piggy bank.
get_piggy_bank	GET /v1/piggy-banks/{id}	Get a single piggy bank.
list_attachment_by_piggy_bank	GET /v1/piggy-banks/{id}/attachments	Lists all attachments.
list_event_by_piggy_bank	GET /v1/piggy-banks/{id}/events	List all events linked to a piggy bank.
list_piggy_bank	GET /v1/piggy-banks	List all piggy banks.
store_piggy_bank	POST /v1/piggy-banks	Store a new piggy bank
update_piggy_bank	PUT /v1/piggy-banks/{id}	Update existing piggy bank.

delete_piggy_bank

delete_piggy_bank(id, x_trace_id=x_trace_id)

Delete a piggy bank.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
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.PiggyBanksApi(api_client)
    id = '123' # str | The ID of the piggy bank.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

    try:
        # Delete a piggy bank.
        api_instance.delete_piggy_bank(id, x_trace_id=x_trace_id)
    except Exception as e:
        print("Exception when calling PiggyBanksApi->delete_piggy_bank: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Piggy bank deleted.	-
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]

get_piggy_bank

PiggyBankSingle get_piggy_bank(id, x_trace_id=x_trace_id)

Get a single piggy bank.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.piggy_bank_single import PiggyBankSingle
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.PiggyBanksApi(api_client)
    id = '123' # str | The ID of the piggy bank.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

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

Parameters

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

Return type

PiggyBankSingle

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 piggy bank	-
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_attachment_by_piggy_bank

AttachmentArray list_attachment_by_piggy_bank(id, x_trace_id=x_trace_id, limit=limit, page=page)

Lists all attachments.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.attachment_array import AttachmentArray
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.PiggyBanksApi(api_client)
    id = '123' # str | The ID of the piggy bank.
    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)

    try:
        # Lists all attachments.
        api_response = api_instance.list_attachment_by_piggy_bank(id, x_trace_id=x_trace_id, limit=limit, page=page)
        print("The response of PiggyBanksApi->list_attachment_by_piggy_bank:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PiggyBanksApi->list_attachment_by_piggy_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the piggy bank.
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]

Return type

AttachmentArray

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 attachments	-
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_event_by_piggy_bank

PiggyBankEventArray list_event_by_piggy_bank(id, x_trace_id=x_trace_id, limit=limit, page=page)

List all events linked to a piggy bank.

List all events linked to a piggy bank (adding and removing money).

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.piggy_bank_event_array import PiggyBankEventArray
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.PiggyBanksApi(api_client)
    id = '123' # str | The ID of the piggy bank
    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)

    try:
        # List all events linked to a piggy bank.
        api_response = api_instance.list_event_by_piggy_bank(id, x_trace_id=x_trace_id, limit=limit, page=page)
        print("The response of PiggyBanksApi->list_event_by_piggy_bank:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PiggyBanksApi->list_event_by_piggy_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the piggy bank
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]

Return type

PiggyBankEventArray

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 piggy bank related events	-
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_piggy_bank

PiggyBankArray list_piggy_bank(x_trace_id=x_trace_id, limit=limit, page=page)

List all piggy banks.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.piggy_bank_array import PiggyBankArray
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.PiggyBanksApi(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)

    try:
        # List all piggy banks.
        api_response = api_instance.list_piggy_bank(x_trace_id=x_trace_id, limit=limit, page=page)
        print("The response of PiggyBanksApi->list_piggy_bank:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PiggyBanksApi->list_piggy_bank: %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]

Return type

PiggyBankArray

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 piggy banks	-
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]

store_piggy_bank

PiggyBankSingle store_piggy_bank(piggy_bank_store, x_trace_id=x_trace_id)

Store a new piggy bank

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

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.piggy_bank_single import PiggyBankSingle
from firefly_iii_client.models.piggy_bank_store import PiggyBankStore
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.PiggyBanksApi(api_client)
    piggy_bank_store = firefly_iii_client.PiggyBankStore() # PiggyBankStore | JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

    try:
        # Store a new piggy bank
        api_response = api_instance.store_piggy_bank(piggy_bank_store, x_trace_id=x_trace_id)
        print("The response of PiggyBanksApi->store_piggy_bank:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PiggyBanksApi->store_piggy_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
piggy_bank_store	PiggyBankStore	JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.
x_trace_id	str	Unique identifier associated with this request.	[optional]

Return type

PiggyBankSingle

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

HTTP response details

Status code	Description	Response headers
200	New piggy bank stored, result in response.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
422	Validation error. The body will have the exact details.	-
500	Internal exception	-

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

update_piggy_bank

PiggyBankSingle update_piggy_bank(id, piggy_bank_update, x_trace_id=x_trace_id)

Update existing piggy bank.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.piggy_bank_single import PiggyBankSingle
from firefly_iii_client.models.piggy_bank_update import PiggyBankUpdate
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.PiggyBanksApi(api_client)
    id = '123' # str | The ID of the piggy bank
    piggy_bank_update = firefly_iii_client.PiggyBankUpdate() # PiggyBankUpdate | JSON array with updated piggy bank information. See the model for the exact specifications.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

    try:
        # Update existing piggy bank.
        api_response = api_instance.update_piggy_bank(id, piggy_bank_update, x_trace_id=x_trace_id)
        print("The response of PiggyBanksApi->update_piggy_bank:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PiggyBanksApi->update_piggy_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the piggy bank
piggy_bank_update	PiggyBankUpdate	JSON array with updated piggy bank information. See the model for the exact specifications.
x_trace_id	str	Unique identifier associated with this request.	[optional]

Return type

PiggyBankSingle

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

HTTP response details

Status code	Description	Response headers
200	Updated piggy bank stored, result in response	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
422	Validation error. The body will have the exact details.	-
500	Internal exception	-

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

Files

PiggyBanksApi.md

Latest commit

History

PiggyBanksApi.md

File metadata and controls

firefly_iii_client.PiggyBanksApi

delete_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_attachment_by_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_event_by_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

store_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_piggy_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details