django-ledger 0.5.5.4__py3-none-any.whl → 0.5.6.0__py3-none-any.whl

django_ledger/migrations/0014_ledgermodel_ledger_xid_and_more.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.6 on 2024-01-15 13:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_ledger', '0013_stagedtransactionmodel_bundle_split'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='ledgermodel',
+            name='ledger_xid',
+            field=models.SlugField(allow_unicode=True, blank=True, help_text='User Defined Ledger ID', max_length=150, null=True, verbose_name='Ledger Slug'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='ledgermodel',
+            unique_together={('entity', 'ledger_xid')},
+        ),
+    ]

django_ledger/models/accounts.py

@@ -34,6 +34,8 @@ from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models import Q
 from django.db.models.signals import pre_save
+from django.urls import reverse
+from django.utils.timezone import localdate
 from django.utils.translation import gettext_lazy as _
 from treebeard.mp_tree import MP_Node, MP_NodeManager, MP_NodeQuerySet
 
@@ -42,8 +44,8 @@ from django_ledger.io.roles import (ACCOUNT_ROLE_CHOICES, BS_ROLES, GROUP_INVOIC
                                     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)
-from django_ledger.models import lazy_loader
 from django_ledger.models.mixins import CreateUpdateMixIn
+from django_ledger.models.utils import lazy_loader
 from django_ledger.settings import DJANGO_LEDGER_ACCOUNT_CODE_GENERATE, DJANGO_LEDGER_ACCOUNT_CODE_USE_PREFIX
 
 DEBIT = 'debit'
@@ -158,6 +160,11 @@ class AccountModelManager(MP_NodeManager):
         """
         return AccountModelQuerySet(self.model).order_by('path')
 
+    def for_user(self, user_model):
+        qs = self.get_queryset()
+        if user_model.is_superuser:
+            return qs
+
     # todo: search for uses and pass EntityModel whenever possible.
     def for_entity(self,
                    user_model,
@@ -186,7 +193,7 @@ class AccountModelManager(MP_NodeManager):
         AccountModelQuerySet
             A QuerySet of all requested EntityModel Chart of Accounts.
         """
-        qs = self.get_queryset()
+        qs = self.for_user(user_model)
         if select_coa_model:
             qs = qs.select_related('coa_model')
 
@@ -201,11 +208,7 @@ class AccountModelManager(MP_NodeManager):
 
         if coa_slug:
             qs = qs.filter(coa_model__slug__exact=coa_slug)
-
-        return qs.filter(
-            Q(coa_model__entity__admin=user_model) |
-            Q(coa_model__entity__managers__in=[user_model])
-        ).order_by('coa_model')
+        return qs.order_by('coa_model')
 
     def for_entity_available(self, user_model, entity_slug, coa_slug: Optional[str] = None) -> AccountModelQuerySet:
         """
@@ -486,6 +489,54 @@ class AccountModelAbstract(MP_Node, CreateUpdateMixIn):
             x5=self.code
         )
 
+    @classmethod
+    def create_account(cls,
+                       name: str,
+                       role: bool,
+                       balance_type: str,
+                       is_role_default: bool = False,
+                       locked: bool = False,
+                       active: bool = False,
+                       **kwargs):
+        """
+        Convenience Method to Create a new Account Model. This is the preferred method to create new Accounts in order
+        to properly handle parent/child relationships between models.
+
+        Parameters
+        ----------
+        name: str
+            The name of the new Entity.
+        role: str
+            Account role.
+        balance_type: str
+            Account Balance Type. Must be 'debit' or 'credit'.
+        is_role_default: bool
+            If True, assigns account as default for role. Only once default account per role is permitted.
+        locked: bool
+            Marks account as Locked. Defaults to False.
+        active: bool
+            Marks account as Active. Defaults to True.
+
+
+        Returns
+        -------
+        AccountModel
+            The newly created AccountModel instance.
+
+        """
+        account_model = cls(
+            name=name,
+            role=role,
+            balance_type=balance_type,
+            role_default=is_role_default,
+            locked=locked,
+            active=active,
+            **kwargs
+        )
+        account_model.clean()
+        account_model = cls.add_root(instance=account_model)
+        return account_model
+
     @property
     def role_bs(self) -> str:
         """
