v0.7.8 (#273)

* v.0.7.7

* Enhance account list views and update icon styles.

Implemented dynamic page titles and subtitles for account pages by overriding `get_context_data`. Updated template text and classes for greater consistency, including standardizing icon colors for active, locked, and default roles.

* Adding TransactionModel attributes during commit_txs.

* Fixed a couple of hard coded dollar "$" symbols and changed them with `{% currency_symbol %}` tag to render the correct symbol when `DJANGO_LEDGER_CURRENCY_SYMBOL` is other than default ("$"). (#265)

* Dependency update

* Update contribution guidelines in README and Contribute.md

Clarified the types of pull requests that are encouraged, emphasizing those that address bug fixes, enhancements, or valuable additions. Added a note discouraging submissions focused only on cosmetic changes like linting or refactoring.

* Update ManyToManyField configurations and bump version to 0.7.8

Adjusted `ManyToManyField` relationships in `BillModel`, `InvoiceModel`, and `PurchaseOrderModel` to include `through` and `through_fields` for `ItemTransactionModel`. Incremented package version to `0.7.8`.

* Add support for bank account type validation and retrieval based on OFX standards

- Introduced `bank_account_type` field in `BankAccountModel` with predefined choices.
- Added methods to retrieve routing number, account type, and account type validation in `OFXImport` class.
- Enhanced account queries with a new `.cash()` method to filter accounts with `ASSET_CA_CASH` role.
- Updated indexing and unique constraints for `BankAccountModel`.

* Migration Update

* Refactor bank account type handling and account type mapping logic

- Replaced `BankAccountModel.BANK_ACCOUNT_TYPES` with explicit OFX types.
- Renamed `ACCOUNT_TYPE_ROLE_MAPPING` to `ACCOUNT_TYPE_DEFAULT_ROLE_MAPPING`.
- Centralized OFX type mappings in `ACCOUNT_TYPE_OFX_MAPPING`.
- Removed `bank_account_type` field from `BankAccountModel`.
- Added `get_account_type_from_ofx` method for retrieving account type from OFX data.

* Add financial institution field and utility methods to account models

- Introduced `financial_institution` field in account mixin for storing bank details.
- Added `get_account_last_digits` utility for partial account number retrieval.
- Implemented `can_hide` and `can_unhide` methods in `BankAccountModel`.

* Refactor account handling and enhance validation methods

- Renamed `get_account_type` to `get_ofx_account_type` for clarity in OFX implementation.
- Added `get_account_type` method to map OFX account types to internal account types.
- Introduced `get_routing_last_digits` method for masked routing number retrieval.
- Improved handling of missing account and routing numbers in utility methods.

---------

Co-authored-by: Pablo Santa Cruz <[email protected]>

Author: elarroba

django_ledger/__init__.py

@@ -6,7 +6,7 @@
 default_app_config = 'django_ledger.apps.DjangoLedgerConfig'
 
 """Django Ledger"""
-__version__ = '0.7.7'
+__version__ = '0.7.8'
 __license__ = 'GPLv3 License'
 
 __author__ = 'Miguel Sanda'

django_ledger/io/ofx.py

@@ -7,6 +7,7 @@
 """
 
 from typing import List, Optional, Dict
+from django_ledger.models.bank_account import BankAccountModel
 
 from django.core.exceptions import ValidationError
 from ofxtools import OFXTree
@@ -64,6 +65,30 @@ def get_account_data(self):
     def get_account_number(self):
         return self.get_account_data()['account'].acctid
 
+    def get_routing_number(self):
+        return self.get_account_data()['account'].bankid
+
+    def get_ofx_account_type(self):
+        """
+        Gets the account type as defined in the OFX (Open Financial Exchange) specification.
+
+        Returns:
+            str: One of the following standardized account types:
+                - 'CHECKING'   - Standard checking account
+                - 'SAVINGS'    - Savings account
+                - 'MONEYMRKT'  - Money Market account
+                - 'CREDITLINE' - Credit line account
+                - 'CD'         - Certificate of Deposit
+        """
+        acc_type = self.get_account_data()['account'].accttype
+
+        if acc_type not in ['CHECKING', 'SAVINGS', 'MONEYMRKT', 'CREDITLINE', 'CD']:
+            raise OFXImportValidationError(f'Account type "{acc_type}" is not supported.')
+        return acc_type
+
+    def get_account_type(self):
+        return BankAccountModel.ACCOUNT_TYPE_OFX_MAPPING[self.get_ofx_account_type()]
+
     def get_account_txs(self):
         acc_statement = next(iter(
             st for st in self.ofx_data.statements if st.account.acctid == self.get_account_number()

django_ledger/migrations/0022_bankaccountmodel_financial_institution_and_more.py

@@ -0,0 +1,52 @@
+# Generated by Django 5.2.1 on 2025-06-24 21:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_ledger', '0021_alter_bankaccountmodel_account_model_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='bankaccountmodel',
+            name='financial_institution',
+            field=models.CharField(blank=True, help_text='Name of the financial institution (i.e. Bank Name).', max_length=100, null=True, verbose_name='Financial Institution'),
+        ),
+        migrations.AddField(
+            model_name='vendormodel',
+            name='financial_institution',
+            field=models.CharField(blank=True, help_text='Name of the financial institution (i.e. Bank Name).', max_length=100, null=True, verbose_name='Financial Institution'),
+        ),
+        migrations.AlterField(
+            model_name='bankaccountmodel',
+            name='account_type',
+            field=models.CharField(choices=[('checking', 'Checking'), ('savings', 'Savings'), ('money_market', 'Money Market'), ('cert_deposit', 'Certificate of Deposit'), ('credit_card', 'Credit Card'), ('st_loan', 'Short Term Loan'), ('lt_loan', 'Long Term Loan'), ('mortgage', 'Mortgage'), ('other', 'Other')], default='checking', max_length=20, verbose_name='Account Type'),
+        ),
+        migrations.AlterField(
+            model_name='billmodel',
+            name='bill_items',
+            field=models.ManyToManyField(through='django_ledger.ItemTransactionModel', through_fields=('bill_model', 'item_model'), to='django_ledger.itemmodel', verbose_name='Bill Items'),
+        ),
+        migrations.AlterField(
+            model_name='invoicemodel',
+            name='invoice_items',
+            field=models.ManyToManyField(through='django_ledger.ItemTransactionModel', through_fields=('invoice_model', 'item_model'), to='django_ledger.itemmodel', verbose_name='Invoice Items'),
+        ),
+        migrations.AlterField(
+            model_name='purchaseordermodel',
+            name='po_items',
+            field=models.ManyToManyField(through='django_ledger.ItemTransactionModel', through_fields=('po_model', 'item_model'), to='django_ledger.itemmodel', verbose_name='Purchase Order Items'),
+        ),
+        migrations.AlterField(
+            model_name='vendormodel',
+            name='account_type',
+            field=models.CharField(choices=[('checking', 'Checking'), ('savings', 'Savings'), ('money_market', 'Money Market'), ('cert_deposit', 'Certificate of Deposit'), ('credit_card', 'Credit Card'), ('st_loan', 'Short Term Loan'), ('lt_loan', 'Long Term Loan'), ('mortgage', 'Mortgage'), ('other', 'Other')], default='checking', max_length=20, verbose_name='Account Type'),
+        ),
+        migrations.AddIndex(
+            model_name='bankaccountmodel',
+            index=models.Index(fields=['entity_model'], name='django_ledg_entity__6ad006_idx'),
+        ),
+    ]

django_ledger/models/accounts.py

@@ -65,7 +65,7 @@
     GROUP_ASSETS, GROUP_LIABILITIES, GROUP_CAPITAL, GROUP_INCOME, GROUP_EXPENSES, GROUP_COGS,
     ROOT_GROUP, BS_BUCKETS, ROOT_ASSETS, ROOT_LIABILITIES,
     ROOT_CAPITAL, ROOT_INCOME, ROOT_EXPENSES, ROOT_COA, VALID_PARENTS,
-    ROLES_ORDER_ALL
+    ROLES_ORDER_ALL, ASSET_CA_CASH
 )
 from django_ledger.models.mixins import CreateUpdateMixIn
 from django_ledger.models.utils import lazy_loader
@@ -161,6 +161,10 @@ def with_codes(self, codes: Union[List, str]):
             codes = [codes]
         return self.filter(code__in=codes)
 
+    def cash(self):
+        """Retrieve accounts that are of type ASSET_CA_CASH."""
+        return self.filter(role__exact=ASSET_CA_CASH)
+
     def expenses(self):
         """
         Retrieve a queryset containing expenses filtered by specified roles.

django_ledger/models/bank_account.py

@@ -12,7 +12,7 @@
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ValidationError
 from django.db import models
-from django.db.models import Q, QuerySet
+from django.db.models import Q, QuerySet, Manager
 from django.shortcuts import get_object_or_404
 from django.utils.translation import gettext_lazy as _
 
@@ -55,7 +55,7 @@ def hidden(self) -> QuerySet:
         return self.filter(hidden=True)
 
 
-class BankAccountModelManager(models.Manager):
+class BankAccountModelManager(Manager):
     """
     Custom defined Model Manager for the BankAccountModel.
     """
@@ -126,10 +126,12 @@ class BankAccountModelAbstract(FinancialAccountInfoMixin, CreateUpdateMixIn):
     entity_model = models.ForeignKey('django_ledger.EntityModel',
                                      on_delete=models.CASCADE,
                                      verbose_name=_('Entity Model'))
+
     account_model = models.ForeignKey('django_ledger.AccountModel',
                                       on_delete=models.RESTRICT,
                                       help_text=_(
-                                          'Account model be used to map transactions from financial institution'),
+                                          'Account model be used to map transactions from financial institution'
+                                      ),
                                       verbose_name=_('Associated Account Model'))
     active = models.BooleanField(default=False)
     hidden = models.BooleanField(default=False)
@@ -168,7 +170,8 @@ class Meta:
         verbose_name = _('Bank Account')
         indexes = [
             models.Index(fields=['account_type']),
-            models.Index(fields=['account_model'])
+            models.Index(fields=['account_model']),
+            models.Index(fields=['entity_model'])
         ]
         unique_together = [
             ('entity_model', 'account_number'),
@@ -178,6 +181,12 @@ class Meta:
     def __str__(self):
         return f'{self.get_account_type_display()} Bank Account: {self.name}'
 
+    def can_hide(self) -> bool:
+        return self.hidden is False
+
+    def can_unhide(self) -> bool:
+        return self.hidden is True
+
     def can_activate(self) -> bool:
         return self.active is False
 

django_ledger/models/entity.py

@@ -2048,7 +2048,7 @@ def create_bank_account(self,
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
         account_model_qs = account_model_qs.with_roles(
             roles=[
-                BankAccountModel.ACCOUNT_TYPE_ROLE_MAPPING[account_type]
+                BankAccountModel.ACCOUNT_TYPE_DEFAULT_ROLE_MAPPING[account_type]
             ]
         ).is_role_default()
 

django_ledger/models/mixins.py

@@ -23,7 +23,10 @@
 from django.utils.translation import gettext_lazy as _
 from markdown import markdown
 
-from django_ledger.io import ASSET_CA_CASH, LIABILITY_CL_ST_NOTES_PAYABLE, LIABILITY_LTL_MORTGAGE_PAYABLE
+from django_ledger.io import (
+    ASSET_CA_CASH, LIABILITY_CL_ST_NOTES_PAYABLE, LIABILITY_LTL_MORTGAGE_PAYABLE,
+    LIABILITY_CL_ACC_PAYABLE, LIABILITY_CL_OTHER, LIABILITY_LTL_NOTES_PAYABLE
+)
 from django_ledger.io.io_core import validate_io_timestamp, check_tx_balance, get_localtime, get_localdate
 from django_ledger.models.utils import lazy_loader
 
@@ -1123,25 +1126,55 @@ class FinancialAccountInfoMixin(models.Model):
 
     ACCOUNT_CHECKING = 'checking'
     ACCOUNT_SAVINGS = 'savings'
+    ACCOUNT_MONEY_MKT = 'money_market'
+    ACCOUNT_CERT_DEPOSIT = 'cert_deposit'
     ACCOUNT_CREDIT_CARD = 'credit_card'
+    ACCOUNT_ST_LOAN = 'st_loan'
+    ACCOUNT_LT_LOAN = 'lt_loan'
     ACCOUNT_MORTGAGE = 'mortgage'
+    ACCOUNT_OTHER = 'other'
 
-    ACCOUNT_TYPE_ROLE_MAPPING = {
+    ACCOUNT_TYPE_DEFAULT_ROLE_MAPPING = {
         ACCOUNT_CHECKING: ASSET_CA_CASH,
         ACCOUNT_SAVINGS: ASSET_CA_CASH,
-        ACCOUNT_CREDIT_CARD: LIABILITY_CL_ST_NOTES_PAYABLE,
-        ACCOUNT_MORTGAGE: LIABILITY_LTL_MORTGAGE_PAYABLE
+        ACCOUNT_MONEY_MKT: ASSET_CA_CASH,
+        ACCOUNT_CERT_DEPOSIT: ASSET_CA_CASH,
+        ACCOUNT_CREDIT_CARD: LIABILITY_CL_ACC_PAYABLE,
+        ACCOUNT_ST_LOAN: LIABILITY_CL_ST_NOTES_PAYABLE,
+        ACCOUNT_LT_LOAN: LIABILITY_LTL_NOTES_PAYABLE,
+        ACCOUNT_MORTGAGE: LIABILITY_LTL_MORTGAGE_PAYABLE,
+        ACCOUNT_OTHER: LIABILITY_CL_OTHER
     }
 
     ACCOUNT_TYPE_CHOICES = [
         (ACCOUNT_CHECKING, _('Checking')),
         (ACCOUNT_SAVINGS, _('Savings')),
+        (ACCOUNT_MONEY_MKT, _('Money Market')),
+        (ACCOUNT_CERT_DEPOSIT, _('Certificate of Deposit')),
         (ACCOUNT_CREDIT_CARD, _('Credit Card')),
+        (ACCOUNT_ST_LOAN, _('Short Term Loan')),
+        (ACCOUNT_LT_LOAN, _('Long Term Loan')),
         (ACCOUNT_MORTGAGE, _('Mortgage')),
+        (ACCOUNT_OTHER, _('Other')),
     ]
 
+    ACCOUNT_TYPE_OFX_MAPPING = {
+        'CHECKING': ACCOUNT_CHECKING,
+        'SAVINGS': ACCOUNT_SAVINGS,
+        'MONEYMRKT': ACCOUNT_MONEY_MKT,
+        'CREDITLINE': ACCOUNT_CREDIT_CARD,
+        'CD': ACCOUNT_CERT_DEPOSIT
+    }
+
     VALID_ACCOUNT_TYPES = tuple(atc[0] for atc in ACCOUNT_TYPE_CHOICES)
 
+    financial_institution = models.CharField(
+        max_length=100,
+        blank=True,
+        null=True,
+        verbose_name=_('Financial Institution'),
+        help_text=_('Name of the financial institution (i.e. Bank Name).')
+    )
     account_number = models.CharField(max_length=30, null=True, blank=True,
                                       validators=[
                                           int_list_validator(sep='', message=_('Only digits allowed'))
@@ -1152,14 +1185,31 @@ class FinancialAccountInfoMixin(models.Model):
                                       ], verbose_name=_('Routing Number'))
     aba_number = models.CharField(max_length=30, null=True, blank=True, verbose_name=_('ABA Number'))
     swift_number = models.CharField(max_length=30, null=True, blank=True, verbose_name=_('SWIFT Number'))
-    account_type = models.CharField(choices=ACCOUNT_TYPE_CHOICES,
-                                    max_length=20,
-                                    default=ACCOUNT_CHECKING,
-                                    verbose_name=_('Account Type'))
+    account_type = models.CharField(
+        choices=ACCOUNT_TYPE_CHOICES,
+        max_length=20,
+        default=ACCOUNT_CHECKING,
+        verbose_name=_('Account Type')
+    )
 
     class Meta:
         abstract = True
 
+    def get_account_last_digits(self, n=4) -> str:
+        if not self.account_number:
+            return 'Not Available'
+        return f'*{self.account_number[-n:]}'
+
+    def get_routing_last_digits(self, n=4) -> str:
+        if not self.routing_number:
+            return 'Not Available'
+        return f'*{self.routing_number[-n:]}'
+
+    def get_account_type_from_ofx(self, ofx_type):
+        return self.ACCOUNT_TYPE_OFX_MAPPING.get(
+            ofx_type, self.ACCOUNT_OTHER
+        )
+
 
 class TaxInfoMixIn(models.Model):
     tax_id_number = models.CharField(max_length=30,

django_ledger/views/data_import.py

@@ -32,7 +32,7 @@ def get_queryset(self):
                                                   'bank_account_model__entity_model',
                                                   'bank_account_model__account_model',
                                                   'bank_account_model__account_model__coa_model')
-        return super().get_queryset()
+        return self.queryset
 
 
 class ImportJobModelCreateView(ImportJobModelViewBaseView, FormView):

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-ledger"
-version = "0.7.7"
+version = "0.7.8"
 readme = "README.md"
 requires-python = ">=3.10"
 description = "Double entry accounting system built on the Django Web Framework."