firefly_iii_client.TransactionsApi

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

Method	HTTP request	Description
delete_transaction	DELETE /v1/transactions/{id}	Delete a transaction.
delete_transaction_journal	DELETE /v1/transaction-journals/{id}	Delete split from transaction
get_transaction	GET /v1/transactions/{id}	Get a single transaction.
get_transaction_by_journal	GET /v1/transaction-journals/{id}	Get a single transaction, based on one of the underlying transaction journals (transaction splits).
list_attachment_by_transaction	GET /v1/transactions/{id}/attachments	Lists all attachments.
list_event_by_transaction	GET /v1/transactions/{id}/piggy-bank-events	Lists all piggy bank events.
list_links_by_journal	GET /v1/transaction-journals/{id}/links	Lists all the transaction links for an individual journal (individual split).
list_transaction	GET /v1/transactions	List all the user's transactions.
store_transaction	POST /v1/transactions	Store a new transaction
update_transaction	PUT /v1/transactions/{id}	Update existing transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/

delete_transaction

delete_transaction(id, x_trace_id=x_trace_id)

Delete a transaction.

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

    try:
        # Delete a transaction.
        api_instance.delete_transaction(id, x_trace_id=x_trace_id)
    except Exception as e:
        print("Exception when calling TransactionsApi->delete_transaction: %s\n" % e)

Parameters

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

delete_transaction_journal

delete_transaction_journal(id, x_trace_id=x_trace_id)

Delete split from transaction

Delete an individual journal (split) from a transaction.

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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction journal (the split) you wish to delete.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

    try:
        # Delete split from transaction
        api_instance.delete_transaction_journal(id, x_trace_id=x_trace_id)
    except Exception as e:
        print("Exception when calling TransactionsApi->delete_transaction_journal: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the transaction journal (the split) you wish to delete.
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	Transaction journal (split) 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_transaction

TransactionSingle get_transaction(id, x_trace_id=x_trace_id)

Get a single transaction.

Example

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

import firefly_iii_client
from firefly_iii_client.models.transaction_single import TransactionSingle
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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction.
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

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

Parameters

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

Return type

TransactionSingle

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 transaction.	-
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_transaction_by_journal

TransactionSingle get_transaction_by_journal(id, x_trace_id=x_trace_id)

Get a single transaction, based on one of the underlying transaction journals (transaction splits).

Get a single transaction by underlying journal (split).

Example

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

import firefly_iii_client
from firefly_iii_client.models.transaction_single import TransactionSingle
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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction journal (split).
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)

    try:
        # Get a single transaction, based on one of the underlying transaction journals (transaction splits).
        api_response = api_instance.get_transaction_by_journal(id, x_trace_id=x_trace_id)
        print("The response of TransactionsApi->get_transaction_by_journal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->get_transaction_by_journal: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the transaction journal (split).
x_trace_id	str	Unique identifier associated with this request.	[optional]

Return type

TransactionSingle

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 transaction.	-
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_transaction

AttachmentArray list_attachment_by_transaction(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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction.
    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_transaction(id, x_trace_id=x_trace_id, limit=limit, page=page)
        print("The response of TransactionsApi->list_attachment_by_transaction:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->list_attachment_by_transaction: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the transaction.
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_transaction

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

Lists all piggy bank events.

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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction.
    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 piggy bank events.
        api_response = api_instance.list_event_by_transaction(id, x_trace_id=x_trace_id, limit=limit, page=page)
        print("The response of TransactionsApi->list_event_by_transaction:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->list_event_by_transaction: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the transaction.
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 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_links_by_journal

TransactionLinkArray list_links_by_journal(id, x_trace_id=x_trace_id, limit=limit, page=page)

Lists all the transaction links for an individual journal (individual split).

Lists all the transaction links for an individual journal (a split). Don't use the group ID, you need the actual underlying journal (the split).

Example

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

import firefly_iii_client
from firefly_iii_client.models.transaction_link_array import TransactionLinkArray
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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction journal / the split.
    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 the transaction links for an individual journal (individual split).
        api_response = api_instance.list_links_by_journal(id, x_trace_id=x_trace_id, limit=limit, page=page)
        print("The response of TransactionsApi->list_links_by_journal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->list_links_by_journal: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The ID of the transaction journal / the split.
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

TransactionLinkArray

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 transaction links.	-
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_transaction

TransactionArray list_transaction(x_trace_id=x_trace_id, limit=limit, page=page, start=start, end=end, type=type)

List all the user's transactions.

Example

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

import firefly_iii_client
from firefly_iii_client.models.transaction_array import TransactionArray
from firefly_iii_client.models.transaction_type_filter import TransactionTypeFilter
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.TransactionsApi(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. This is the start date of the selected range (inclusive).  (optional)
    end = 'Mon Sep 17 00:00:00 UTC 2018' # date | A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).  (optional)
    type = firefly_iii_client.TransactionTypeFilter() # TransactionTypeFilter | Optional filter on the transaction type(s) returned. (optional)

    try:
        # List all the user's transactions. 
        api_response = api_instance.list_transaction(x_trace_id=x_trace_id, limit=limit, page=page, start=start, end=end, type=type)
        print("The response of TransactionsApi->list_transaction:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->list_transaction: %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. This is the start date of the selected range (inclusive).	[optional]
end	date	A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).	[optional]
type	TransactionTypeFilter	Optional filter on the transaction type(s) returned.	[optional]

Return type

TransactionArray

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 transactions.	-
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_transaction

TransactionSingle store_transaction(transaction_store, x_trace_id=x_trace_id)

Store a new transaction

Creates a new transaction. 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.transaction_single import TransactionSingle
from firefly_iii_client.models.transaction_store import TransactionStore
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.TransactionsApi(api_client)
    transaction_store = firefly_iii_client.TransactionStore() # TransactionStore | JSON array or key=value pairs with the necessary transaction 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 transaction
        api_response = api_instance.store_transaction(transaction_store, x_trace_id=x_trace_id)
        print("The response of TransactionsApi->store_transaction:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->store_transaction: %s\n" % e)

Parameters

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

Return type

TransactionSingle

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 transaction stored(s), 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_transaction

TransactionSingle update_transaction(id, transaction_update, x_trace_id=x_trace_id)

Update existing transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/

Update an existing transaction.

Example

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

import firefly_iii_client
from firefly_iii_client.models.transaction_single import TransactionSingle
from firefly_iii_client.models.transaction_update import TransactionUpdate
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.TransactionsApi(api_client)
    id = '123' # str | The ID of the transaction.
    transaction_update = firefly_iii_client.TransactionUpdate() # TransactionUpdate | JSON array with updated transaction 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 transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
        api_response = api_instance.update_transaction(id, transaction_update, x_trace_id=x_trace_id)
        print("The response of TransactionsApi->update_transaction:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->update_transaction: %s\n" % e)

Parameters

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

Return type

TransactionSingle

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 transaction 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

TransactionsApi.md

Latest commit

History

TransactionsApi.md

File metadata and controls

firefly_iii_client.TransactionsApi

delete_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_transaction_journal

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_transaction_by_journal

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_attachment_by_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_event_by_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_links_by_journal

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

store_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details