@@ -649,6 +700,16 @@ class AccountModelAbstract(MP_Node, CreateUpdateMixIn):
         ri = randint(10000, 99999)
         return f'{prefix}{ri}'
 
+    def get_absolute_url(self):
+        return reverse(
+            viewname='django_ledger:account-detail-year',
+            kwargs={
+                'account_pk': self.uuid,
+                'entity_slug': self.coa_model.entity.slug,
+                'year': localdate().year
+            }
+        )
+
     def clean(self):
 
         if not self.code and DJANGO_LEDGER_ACCOUNT_CODE_GENERATE:

django_ledger/models/bank_account.py

@@ -64,6 +64,15 @@ class BankAccountModelManager(models.Manager):
     Custom defined Model Manager for the BankAccountModel.
     """
 
+    def for_user(self, user_model):
+        qs = self.get_queryset()
+        if user_model.is_superuser:
+            return qs
+        return qs.filter(
+            Q(entity_model__admin=user_model) |
+            Q(entity_model__managers__in=[user_model])
+        )
+
     def for_entity(self, entity_slug, user_model) -> BankAccountModelQuerySet:
         """
         Allows only the authorized user to query the BankAccountModel for a given EntityModel.
@@ -76,21 +85,13 @@ class BankAccountModelManager(models.Manager):
         user_model
             Logged in and authenticated django UserModel instance.
         """
-        qs = self.get_queryset()
+        qs = self.for_user(user_model)
         if isinstance(entity_slug, lazy_loader.get_entity_model()):
             return qs.filter(
-                Q(entity_model=entity_slug) &
-                (
-                        Q(entity_model__admin=user_model) |
-                        Q(entity_model__managers__in=[user_model])
-                )
+                Q(entity_model=entity_slug)
             )
         return qs.filter(
-            Q(entity_model__slug__exact=entity_slug) &
-            (
-                    Q(entity_model__admin=user_model) |
-                    Q(entity_model__managers__in=[user_model])
-            )
+            Q(entity_model__slug__exact=entity_slug)
         )
 
 

django_ledger/models/bill.py

@@ -205,6 +205,8 @@ class BillModelManager(models.Manager):
             Returns a BillModelQuerySet with applied filters.
         """
         qs = self.get_queryset()
