django-ledger 0.6.4__py3-none-any.whl → 0.7.1__py3-none-any.whl

django_ledger/models/entity.py

@@ -2,16 +2,13 @@
 Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
 Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
 
-Contributions to this module:
-    * Miguel Sanda <msanda@arrobalytics.com>
-    * Pranav P Tulshyan ptulshyan77@gmail.com<>
-
 The EntityModel represents the Company, Corporation, Legal Entity, Enterprise or Person that engage and operate as a
 business. EntityModels can be created as part of a parent/child model structure to accommodate complex corporate
 structures where certain entities may be owned by other entities and may also generate consolidated financial statements.
+
 Another use case of parent/child model structures is the coordination and authorization of inter-company transactions
-across multiple related entities. The EntityModel encapsulates all LedgerModel, JournalEntryModel and TransactionModel which is the core structure of
-Django Ledger in order to track and produce all financials.
+across multiple related entities. The EntityModel encapsulates all LedgerModel, JournalEntryModel and TransactionModel
+which is the core structure of Django Ledger in order to track and produce all financials.
 
 The EntityModel must be assigned an Administrator at creation, and may have optional Managers that will have the ability
 to operate on such EntityModel.
@@ -36,7 +33,7 @@ from django.core.cache import caches
 from django.core.exceptions import ValidationError, ObjectDoesNotExist
 from django.core.validators import MinValueValidator
 from django.db import models
-from django.db.models import Q
+from django.db.models import Q, F, Model
 from django.db.models.signals import pre_save
 from django.urls import reverse
 from django.utils.text import slugify
@@ -47,7 +44,7 @@ from django_ledger.io import roles as roles_module, validate_roles, IODigestCont
 from django_ledger.io.io_core import IOMixIn, get_localtime, get_localdate
 from django_ledger.models.accounts import AccountModel, AccountModelQuerySet, DEBIT, CREDIT
 from django_ledger.models.bank_account import BankAccountModelQuerySet, BankAccountModel
