ynab-transaction-adjuster 0.3.7

Library to adjust transactions in YNAB based on custom patterns

ynab-transaction-adjuster

This library helps you to automatically adjust transactions in YNAB based on your logic. It allows you to implement your adjustments in a simple factory class which you can run against your existing transactions and update relevant fields like date, payee, category, memo and flags. It also allows you to split transactions.

Preparations

1. Create a personal access token for YNAB as described here
2. Get the IDs of your budget and account which records are faulty. You can find both IDs if you go to https://app.ynab.com/ and open the target account by clicking on the name on the left hand side menu. The URL does now contain both IDs https://app.ynab.com/<budget_id>/accounts/<account_id>

Installation

Install library from PyPI

pip install ynab-transaction-adjuster

Usage

A detailed documentation is available at https://ynab-transaction-adjuster.readthedocs.io

Basic Usage

Create an Adjuster

Create a child class of YnabTransactionAdjuster. This class needs to implement a filter() and an adjust() method which contain the intended logic. The filter() method receives a list of OriginalTransaction objects which can be filtered before adjustement. The adjust() method receives a singular OriginalTransaction and a TransactionModifier. The latter is prefilled with values from the original transaction. Its attributes can be modified, and it needs to be returned at the end of the function. Please check the detailed usage section for explanations how to change different attributes.

from ynabtransactionadjuster import YnabTransactionAdjuster
from ynabtransactionadjuster.models import OriginalTransaction, TransactionModifier


class MyAdjuster(YnabTransactionAdjuster):
    
    def filter(self, transactions: List[OriginalTransaction]) -> List[OriginalTransaction]:
        # your implementation
        
        # return the filtered list of transactions
        return transactions
        
    def adjust(self, original: OriginalTransaction, modifier: TransactionModifier) -> TransactionModifier:
        # your implementation

		# return the altered modifier
		return modifier

Initialize

Initalize the adjuster with token, budget and account from YNAB

my_adjuster = MyAdjuster(token='<token>', budget='<budget>', account='<account>')

Test

Test the adjuster on records fetched via the test()method. The method fetches and executes the adjustments but doesn't write the results back to YNAB. Instead it returns a list of the changed transactions which can be inspected for the changed properties.

mod_transactions = my_adjuster.test()

Run

If you are satisfied with the functionality you can execute the adjuster with the run() method. This will run the adjustments and will update the changed transactions in YNAB. The method returns an integer with the number of successfully updated records.

count_of_updated_transactions = my_adjuster.run()