+        if user_model.is_superuser:
+            return qs
         return qs.filter(
             Q(ledger__entity__admin=user_model) |
             Q(ledger__entity__managers__in=[user_model])
@@ -233,20 +235,14 @@ class BillModelManager(models.Manager):
         BillModelQuerySet
             Returns a BillModelQuerySet with applied filters.
         """
-        qs = self.get_queryset()
+        qs = self.for_user(user_model)
         if isinstance(entity_slug, EntityModel):
             return qs.filter(
-                Q(ledger__entity=entity_slug) & (
-                        Q(ledger__entity__admin=user_model) |
-                        Q(ledger__entity__managers__in=[user_model])
-                )
+                Q(ledger__entity=entity_slug)
             )
         elif isinstance(entity_slug, str):
             return qs.filter(
-                Q(ledger__entity__slug__exact=entity_slug) & (
-                        Q(ledger__entity__admin=user_model) |
-                        Q(ledger__entity__managers__in=[user_model])
-                )
+                Q(ledger__entity__slug__exact=entity_slug)
             )
 
 

django_ledger/models/closing_entry.py

@@ -35,23 +35,23 @@ class ClosingEntryModelQuerySet(models.QuerySet):
 
 class ClosingEntryModelManager(models.Manager):
 
+    def for_user(self, user_model):
+        qs = self.get_queryset()
+        if user_model.is_superuser:
+            return qs
+        return qs.filter(
+            Q(entity_model__admin=user_model) |
+            Q(entity_model__managers__in=[user_model])
+        )
+
     def for_entity(self, entity_slug, user_model):
+        qs = self.for_user(user_model)
         if isinstance(entity_slug, lazy_loader.get_entity_model()):
-            return self.get_queryset().filter(
-                Q(entity_model=entity_slug) &
-                (
-                        Q(entity_model__admin=user_model) |
-                        Q(entity_model__managers__in=[user_model])
-                )
-
-            )
-        return self.get_queryset().filter(
-            Q(entity_model__slug__exact=entity_slug) &
-            (
-                    Q(entity_model__admin=user_model) |
-                    Q(entity_model__managers__in=[user_model])
+            return qs.filter(
+                Q(entity_model=entity_slug)
             )
-
+        return qs.filter(
+            Q(entity_model__slug__exact=entity_slug)
         )
 
 

django_ledger/models/coa.py

@@ -22,6 +22,8 @@ when no explicit CoA is specified, the default behavior is to use the EntityMode
 Accounts can be used when creating Journal Entries**. No commingling between CoAs is allowed in order to preserve the
 integrity of the Journal Entry.
 """
+from random import choices
+from string import ascii_lowercase, digits
 from typing import Optional, Union
 from uuid import uuid4
 
@@ -29,6 +31,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
+from django.db.models.signals import pre_save, post_save
 from django.utils.translation import gettext_lazy as _
 
 from django_ledger.io import (ROOT_COA, ROOT_GROUP_LEVEL_2, ROOT_GROUP_META, ROOT_ASSETS,
@@ -41,6 +44,8 @@ from django_ledger.settings import logger
 
 UserModel = get_user_model()
 
+SLUG_SUFFIX = ascii_lowercase + digits
+
 
 class ChartOfAccountsModelValidationError(ValidationError):
     pass
@@ -84,7 +89,7 @@ class ChartOfAccountModelManager(models.Manager):
                     Q(entity__admin=user_model) |
                     Q(entity__managers__in=[user_model])
             )
-        )
+        ).select_related('entity')
 
     def for_entity(self, entity_slug, user_model) -> ChartOfAccountModelQuerySet:
         """
@@ -127,7 +132,7 @@ class ChartOfAccountModelManager(models.Manager):
                     Q(entity__admin=user_model) |
                     Q(entity__managers__in=[user_model])
             )
-        )
+        ).select_related('entity')
 
 
 class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
@@ -173,10 +178,9 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
         ]
 
     def __str__(self):
-        return f'{self.slug}: {self.name}'
-
-    # def is_configured(self, account_model_qs: Optional[AccountModelQuerySet]):
-    #     pass
+        if self.name is not None:
+            return f'{self.name} ({self.slug})'
+        return self.slug
 
     def get_coa_root_accounts_qs(self) -> AccountModelQuerySet:
         return self.accountmodel_set.all().is_coa_root()
@@ -222,28 +226,43 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
         root_account = self.get_coa_root_account()
         return AccountModel.dump_bulk(parent=root_account)
 
+    def generate_slug(self, raise_exception: bool = False) -> str:
+        if self.slug:
+            if raise_exception:
+                raise ChartOfAccountsModelValidationError(
+                    message=_(f'CoA {self.uuid} already has a slug')
+                )
+            return
+        self.slug = f'coa-{self.entity.slug[-5:]}-' + ''.join(choices(SLUG_SUFFIX, k=15))
+
     def configure(self, raise_exception: bool = True):
+
+        self.generate_slug()
+
         root_accounts_qs = self.get_coa_root_accounts_qs()
         existing_root_roles = list(set(acc.role for acc in root_accounts_qs))
 
         if len(existing_root_roles) > 0:
-            raise ChartOfAccountsModelValidationError(message=f'Root Nodes already Exist in CoA {self.uuid}...')
+            if raise_exception:
+                raise ChartOfAccountsModelValidationError(message=f'Root Nodes already Exist in CoA {self.uuid}...')
+            return
 
         if ROOT_COA not in existing_root_roles:
             # add coa root...
             role_meta = ROOT_GROUP_META[ROOT_COA]
             account_pk = uuid4()
-            coa_root_account_model = AccountModel.add_root(
-                instance=AccountModel(
-                    uuid=account_pk,
-                    code=role_meta['code'],
-                    name=role_meta['title'],
-                    coa_model=self,
-                    role=ROOT_COA,
-                    active=False,
-                    locked=True,
-                    balance_type=role_meta['balance_type']
-                ))
+            root_account = AccountModel(
+                uuid=account_pk,
+                code=role_meta['code'],
+                name=role_meta['title'],
+                coa_model=self,
+                role=ROOT_COA,
+                role_default=True,
+                active=False,
+                locked=True,
+                balance_type=role_meta['balance_type']
+            )
+            coa_root_account_model = AccountModel.add_root(instance=root_account)
 
             coa_root_account_model = AccountModel.objects.get(uuid__exact=account_pk)
 
@@ -258,11 +277,17 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                             name=role_meta['title'],
                             coa_model=self,
                             role=root_role,
+                            role_default=True,
                             active=False,
                             locked=True,
                             balance_type=role_meta['balance_type']
                         ))
 
+    def is_default(self) -> bool:
+        if self.entity_id is None:
+            return False
+        return self.entity.default_coa_id == self.uuid
+
     def validate_account_model_qs(self, account_model_qs: AccountModelQuerySet):
         if not isinstance(account_model_qs, AccountModelQuerySet):
             raise ChartOfAccountsModelValidationError(
@@ -301,8 +326,25 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
         non_root_accounts_qs.update(locked=False)
         return non_root_accounts_qs
 
+    def clean(self):
+        self.generate_slug()
+
 
 class ChartOfAccountModel(ChartOfAccountModelAbstract):
     """
     Base ChartOfAccounts Model
     """
+
+
+# def chartofaccountmodel_presave(instance: ChartOfAccountModel, **kwargs):
+#     if instance._state.adding:
+#         instance.configure(raise_exception=True)
+
+
+def chartofaccountmodel_postsave(instance: ChartOfAccountModel, **kwargs):
+    if instance._state.adding:
+        instance.configure(raise_exception=True)
+
+
+# pre_save.connect(receiver=chartofaccountmodel_presave, sender=ChartOfAccountModel)
+post_save.connect(receiver=chartofaccountmodel_postsave, sender=ChartOfAccountModel)

django_ledger/models/customer.py

@@ -107,6 +107,8 @@ class CustomerModelManager(models.Manager):
             >>> 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])
@@ -135,22 +137,14 @@ class CustomerModelManager(models.Manager):
         CustomerModelQueryset
             A filtered CustomerModel QuerySet.
         """