-from django_ledger.models.coa import ChartOfAccountModel, ChartOfAccountModelQuerySet
+from django_ledger.models.chart_of_accounts import ChartOfAccountModel, ChartOfAccountModelQuerySet
 from django_ledger.models.coa_default import CHART_OF_ACCOUNTS_ROOT_MAP
 from django_ledger.models.customer import CustomerModelQueryset, CustomerModel
 from django_ledger.models.items import (ItemModelQuerySet, ItemTransactionModelQuerySet,
@@ -113,8 +110,14 @@ class EntityModelManager(MP_NodeManager):
 
     def get_queryset(self):
         """Sets the custom queryset as the default."""
-        qs = EntityModelQuerySet(self.model, using=self._db).order_by('path')
-        return qs.order_by('path').select_related('admin', 'default_coa')
+        qs = EntityModelQuerySet(
+            self.model,
+            using=self._db).order_by('path')
+        return qs.order_by('path').select_related(
+            'admin',
+            'default_coa').annotate(
+            _default_coa_slug=F('default_coa__slug'),
+        )
 
     def for_user(self, user_model, authorized_superuser: bool = False):
         """
@@ -421,6 +424,9 @@ class EntityModelFiscalPeriodMixIn:
 
 
 class EntityModelClosingEntryMixIn:
+    """
+    Closing Entries provide
+    """
 
     def validate_closing_entry_model(self, closing_entry_model, closing_date: Optional[date] = None):
         if isinstance(self, EntityModel):
@@ -519,7 +525,6 @@ class EntityModelClosingEntryMixIn:
         return self.get_closing_entry_queryset_for_date(closing_date=closing_date)
 
     # ----> Create Closing Entries <----
-
     def create_closing_entry_for_date(self,
                                       closing_date: date,
                                       closing_entry_model=None,
@@ -578,7 +583,6 @@ class EntityModelClosingEntryMixIn:
         return f'closing_entry_{end_dt_str}_{self.uuid}'
 
     # ----> Closing Entry Caching Month < -----
-
     def get_closing_entry_cache_for_date(self,
                                          closing_date: date,
                                          cache_name: str = 'default',
@@ -801,6 +805,13 @@ class EntityModelAbstract(MP_Node,
         super().__init__(*args, **kwargs)
         self._CLOSING_ENTRY_DATES: Optional[List[date]] = None
 
+    @property
+    def default_coa_slug(self):
+        try:
+            return getattr(self, '_default_coa_slug')
+        except AttributeError:
+            return self.default_coa.slug
+
     # ## Logging ###
     def get_logger_name(self):
         return f'EntityModel {self.uuid}'
@@ -1272,7 +1283,10 @@ class EntityModelAbstract(MP_Node,
     def get_coa_accounts(self,
                          coa_model: Optional[Union[ChartOfAccountModel, UUID, str]] = None,
                          active: bool = True,
-                         order_by: Optional[Tuple] = ('code',)) -> AccountModelQuerySet:
+                         locked: bool = False,
+                         order_by: Optional[Tuple] = ('code',),
+                         return_coa_model: bool = False,
+                         ) -> Union[AccountModelQuerySet, Tuple[ChartOfAccountModel, AccountModelQuerySet]]:
         """
         Fetches the AccountModelQuerySet for a specific ChartOfAccountModel.
 
@@ -1282,6 +1296,8 @@ class EntityModelAbstract(MP_Node,
             The ChartOfAccountsModel UUID, model instance or slug to pull accounts from. If None, will use default CoA.
         active: bool
             Selects only active accounts.
+        locked: bool
+            Selects only locked accounts.
         order_by: list of strings.
             Optional list of fields passed to the order_by QuerySet method.
 
@@ -1294,9 +1310,9 @@ class EntityModelAbstract(MP_Node,
         if not coa_model:
             coa_model = self.default_coa
         elif isinstance(coa_model, UUID):
-            coa_model = self.chartofaccountmodel_set.get(uuid__exact=coa_model)
+            coa_model = self.chartofaccountmodel_set.select_related('entity').get(uuid__exact=coa_model)
         elif isinstance(coa_model, str):
-            coa_model = self.chartofaccountmodel_set.get(slug__exact=coa_model)
+            coa_model = self.chartofaccountmodel_set.select_related('entity').get(slug__exact=coa_model)
         elif isinstance(coa_model, ChartOfAccountModel):
             self.validate_chart_of_accounts_for_entity(coa_model=coa_model)
         else:
@@ -1309,9 +1325,14 @@ class EntityModelAbstract(MP_Node,
         if active:
             account_model_qs = account_model_qs.active()
 
+        if locked:
+            account_model_qs = account_model_qs.locked()
+
         if order_by:
             account_model_qs = account_model_qs.order_by(*order_by)
 
+        if return_coa_model:
+            return coa_model, account_model_qs
         return account_model_qs
 
     def get_default_coa_accounts(self,
@@ -1694,11 +1715,12 @@ class EntityModelAbstract(MP_Node,
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
 
-        account_model_qs = account_model_qs.with_roles(roles=[
-            roles_module.ASSET_CA_CASH,
-            roles_module.ASSET_CA_PREPAID,
-            roles_module.LIABILITY_CL_ACC_PAYABLE
-        ]).is_role_default()
+        account_model_qs = account_model_qs.with_roles(
+            roles=[
+                roles_module.ASSET_CA_CASH,
+                roles_module.ASSET_CA_PREPAID,
+                roles_module.LIABILITY_CL_ACC_PAYABLE
+            ]).is_role_default()
 
         # evaluates the queryset...
         len(account_model_qs)
@@ -1803,11 +1825,12 @@ class EntityModelAbstract(MP_Node,
             raise EntityModelValidationError('CustomerModel must be an instance of CustomerModel, UUID or str.')
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
-        account_model_qs = account_model_qs.with_roles(roles=[
-            roles_module.ASSET_CA_CASH,
-            roles_module.ASSET_CA_RECEIVABLES,
-            roles_module.LIABILITY_CL_DEFERRED_REVENUE
-        ]).is_role_default()
+        account_model_qs = account_model_qs.with_roles(
+            roles=[
+                roles_module.ASSET_CA_CASH,
+                roles_module.ASSET_CA_RECEIVABLES,
+                roles_module.LIABILITY_CL_DEFERRED_REVENUE
+            ]).is_role_default()
 
         # evaluates the queryset...
         len(account_model_qs)
@@ -1998,7 +2021,9 @@ class EntityModelAbstract(MP_Node,
             raise EntityModelValidationError(
                 _(f'Invalid Account Type: choices are {BankAccountModel.VALID_ACCOUNT_TYPES}'))
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
-        account_model_qs = account_model_qs.with_roles(roles=roles_module.ASSET_CA_CASH).is_role_default()
+        account_model_qs = account_model_qs.with_roles(
+            roles=roles_module.ASSET_CA_CASH
+        ).is_role_default()
         bank_account_model = BankAccountModel(
             name=name,
             entity_model=self,
@@ -2154,11 +2179,12 @@ class EntityModelAbstract(MP_Node,
                 raise EntityModelValidationError(f'Invalid UnitOfMeasureModel for entity {self.slug}...')
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
-        account_model_qs = account_model_qs.with_roles(roles=[
-            roles_module.ASSET_CA_INVENTORY,
-            roles_module.COGS,
-            roles_module.INCOME_OPERATIONAL
-        ]).is_role_default()
+        account_model_qs = account_model_qs.with_roles(
+            roles=[
+                roles_module.ASSET_CA_INVENTORY,
+                roles_module.COGS,
+                roles_module.INCOME_OPERATIONAL
+            ]).is_role_default()
 
         # evaluates the queryset...
         len(account_model_qs)
@@ -2229,10 +2255,11 @@ class EntityModelAbstract(MP_Node,
                 raise EntityModelValidationError(f'Invalid UnitOfMeasureModel for entity {self.slug}...')
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
-        account_model_qs = account_model_qs.with_roles(roles=[
-            roles_module.COGS,
-            roles_module.INCOME_OPERATIONAL
-        ]).is_role_default()
+        account_model_qs = account_model_qs.with_roles(
+            roles=[
+                roles_module.COGS,
+                roles_module.INCOME_OPERATIONAL
+            ]).is_role_default()
 
         # evaluates the queryset...
         len(account_model_qs)
@@ -2308,7 +2335,9 @@ class EntityModelAbstract(MP_Node,
                 raise EntityModelValidationError(f'Invalid UnitOfMeasureModel for entity {self.slug}...')
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
-        account_model_qs = account_model_qs.with_roles(roles=roles_module.EXPENSE_OPERATIONAL)
+        account_model_qs = account_model_qs.with_roles(
+            roles=roles_module.EXPENSE_OPERATIONAL
+        )
         if not expense_account:
             expense_account = account_model_qs.is_role_default().get()
         elif isinstance(expense_account, UUID):
@@ -2407,7 +2436,9 @@ class EntityModelAbstract(MP_Node,
                 raise EntityModelValidationError(f'Invalid UnitOfMeasureModel for entity {self.slug}...')
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model, active=True)
-        account_model_qs = account_model_qs.with_roles(roles=roles_module.ASSET_CA_INVENTORY)
+        account_model_qs = account_model_qs.with_roles(
+            roles=roles_module.ASSET_CA_INVENTORY
+        )
         if not inventory_account:
             inventory_account = account_model_qs.is_role_default().get()
         elif isinstance(inventory_account, UUID):
@@ -2627,7 +2658,9 @@ class EntityModelAbstract(MP_Node,
             ROLES_NEEDED.append(roles_module.EQUITY_CAPITAL)
 
         account_model_qs = self.get_coa_accounts(coa_model=coa_model)
-        account_model_qs = account_model_qs.with_roles(roles=ROLES_NEEDED).is_role_default()
+        account_model_qs = account_model_qs.with_roles(
+            roles=ROLES_NEEDED
+        ).is_role_default()
 
         if not cash_account or not capital_account:
             if cash_account or capital_account:
@@ -3005,6 +3038,22 @@ class EntityModelAbstract(MP_Node,
             }
         )
 
+    def get_coa_list_inactive_url(self) -> str:
+        return reverse(
+            viewname='django_ledger:coa-list-inactive',
+            kwargs={
+                'entity_slug': self.slug
+            }
+        )
+
+    def get_coa_create_url(self) -> str:
+        return reverse(
+            viewname='django_ledger:coa-create',
+            kwargs={
+                'entity_slug': self.slug
+            }
+        )
+
     def get_accounts_url(self) -> str:
         """
         The EntityModel Code of Accounts llist import URL.
@@ -3071,10 +3120,14 @@ class EntityModel(EntityModelAbstract):
     """
     Entity Model Base Class From Abstract
     """
+    class Meta(EntityModelAbstract.Meta):
+        swappable = 'DJANGO_LEDGER_ENTITY_MODEL'
+        abstract = False
+
 
 
 # ## ENTITY STATE....
-class EntityStateModelAbstract(models.Model):
+class EntityStateModelAbstract(Model):
     KEY_JOURNAL_ENTRY = 'je'
     KEY_PURCHASE_ORDER = 'po'
     KEY_BILL = 'bill'
@@ -3135,6 +3188,10 @@ class EntityStateModel(EntityStateModelAbstract):
     Entity State Model Base Class from Abstract.
     """
 
+    class Meta(EntityStateModelAbstract.Meta):
+        swappable = 'DJANGO_LEDGER_ENTITY_STATE_MODEL'
+        abstract = False
+
 
 # ## ENTITY MANAGEMENT.....
 class EntityManagementModelAbstract(CreateUpdateMixIn):

django_ledger/models/estimate.py

@@ -2,9 +2,6 @@
 Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
 Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
 
-Contributions to this module:
-    * Miguel Sanda <msanda@arrobalytics.com>
-
 The EstimateModel provides the means to estimate customer requests, jobs or quotes that may ultimately be considered
 contracts, if approved. The EstimateModels will estimate revenues and costs associated with a specific scope of work
 which is documented using ItemTransactionModels.
@@ -140,12 +137,6 @@ class EstimateModelManager(models.Manager):
         user_model
             Logged in and authenticated django UserModel instance.
 
-        Examples
-        --------
-            >>> request_user = request.user
-            >>> slug = kwargs['entity_slug'] # may come from request kwargs
-            >>> bill_model_qs = EstimateModel.objects.for_entity(user_model=request_user, entity_slug=slug)
-
         Returns
         -------
         EstimateModelQuerySet
@@ -1240,7 +1231,8 @@ class EstimateModelAbstract(CreateUpdateMixIn,
                 'updated'
             ])
 
-    def update_state(self, itemtxs_qs: Optional[Union[ItemTransactionModelQuerySet, List[ItemTransactionModel]]] = None):
+    def update_state(self,
+                     itemtxs_qs: Optional[Union[ItemTransactionModelQuerySet, List[ItemTransactionModel]]] = None):
         itemtxs_qs, _ = self.get_itemtxs_data(queryset=itemtxs_qs)
         self.update_cost_estimate(itemtxs_qs)
         self.update_revenue_estimate(itemtxs_qs)
@@ -1620,3 +1612,7 @@ class EstimateModel(EstimateModelAbstract):
     """
     Base EstimateModel Class.
     """
+
+    class Meta(EstimateModelAbstract.Meta):
+        swappable = 'DJANGO_LEDGER_ESTIMATE_MODEL'
+        abstract = False

django_ledger/models/invoice.py

@@ -2,9 +2,6 @@
 Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
 Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
 
-Contributions to this module:
-    * Miguel Sanda <msanda@arrobalytics.com>
-
 This module implements the InvoiceModel, which represents the Sales Invoice/ Sales Invoice/ Tax Invoice/ Proof of Sale
 which the :func:`EntityModel <django_ledger.models.entity.EntityModel>` issues to its customers for the supply of
 goods or services. The model manages all the Sales Invoices which are issued by the :func:`EntityModel
@@ -36,14 +33,16 @@ from django.utils.translation import gettext_lazy as _
 
 from django_ledger.io import ASSET_CA_CASH, ASSET_CA_RECEIVABLES, LIABILITY_CL_DEFERRED_REVENUE
 from django_ledger.io.io_core import get_localtime, get_localdate
-from django_ledger.models import lazy_loader, ItemTransactionModelQuerySet, ItemModelQuerySet, ItemModel
+from django_ledger.models import (
+    lazy_loader, ItemTransactionModelQuerySet,
+    ItemModelQuerySet, ItemModel, QuerySet, Manager
+)
 from django_ledger.models.entity import EntityModel
 from django_ledger.models.mixins import (
     CreateUpdateMixIn, AccrualMixIn,
     MarkdownNotesMixIn, PaymentTermsMixIn,
     ItemizeMixIn
 )
-
 from django_ledger.models.signals import (
     invoice_status_draft,
     invoice_status_in_review,
@@ -52,7 +51,6 @@ from django_ledger.models.signals import (
     invoice_status_canceled,
     invoice_status_void
 )
-
 from django_ledger.settings import DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING, DJANGO_LEDGER_INVOICE_NUMBER_PREFIX
 
 UserModel = get_user_model()
@@ -62,7 +60,7 @@ class InvoiceModelValidationError(ValidationError):
     pass
 
 
-class InvoiceModelQuerySet(models.QuerySet):
+class InvoiceModelQuerySet(QuerySet):
     """
    A custom defined QuerySet for the InvoiceModel.
    This implements multiple methods or queries that we need to run to get a status of Invoices raised by the entity.
@@ -179,7 +177,7 @@ class InvoiceModelQuerySet(models.QuerySet):
         return self.filter(invoice_status__exact=InvoiceModel.INVOICE_STATUS_APPROVED)
 
 
-class InvoiceModelManager(models.Manager):
+class InvoiceModelManager(Manager):
     """
     A custom defined InvoiceModel Manager that will act as an interface to handling the DB queries to the InvoiceModel.
     The default "get_queryset" has been overridden to refer the custom defined "InvoiceModelQuerySet"
@@ -575,9 +573,10 @@ class InvoiceModelAbstract(
         else:
             self.validate_itemtxs_qs(queryset)
 
-        return queryset.select_related('item_model').order_by('item_model__earnings_account__uuid',
-                                                              'entity_unit__uuid',
-                                                              'item_model__earnings_account__balance_type').values(
+        return queryset.select_related('item_model').order_by(
+            'item_model__earnings_account__uuid',
+            'entity_unit__uuid',
+            'item_model__earnings_account__balance_type').values(
             'item_model__earnings_account__uuid',
             'item_model__earnings_account__balance_type',
             'item_model__cogs_account__uuid',
@@ -1820,6 +1819,10 @@ class InvoiceModel(InvoiceModelAbstract):
     Base Invoice Model from Abstract.
     """
 
+    class Meta:
+        swappable = 'DJANGO_LEDGER_INVOICE_MODEL'
+        abstract = False
+
 
 def invoicemodel_presave(instance: InvoiceModel, **kwargs):
     if instance.can_generate_invoice_number():

django_ledger/models/items.py

@@ -2,10 +2,6 @@
 Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
 Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
 
-Contributions to this module:
-    * Miguel Sanda <msanda@arrobalytics.com>
-    * Pranav P Tulshyan <ptulshyan77@gmail.com>
-
 The Items refer to the additional detail provided to Bills, Invoices, Purchase Orders and Estimates for the purposes of
 documenting a breakdown of materials, labor, equipment, and other resources used for the purposes of the business
 operations.
@@ -29,7 +25,7 @@ from uuid import uuid4, UUID
 from django.core.exceptions import ValidationError, ObjectDoesNotExist
 from django.core.validators import MinValueValidator
 from django.db import models, transaction, IntegrityError
-from django.db.models import Q, Sum, F, ExpressionWrapper, DecimalField, Value, Case, When, QuerySet
+from django.db.models import Q, Sum, F, ExpressionWrapper, DecimalField, Value, Case, When, QuerySet, Manager
 from django.db.models.functions import Coalesce
 from django.utils.translation import gettext_lazy as _
 
@@ -46,12 +42,12 @@ class ItemModelValidationError(ValidationError):
     pass
 
 
-class UnitOfMeasureModelQuerySet(models.QuerySet):
+class UnitOfMeasureModelQuerySet(QuerySet):
     pass
 
 
 # UNIT OF MEASURES MODEL....
-class UnitOfMeasureModelManager(models.Manager):
+class UnitOfMeasureModelManager(Manager):
     """
     A custom defined QuerySet Manager for the UnitOfMeasureModel.
     """
@@ -153,7 +149,7 @@ class UnitOfMeasureModelAbstract(CreateUpdateMixIn):
 
 
 # ITEM MODEL....
-class ItemModelQuerySet(models.QuerySet):
+class ItemModelQuerySet(QuerySet):
     """
     A custom-defined ItemModelQuerySet that implements custom QuerySet methods related to the ItemModel.
     """
@@ -291,7 +287,7 @@ class ItemModelQuerySet(models.QuerySet):
         return self.inventory_all()
 
 
-class ItemModelManager(models.Manager):
+class ItemModelManager(Manager):
     """
     A custom defined ItemModelManager that implement custom QuerySet methods related to the ItemModel
     """
@@ -389,7 +385,10 @@ class ItemModelManager(models.Manager):
         ItemModelQuerySet
             A Filtered ItemModelQuerySet.
         """
-        qs = self.for_entity_active(entity_slug=entity_slug, user_model=user_model)
+        qs = self.for_entity_active(
+            entity_slug=entity_slug,
+            user_model=user_model
+        )
         return qs.filter(
             (
                     Q(is_product_or_service=False) &
@@ -527,7 +526,6 @@ class ItemModelAbstract(CreateUpdateMixIn):
     uuid = models.UUIDField(default=uuid4, editable=False, primary_key=True)
     name = models.CharField(max_length=100, verbose_name=_('Item Name'))
 
-    # todo: rename this and remove 'id' from it.
     item_id = models.CharField(max_length=50, blank=True, null=True, verbose_name=_('Internal ID'))
     item_number = models.CharField(max_length=30, editable=False, verbose_name=_('Item Number'))
     item_role = models.CharField(max_length=10, choices=ITEM_ROLE_CHOICES, null=True, blank=True)
@@ -851,7 +849,7 @@ class ItemModelAbstract(CreateUpdateMixIn):
 
 
 # ITEM TRANSACTION MODELS...
-class ItemTransactionModelQuerySet(models.QuerySet):
+class ItemTransactionModelQuerySet(QuerySet):
 
     def is_received(self):
         return self.filter(po_item_status=ItemTransactionModel.STATUS_RECEIVED)
@@ -877,7 +875,7 @@ class ItemTransactionModelQuerySet(models.QuerySet):
         }
 
 
-class ItemTransactionModelManager(models.Manager):
+class ItemTransactionModelManager(Manager):
 
     def for_user(self, user_model):
         qs = self.get_queryset()
@@ -1406,20 +1404,31 @@ class ItemTransactionModelAbstract(CreateUpdateMixIn):
 
 
 # FINAL MODEL CLASSES....
-
 class UnitOfMeasureModel(UnitOfMeasureModelAbstract):
     """
     Base UnitOfMeasureModel from Abstract.
     """
 
+    class Meta(UnitOfMeasureModelAbstract.Meta):
+        abstract = False
+        swappable = 'DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL'
+
 
 class ItemTransactionModel(ItemTransactionModelAbstract):
     """
     Base ItemTransactionModel from Abstract.
     """
 
+    class Meta(ItemTransactionModelAbstract.Meta):
+        abstract = False
+        swappable = 'DJANGO_LEDGER_ITEM_TRANSACTION_MODEL'
+
 
 class ItemModel(ItemModelAbstract):
     """
     Base ItemModel from Abstract.
     """
+
+    class Meta(ItemModelAbstract.Meta):
+        abstract = False
+        swappable = 'DJANGO_LEDGER_ITEM_MODEL'