django-ledger 0.7.4__py3-none-any.whl → 0.7.5.1__py3-none-any.whl

django_ledger/io/io_generator.py

@@ -282,11 +282,13 @@ class EntityDataGenerator(LoggingMixIn):
     def create_bank_accounts(self):
         self.logger.info(f'Creating entity accounts...')
         bank_account_models = [
+
+            # creates a bank cash checking account...
             self.entity_model.create_bank_account(
                 name=f'{self.entity_model.name} Checking Account',
                 account_type=BankAccountModel.ACCOUNT_CHECKING,
                 active=True,
-                cash_account=choice(self.accounts_by_role[ASSET_CA_CASH]),
+                account_model=choice(self.accounts_by_role[ASSET_CA_CASH]),
                 bank_account_model_kwargs={
                     'aba_number': self.fk.swift(),
                     'routing_number': str(randint(0, 9999999)).zfill(9),
@@ -294,11 +296,13 @@ class EntityDataGenerator(LoggingMixIn):
                 },
                 commit=False
             ),
+
+            # creates a bank cash savings account...
             self.entity_model.create_bank_account(
                 name=f'{self.entity_model.name} Savings Account',
                 account_type=BankAccountModel.ACCOUNT_SAVINGS,
                 active=True,
-                cash_account=choice(self.accounts_by_role[ASSET_CA_CASH]),
+                account_model=choice(self.accounts_by_role[ASSET_CA_CASH]),
                 bank_account_model_kwargs={
                     'aba_number': self.fk.swift(),
                     'routing_number': str(randint(0, 9999999)).zfill(9),
@@ -777,7 +781,7 @@ class EntityDataGenerator(LoggingMixIn):
 
         self.logger.info(f'Funding entity...')
         capital_acc = choice(self.accounts_by_role[EQUITY_CAPITAL])
-        cash_acc = choice(self.bank_account_models).cash_account
+        cash_acc = choice(self.bank_account_models).account_model
 
         self.entity_model.deposit_capital(
             cash_account=cash_acc,

django_ledger/io/ofx.py

@@ -6,13 +6,18 @@ Contributions to this module:
 Miguel Sanda <msanda@arrobalytics.com>
 """
 
-from typing import List
+from typing import List, Optional, Dict
 
+from django.core.exceptions import ValidationError
 from ofxtools import OFXTree
 from ofxtools.models.bank import STMTRS
 from ofxtools.models.ofx import OFX
 
 
+class OFXImportValidationError(ValidationError):
+    pass
+
+
 class OFXFileManager:
 
     def __init__(self, ofx_file_or_path, parse_on_load: bool = True):
@@ -20,31 +25,47 @@ class OFXFileManager:
         self.ofx_tree: OFXTree = OFXTree()
         self.ofx_data: OFX or None = None
         self.statements: List[STMTRS] or None = None
-        self.NUMBER_OF_STATEMENTS: int or None = None
+        self.NUMBER_OF_STATEMENTS: int = 0
 
         if parse_on_load:
             self.parse_ofx()
 
+        if self.NUMBER_OF_STATEMENTS != 1:
+            raise OFXImportValidationError('Only one account per OFX file is supported.')
+
+        self.BANK_NAME = self.ofx_data.fi.org if hasattr(self.ofx_data.fi, 'org') else None
+        self.FID = self.ofx_data.fi.fid if hasattr(self.ofx_data.fi, 'fid') else None
+        self.ACCOUNT_DATA: Optional[Dict] = None
+
+        self.get_account_data()
+        # self.ACCOUNT_TXS = self.get_account_txs(account=self.ACCOUNTS[0]['account'].acctid)
+
     def parse_ofx(self):
         self.ofx_tree.parse(self.FILE)
         self.ofx_data = self.ofx_tree.convert()
         self.statements = self.ofx_data.statements
         self.NUMBER_OF_STATEMENTS = len(self.statements)
 
-    def get_accounts(self):
-        return [
-            {
-                # conditionally return the bank and fid if they are provided by the vendor
-                'bank': self.ofx_data.fi.org if hasattr(self.ofx_data.fi, 'org') else None,
-                'fid': self.ofx_data.fi.fid if hasattr(self.ofx_data.fi, 'fid') else None,
-                'account_type': acc.accttype,
-                'account_number': acc.acctid,
-                'routing_number': acc.bankid,
-            } for acc in self.statements
-        ]
-
-    def get_account_txs(self, account: str):
+    def statement_attrs(self):
+        return [a for a in dir(self.statements[0]) if a[0] != '_']
+
+    def get_account_data(self):
+        if self.ACCOUNT_DATA is None:
+            self.ACCOUNT_DATA = [
+                dict(
+                    (attr, getattr(account, attr)) for attr in self.statement_attrs()
+                ) | {
+                    'bank': self.BANK_NAME,
+                    'fid': self.FID
+                } for account in self.statements
+            ][0]
+        return self.ACCOUNT_DATA
+
+    def get_account_number(self):
+        return self.get_account_data()['account'].acctid
+
+    def get_account_txs(self):
         acc_statement = next(iter(
-            st for st in self.ofx_data.statements if st.account.acctid == account
+            st for st in self.ofx_data.statements if st.account.acctid == self.get_account_number()
         ))
         return acc_statement.banktranlist

django_ledger/migrations/0020_remove_bankaccountmodel_django_ledg_cash_ac_59a8af_idx_and_more.py

@@ -0,0 +1,44 @@
+# Generated by Django 5.1.6 on 2025-02-13 01:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('django_ledger', '0019_alter_transactionmodel_amount_and_more'),
+    ]
+
+    operations = [
+        migrations.RemoveIndex(
+            model_name='bankaccountmodel',
+            name='django_ledg_cash_ac_59a8af_idx',
+        ),
+        migrations.RenameField(
+            model_name='bankaccountmodel',
+            old_name='cash_account',
+            new_name='account_model',
+        ),
+        migrations.AlterUniqueTogether(
+            name='bankaccountmodel',
+            unique_together={('entity_model', 'account_model', 'account_number', 'routing_number'),
+                             ('entity_model', 'account_number')},
+        ),
+        migrations.AlterField(
+            model_name='bankaccountmodel',
+            name='account_type',
+            field=models.CharField(
+                choices=[('checking', 'Checking'), ('savings', 'Savings'), ('credit_card', 'Credit Card'),
+                         ('mortgage', 'Mortgage')], default='checking', max_length=20, verbose_name='Account Type'),
+        ),
+        migrations.AlterField(
+            model_name='vendormodel',
+            name='account_type',
+            field=models.CharField(
+                choices=[('checking', 'Checking'), ('savings', 'Savings'), ('credit_card', 'Credit Card'),
+                         ('mortgage', 'Mortgage')], default='checking', max_length=20, verbose_name='Account Type'),
+        ),
+        migrations.AddIndex(
+            model_name='bankaccountmodel',
+            index=models.Index(fields=['account_model'], name='django_ledg_account_ed900d_idx'),
+        ),
+    ]

django_ledger/migrations/0021_alter_bankaccountmodel_account_model_and_more.py

@@ -0,0 +1,33 @@
+# Generated by Django 5.1.6 on 2025-02-18 22:47
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('django_ledger', '0020_remove_bankaccountmodel_django_ledg_cash_ac_59a8af_idx_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='bankaccountmodel',
+            name='account_model',
+            field=models.ForeignKey(
+                help_text='Account model be used to map transactions from financial institution',
+                on_delete=django.db.models.deletion.RESTRICT,
+                to=settings.DJANGO_LEDGER_ACCOUNT_MODEL,
+                verbose_name='Associated Account Model'
+            ),
+        ),
+        migrations.AlterField(
+            model_name='importjobmodel',
+            name='bank_account_model',
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
+                to=settings.DJANGO_LEDGER_BANK_ACCOUNT_MODEL,
+                verbose_name='Associated Bank Account Model'
+            ),
+        ),
+    ]

django_ledger/models/bank_account.py

@@ -16,7 +16,7 @@ from django.db.models import Q, QuerySet
 from django.shortcuts import get_object_or_404
 from django.utils.translation import gettext_lazy as _
 
-from django_ledger.models import CreateUpdateMixIn, BankAccountInfoMixIn
+from django_ledger.models import CreateUpdateMixIn, FinancialAccountInfoMixin
 from django_ledger.models.utils import lazy_loader
 
 UserModel = get_user_model()
@@ -60,6 +60,9 @@ class BankAccountModelManager(models.Manager):
     Custom defined Model Manager for the BankAccountModel.
     """
 
+    def get_queryset(self) -> BankAccountModelQuerySet:
+        return BankAccountModelQuerySet(self.model, using=self._db)
+
     def for_user(self, user_model):
         qs = self.get_queryset()
         if user_model.is_superuser:
@@ -91,7 +94,7 @@ class BankAccountModelManager(models.Manager):
         )
 
 
-class BankAccountModelAbstract(BankAccountInfoMixIn, CreateUpdateMixIn):
+class BankAccountModelAbstract(FinancialAccountInfoMixin, CreateUpdateMixIn):
     """
     This is the main abstract class which the BankAccountModel database will inherit from.
     The BankAccountModel inherits functionality from the following MixIns:
@@ -108,14 +111,13 @@ class BankAccountModelAbstract(BankAccountInfoMixIn, CreateUpdateMixIn):
         A user defined name for the bank account as a String.
     entity_model: EntityModel
         The EntityModel associated with the BankAccountModel instance.
-    cash_account: AccountModel
+    account_model: AccountModel
         The AccountModel associated with the BankAccountModel instance. Must be an account with role ASSET_CA_CASH.
     active: bool
         Determines whether the BackAccountModel instance bank account is active. Defaults to True.
     hidden: bool
         Determines whether the BackAccountModel instance bank account is hidden. Defaults to False.
     """
-    REL_NAME_PREFIX = 'bank'
 
     uuid = models.UUIDField(default=uuid4, editable=False, primary_key=True)
 
@@ -124,13 +126,14 @@ class BankAccountModelAbstract(BankAccountInfoMixIn, CreateUpdateMixIn):
     entity_model = models.ForeignKey('django_ledger.EntityModel',
                                      on_delete=models.CASCADE,
                                      verbose_name=_('Entity Model'))
-    cash_account = models.ForeignKey('django_ledger.AccountModel',
-                                     on_delete=models.RESTRICT,
-                                     verbose_name=_('Cash Account'),
-                                     related_name=f'{REL_NAME_PREFIX}_cash_account')
+    account_model = models.ForeignKey('django_ledger.AccountModel',
+                                      on_delete=models.RESTRICT,
+                                      help_text=_(
+                                          '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)
-    objects = BankAccountModelManager.from_queryset(queryset_class=BankAccountModelQuerySet)()
+    objects = BankAccountModelManager()
 
     def configure(self,
                   entity_slug,
@@ -165,11 +168,11 @@ class BankAccountModelAbstract(BankAccountInfoMixIn, CreateUpdateMixIn):
         verbose_name = _('Bank Account')
         indexes = [
             models.Index(fields=['account_type']),
-            models.Index(fields=['cash_account'])
+            models.Index(fields=['account_model'])
         ]
         unique_together = [
             ('entity_model', 'account_number'),
-            ('entity_model', 'cash_account', 'account_number', 'routing_number')
+            ('entity_model', 'account_model', 'account_number', 'routing_number')
         ]
 
     def __str__(self):

django_ledger/models/customer.py

@@ -96,18 +96,13 @@ class CustomerModelManager(Manager):
         __________
         user_model
             Logged in and authenticated django UserModel instance.
-
-        Examples
-        ________
-            >>> request_user = request.user
-            >>> customer_model_qs = CustomerModel.objects.for_user(user_model=request_user)
         """
         qs = self.get_queryset()
         if user_model.is_superuser:
             return qs
         return qs.filter(
-            Q(entity__admin=user_model) |
-            Q(entity__managers__in=[user_model])
+            Q(entity_model__admin=user_model) |
+            Q(entity_model__managers__in=[user_model])
         )
 
     def for_entity(self, entity_slug, user_model) -> CustomerModelQueryset:
@@ -122,11 +117,6 @@ class CustomerModelManager(Manager):
         user_model
             Logged in and authenticated django UserModel instance.
 
-        Examples
-        ________
-            >>> request_user = request.user
-            >>> slug = kwargs['entity_slug'] # may come from request kwargs
-            >>> customer_model_qs = CustomerModel.objects.for_entity(user_model=request_user, entity_slug=slug)
 
         Returns
         -------
@@ -157,7 +147,7 @@ class CustomerModelAbstract(ContactInfoMixIn, TaxCollectionMixIn, CreateUpdateMi
     uuid : UUID
         This is a unique primary key generated for the table. The default value of this field is uuid4().
 
-    entity: EntityModel
+    entity_model: EntityModel
         The EntityModel associated with this Customer.
 
     customer_name: str