-        qs = self.get_queryset()
+        qs = self.for_user(user_model)
 
         if isinstance(entity_slug, lazy_loader.get_entity_model()):
             return qs.filter(
-                Q(entity_model=entity_slug) &
-                (
-                        Q(entity_model__admin=user_model) |
-                        Q(entity_model__managers__in=[user_model])
-                )
+                Q(entity_model=entity_slug)
             )
         return qs.filter(
-            Q(entity_model__slug__exact=entity_slug) &
-            (
-                    Q(entity_model__admin=user_model) |
-                    Q(entity_model__managers__in=[user_model])
-            )
+            Q(entity_model__slug__exact=entity_slug)
         )
 
 

django_ledger/models/data_import.py

@@ -42,14 +42,20 @@ class ImportJobModelManager(models.Manager):
             'ledger_model'
         )
 
-    def for_entity(self, entity_slug: str, user_model):
+    def for_user(self, user_model):
         qs = self.get_queryset()
+        if user_model.is_superuser:
+            return qs
         return qs.filter(
-            Q(bank_account_model__entity_model__slug__exact=entity_slug) &
-            (
-                    Q(bank_account_model__entity_model__admin=user_model) |
-                    Q(bank_account_model__entity_model__managers__in=[user_model])
-            )
+            Q(bank_account_model__entity_model__admin=user_model) |
+            Q(bank_account_model__entity_model__managers__in=[user_model])
+
+        )
+
+    def for_entity(self, entity_slug: str, user_model):
+        qs = self.for_user(user_model)
+        return qs.filter(
+            Q(bank_account_model__entity_model__slug__exact=entity_slug)
         )
 
 

django_ledger/models/entity.py

@@ -27,7 +27,7 @@ from decimal import Decimal
 from itertools import zip_longest
 from random import choices
 from string import ascii_lowercase, digits
-from typing import Tuple, Union, Optional, List, Dict
+from typing import Tuple, Union, Optional, List, Dict, Set
 from uuid import uuid4, UUID
 
 from django.contrib.auth import get_user_model
@@ -36,7 +36,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, QuerySet
+from django.db.models import Q
 from django.db.models.signals import pre_save
 from django.urls import reverse
 from django.utils.text import slugify
@@ -45,7 +45,7 @@ from django.utils.translation import gettext_lazy as _
 from treebeard.mp_tree import MP_Node, MP_NodeManager, MP_NodeQuerySet
 
 from django_ledger.io import roles as roles_module, validate_roles, IODigestContextManager
-from django_ledger.io.io_mixin import IOMixIn
+from django_ledger.io.io_core import IOMixIn
 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
@@ -114,7 +114,7 @@ class EntityModelManager(MP_NodeManager):
 
     def get_queryset(self):
         """Sets the custom queryset as the default."""
-        qs = super().get_queryset()
+        qs = EntityModelQuerySet(self.model).order_by('path')
         return qs.order_by('path').select_related('admin', 'default_coa')
 
     def for_user(self, user_model):
@@ -135,6 +135,8 @@ class EntityModelManager(MP_NodeManager):
                 2. Is a manager.
         """
         qs = self.get_queryset()
+        if user_model.is_superuser:
+            return qs
         return qs.filter(
             Q(admin=user_model) |
             Q(managers__in=[user_model])
@@ -890,8 +892,15 @@ class EntityModelAbstract(MP_Node,
         return user_model.id == self.admin_id
 
     # #### LEDGER MANAGEMENT....
-    def create_ledger(self, name):
-        return self.ledgermodel_set.create(name=name)
+    def create_ledger(self, name: str, ledger_xid: Optional[str] = None, posted: bool = False, commit: bool = True):
+        if commit:
+            return self.ledgermodel_set.create(name=name, ledger_xid=ledger_xid, posted=posted)
+        return LedgerModel(
+            entity=self,
+            posted=posted,
+            name=name,
+            ledger_xid=ledger_xid
+        )
 
     # #### SLUG GENERATION ###
     @staticmethod
@@ -1007,10 +1016,10 @@ class EntityModelAbstract(MP_Node,
             coa_name = 'Default CoA'
 
         chart_of_accounts = ChartOfAccountModel(
-            slug=self.slug + ''.join(choices(ENTITY_RANDOM_SLUG_SUFFIX, k=6)) + '-coa',
             name=coa_name,
             entity=self
         )
+
         chart_of_accounts.clean()
         chart_of_accounts.save()
         chart_of_accounts.configure()
@@ -1293,7 +1302,7 @@ class EntityModelAbstract(MP_Node,
         return self.get_coa_accounts(active=active, order_by=order_by)
 
     def get_accounts_with_codes(self,
-                                code_list: Union[str, List[str]],
+                                code_list: Union[str, List[str], Set[str]],
                                 coa_model: Optional[Union[ChartOfAccountModel, UUID, str]] = None
                                 ) -> AccountModelQuerySet:
         """
@@ -1351,12 +1360,72 @@ class EntityModelAbstract(MP_Node,
         return account_model_qs.get(role__exact=role)
 
     def create_account(self,
-                       account_model_kwargs: Dict,
+                       code: str,
+                       role: str,
+                       name: str,
+                       balance_type: str,
+                       active: bool,
                        coa_model: Optional[Union[ChartOfAccountModel, UUID, str]] = None,
-                       raise_exception: bool = True) -> Tuple[ChartOfAccountModel, AccountModel]:
+                       raise_exception: bool = True) -> AccountModel:
         """
         Creates a new AccountModel for the EntityModel.
 
+        Parameters
+        ----------
+        code: str
+            The AccountModel code of the new Account.
+        role: str
+            The choice of role that the new Account belongs to.
+        name: str
+            The name of the new Account.
+        balance_type: str
+            The balance type of the new account. Possible values are 'debit' or 'credit'.
+        active: bool
+            Active status of the new account.
+        coa_model: ChartOfAccountModel, UUID, str
+            The ChartOfAccountsModel UUID, model instance or slug to pull accounts from. Uses default Coa if not
+            provided.
+        raise_exception: bool
+            Raises EntityModelValidationError if ChartOfAccountsModel is not valid for the EntityModel instance.
+
+        Returns
+        -------
+        A tuple of ChartOfAccountModel, AccountModel
+            The ChartOfAccountModel and AccountModel instance just created.
+        """
+        if coa_model:
+            if isinstance(coa_model, UUID):
+                coa_model = self.chartofaccountsmodel_set.get(uuid__exact=coa_model)
+            elif isinstance(coa_model, str):
+                coa_model = self.chartofaccountsmodel_set.get(slug__exact=coa_model)
+            elif isinstance(coa_model, ChartOfAccountModel):
+                self.validate_chart_of_accounts_for_entity(
+                    coa_model=coa_model,
+                    raise_exception=raise_exception
+                )
+        else:
+            coa_model = self.default_coa
+
+        account_model = AccountModel(
+            code=code,
+            name=name,
+            role=role,
+            active=active,
+            balance_type=balance_type
+        )
+
+        account_model.clean()
+        return coa_model.create_account(account_model=account_model)
+
+    def create_account_by_kwargs(self,
+                                 account_model_kwargs: Dict,
+                                 coa_model: Optional[Union[ChartOfAccountModel, UUID, str]] = None,
+                                 raise_exception: bool = True) -> Tuple[ChartOfAccountModel, AccountModel]:
+        """
+        Creates a new AccountModel for the EntityModel by passing AccountModel KWARGS.
+        This is a legacy method for creating a new AccountModel for the EntityModel.
+        Will be deprecated in favor of create_account().
+
         Parameters
         ----------
         coa_model: ChartOfAccountModel, UUID, str
@@ -1378,7 +1447,10 @@ class EntityModelAbstract(MP_Node,
             elif isinstance(coa_model, str):
                 coa_model = self.chartofaccountsmodel_set.get(slug__exact=coa_model)
             elif isinstance(coa_model, ChartOfAccountModel):
-                self.validate_chart_of_accounts_for_entity(coa_model=coa_model, raise_exception=raise_exception)
+                self.validate_chart_of_accounts_for_entity(
+                    coa_model=coa_model,
+                    raise_exception=raise_exception
+                )
         else:
             coa_model = self.default_coa
 
@@ -2692,6 +2764,12 @@ class EntityModelAbstract(MP_Node,
         data_generator.populate_entity()
 
     # URLS ----
+    def get_absolute_url(self):
+        return reverse(viewname='django_ledger:entity-dashboard',
+                       kwargs={
+                           'entity_slug': self.slug
+                       })
+
     def get_dashboard_url(self) -> str:
         """
         The EntityModel Dashboard URL.
@@ -2954,7 +3032,7 @@ class EntityStateModelAbstract(models.Model):
         ]
 
     def __str__(self):
-        return f'{self.__class__.__name__} {self.entity_id}: FY: {self.fiscal_year}, KEY: {self.get_key_display()}'
+        return f'{self.__class__.__name__} {self.entity_model_id}: FY: {self.fiscal_year}, KEY: {self.get_key_display()}'
 
 
 class EntityStateModel(EntityStateModelAbstract):