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

django_ledger/models/bill.py

@@ -4,7 +4,6 @@ Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
 
 Contributions to this module:
     * Miguel Sanda <msanda@arrobalytics.com>
-    * Pranav P Tulshyan <ptulshyan77@gmail.com>
 
 This module implements the BillModel, which represents an Invoice received from a Supplier/Vendor, on which
 the Vendor states the amount owed by the recipient for the purposes of supplying goods and/or services.
@@ -39,6 +38,14 @@ from django_ledger.models.entity import EntityModel
 from django_ledger.models.items import ItemTransactionModelQuerySet, ItemTransactionModel, ItemModel, ItemModelQuerySet
 from django_ledger.models.mixins import (CreateUpdateMixIn, AccrualMixIn, MarkdownNotesMixIn,
                                          PaymentTermsMixIn, ItemizeMixIn)
+from django_ledger.models.signals import (
+    bill_status_draft,
+    bill_status_in_review,
+    bill_status_approved,
+    bill_status_paid,
+    bill_status_canceled,
+    bill_status_void,
+)
 from django_ledger.models.utils import lazy_loader
 from django_ledger.settings import (DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING, DJANGO_LEDGER_BILL_NUMBER_PREFIX)
 
@@ -612,9 +619,8 @@ class BillModelAbstract(
             account_unit_total=Sum('total_amount')
         )
 
-    def update_amount_due(self,
-                          itemtxs_qs: Optional[Union[ItemTransactionModelQuerySet, List[ItemTransactionModel]]] = None
-                          ) -> ItemTransactionModelQuerySet:
+    def update_amount_due(self, itemtxs_qs: Optional[
+        Union[ItemTransactionModelQuerySet, List[ItemTransactionModel]]] = None) -> ItemTransactionModelQuerySet:
         """
         Updates the BillModel amount due.
 
@@ -1071,6 +1077,9 @@ class BillModelAbstract(
                     'updated'
                 ]
             )
+        bill_status_draft.send_robust(sender=self.__class__,
+                                      instance=self,
+                                      commited=commit, **kwargs)
 
     def get_mark_as_draft_html_id(self) -> str:
         """
@@ -1176,6 +1185,9 @@ class BillModelAbstract(
                     'updated'
                 ]
             )
+        bill_status_in_review.send_robust(sender=self.__class__,
+                                          instance=self,
+                                          commited=commit, **kwargs)
 
     def get_mark_as_review_html_id(self) -> str:
         """
@@ -1283,6 +1295,9 @@ class BillModelAbstract(
                     force_migrate=self.accrue
                 )
             self.ledger.post(commit=commit, raise_exception=raise_exception)
+        bill_status_approved.send_robust(sender=self.__class__,
+                                         instance=self,
+                                         commited=commit, **kwargs)
 
     def get_mark_as_approved_html_id(self) -> str:
         """
@@ -1406,6 +1421,9 @@ class BillModelAbstract(
                 force_migrate=True
             )
             self.lock_ledger(commit=True)
+        bill_status_paid.send_robust(sender=self.__class__,
+                                     instance=self,
+                                     commited=commit, **kwargs)
 
     def get_mark_as_paid_html_id(self) -> str:
         """
@@ -1507,6 +1525,9 @@ class BillModelAbstract(
                 force_migrate=True)
             self.save()
             self.lock_ledger(commit=False, raise_exception=False)
+        bill_status_void.send_robust(sender=self.__class__,
+                                     instance=self,
+                                     commited=commit, **kwargs)
 
     def get_mark_as_void_html_id(self) -> str:
         """
@@ -1574,6 +1595,9 @@ class BillModelAbstract(
         self.clean()
         if commit:
             self.save()
+        bill_status_canceled.send_robust(sender=self.__class__,
+                                         instance=self,
+                                         commited=commit, **kwargs)
 
     def get_mark_as_canceled_html_id(self) -> str:
         """
@@ -1890,13 +1914,3 @@ def billmodel_presave(instance: BillModel, **kwargs):
 
 
 pre_save.connect(receiver=billmodel_presave, sender=BillModel)
-
-# def billmodel_predelete(instance: BillModel, **kwargs):
-#     ledger_model = instance.ledger
-#     ledger_model.unpost(commit=False)
-#     ledger_model.remove_wrapped_model_info()
-#     ledger_model.itemtransactonmodel_set.all().delete()
-#     instance.ledger.delete()
-#
-#
-# pre_delete.connect(receiver=billmodel_predelete, sender=BillModel)

django_ledger/models/closing_entry.py

@@ -1,3 +1,11 @@
+"""
+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>
+"""
+
 from datetime import datetime, time
 from decimal import Decimal
 from itertools import groupby, chain

django_ledger/models/entity.py

@@ -1292,12 +1292,19 @@ class EntityModelAbstract(MP_Node,
         """
 
         if not coa_model:
-            account_model_qs = self.default_coa.accountmodel_set.all().select_related(
-                'coa_model', 'coa_model__entity').not_coa_root()
-        else:
+            coa_model = self.default_coa
+        elif isinstance(coa_model, UUID):
+            coa_model = self.chartofaccountmodel_set.get(uuid__exact=coa_model)
+        elif isinstance(coa_model, str):
+            coa_model = self.chartofaccountmodel_set.get(slug__exact=coa_model)
+        elif isinstance(coa_model, ChartOfAccountModel):
             self.validate_chart_of_accounts_for_entity(coa_model=coa_model)
-            account_model_qs = coa_model.accountmodel_set.select_related(
-                'coa_model', 'coa_model__entity').not_coa_root()
+        else:
+            raise EntityModelValidationError(
+                f'CoA Model {coa_model} must be an instance of ChartOfAccountModel, UUID, str or None.'
+            )
+
+        account_model_qs = coa_model.accountmodel_set.select_related('coa_model', 'coa_model__entity').not_coa_root()
 
         if active:
             account_model_qs = account_model_qs.active()

django_ledger/models/estimate.py

@@ -36,6 +36,14 @@ from django_ledger.models.entity import EntityModel, EntityStateModel
 from django_ledger.models.items import ItemTransactionModelQuerySet, ItemTransactionModel, ItemModelQuerySet, ItemModel
 from django_ledger.models.mixins import CreateUpdateMixIn, MarkdownNotesMixIn, ItemizeMixIn
 from django_ledger.models.purchase_order import PurchaseOrderModelQuerySet
+from django_ledger.models.signals import (
+    estimate_status_void,
+    estimate_status_draft,
+    estimate_status_approved,
+    estimate_status_canceled,
+    estimate_status_completed,
+    estimate_status_in_review
+)
 from django_ledger.settings import DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING, DJANGO_LEDGER_ESTIMATE_NUMBER_PREFIX
 
 ESTIMATE_NUMBER_CHARS = ascii_uppercase + digits
@@ -610,7 +618,7 @@ class EstimateModelAbstract(CreateUpdateMixIn,
 
     # Actions...
     # DRAFT...
-    def mark_as_draft(self, commit: bool = False):
+    def mark_as_draft(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         """
         Marks the current EstimateModel instance as Draft.
 
@@ -620,7 +628,9 @@ class EstimateModelAbstract(CreateUpdateMixIn,
             Commits transaction into current EstimateModel instance.
         """
         if not self.can_draft():
-            raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be marked as draft...')
+            if raise_exception:
+                raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be marked as draft...')
+            return
         self.status = self.CONTRACT_STATUS_DRAFT
         self.clean()
         if commit:
@@ -628,6 +638,10 @@ class EstimateModelAbstract(CreateUpdateMixIn,
                 'status',
                 'updated'
             ])
+        estimate_status_draft.send_robust(sender=self.__class__,
+                                          instance=self,
+                                          commited=commit,
+                                          **kwargs)
 
     def get_mark_as_draft_html_id(self):
         """
@@ -670,7 +684,10 @@ class EstimateModelAbstract(CreateUpdateMixIn,
     def mark_as_review(self,
                        itemtxs_qs: Optional[ItemTransactionModelQuerySet] = None,
                        date_in_review: Optional[date] = None,
-                       commit: bool = True):
+                       raise_exception: bool = True,
+                       commit: bool = True,
+                       **kwargs):
+
         """
         Marks the current EstimateModel instance as In Review.
 
@@ -685,7 +702,9 @@ class EstimateModelAbstract(CreateUpdateMixIn,
             Optional date when EstimateModel instance is In Review. Defaults to localdate().
         """
         if not self.can_review():
-            raise ValidationError(f'Estimate {self.estimate_number} cannot be marked as In Review...')
+            if raise_exception:
+                raise ValidationError(f'Estimate {self.estimate_number} cannot be marked as In Review...')
+            return
 
         if not itemtxs_qs:
             itemtxs_qs = self.itemtransactionmodel_set.all()
@@ -710,6 +729,10 @@ class EstimateModelAbstract(CreateUpdateMixIn,
                 'status',
                 'updated'
             ])
+        estimate_status_in_review.send_robust(sender=self.__class__,
+                                              instance=self,
+                                              commited=commit,
+                                              **kwargs)
 
     def get_mark_as_review_html_id(self):
         """
@@ -749,7 +772,11 @@ class EstimateModelAbstract(CreateUpdateMixIn,
         return _('Do you want to mark Estimate %s as In Review?') % self.estimate_number
 
     # APPROVED
-    def mark_as_approved(self, commit=False, date_approved: Optional[date] = None):
+    def mark_as_approved(self,
+                         commit=False,
+                         date_approved: Optional[date] = None,
+                         raise_exception: bool = True,
+                         **kwargs):
         """
         Marks the current EstimateModel instance as Approved.
 
@@ -761,9 +788,12 @@ class EstimateModelAbstract(CreateUpdateMixIn,
             Optional date when EstimateModel instance is Approved. Defaults to localdate().
         """
         if not self.can_approve():
-            raise EstimateModelValidationError(
-                f'Estimate {self.estimate_number} cannot be marked as approved.'
-            )
+            if raise_exception:
+                raise EstimateModelValidationError(
+                    f'Estimate {self.estimate_number} cannot be marked as approved.'
+                )
+            return
+
         if not date_approved:
             date_approved = get_localdate()
         self.date_approved = date_approved
@@ -775,6 +805,10 @@ class EstimateModelAbstract(CreateUpdateMixIn,
                 'date_approved',
                 'updated'
             ])
+        estimate_status_approved.send_robust(sender=self.__class__,
+                                             instance=self,
+                                             commited=commit,
+                                             **kwargs)
 
     def get_mark_as_approved_html_id(self):
         """
@@ -814,7 +848,11 @@ class EstimateModelAbstract(CreateUpdateMixIn,
         return _('Do you want to mark Estimate %s as Approved?') % self.estimate_number
 
     # COMPLETED
-    def mark_as_completed(self, commit=False, date_completed: Optional[date] = None):
+    def mark_as_completed(self,
+                          commit=False,
+                          date_completed: Optional[date] = None,
+                          raise_exception: bool = True,
+                          **kwargs):
         """
         Marks the current EstimateModel instance as Completed.
 
@@ -826,7 +864,9 @@ class EstimateModelAbstract(CreateUpdateMixIn,
             Optional date when EstimateModel instance is completed. Defaults to localdate().
         """
         if not self.can_complete():
-            raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be marked as completed.')
+            if raise_exception:
+                raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be marked as completed.')
+            return
         if not date_completed:
             date_completed = get_localdate()
         self.date_completed = date_completed
@@ -834,11 +874,18 @@ class EstimateModelAbstract(CreateUpdateMixIn,
         self.clean()
         if commit:
             self.clean()
-            self.save(update_fields=[
-                'status',
-                'date_completed',
-                'updated'
-            ])
+            self.save(
+                update_fields=[
+                    'status',
+                    'date_completed',
+                    'updated'
+                ])
+        estimate_status_completed.send_robust(
+            sender=self.__class__,
+            instance=self,
+            commited=commit,
+            **kwargs
+        )
 
     def get_mark_as_completed_html_id(self):
         """
@@ -878,7 +925,11 @@ class EstimateModelAbstract(CreateUpdateMixIn,
         return _('Do you want to mark Estimate %s as Completed?') % self.estimate_number
 
     # CANCEL
-    def mark_as_canceled(self, commit: bool = False, date_canceled: Optional[date] = None):
+    def mark_as_canceled(self,
+                         commit: bool = False,
+                         date_canceled: Optional[date] = None,
+                         raise_exception: bool = True,
+                         **kwargs):
         """
         Marks the current EstimateModel instance as Canceled.
 
@@ -890,7 +941,9 @@ class EstimateModelAbstract(CreateUpdateMixIn,
             Optional date when EstimateModel instance is canceled. Defaults to localdate().
         """
         if not self.can_cancel():
-            raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be canceled...')
+            if raise_exception:
+                raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be canceled...')
+            return
         if not date_canceled:
             date_canceled = get_localdate()
         self.date_canceled = date_canceled
@@ -902,6 +955,12 @@ class EstimateModelAbstract(CreateUpdateMixIn,
                 'date_canceled',
                 'updated'
             ])
+        estimate_status_canceled.send_robust(
+            sender=self.__class__,
+            instance=self,
+            commited=commit,
+            **kwargs
+        )
 
     def get_mark_as_canceled_html_id(self):
         """
@@ -941,7 +1000,12 @@ class EstimateModelAbstract(CreateUpdateMixIn,
         return _('Do you want to mark Estimate %s as Canceled?') % self.estimate_number
 
     # VOID
-    def mark_as_void(self, commit: bool = False, date_void: Optional[date] = None):
+    def mark_as_void(self,
+                     commit: bool = False,
+                     date_void: Optional[date] = None,
+                     raise_exception: bool = True,
+                     **kwargs):
+
         """
         Marks the current EstimateModel instance as Void.
 
@@ -953,7 +1017,10 @@ class EstimateModelAbstract(CreateUpdateMixIn,
             Optional date when EstimateModel instance is void. Defaults to localdate().
         """
         if not self.can_void():
-            raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be void...')
+            if raise_exception:
+                raise EstimateModelValidationError(f'Estimate {self.estimate_number} cannot be void...')
+            return
+
         if not date_void:
             date_void = get_localdate()
         self.date_void = date_void
@@ -965,6 +1032,12 @@ class EstimateModelAbstract(CreateUpdateMixIn,
                 'date_void',
                 'updated'
             ])
+        estimate_status_void.send_robust(
+            sender=self.__class__,
+            instance=self,
+            commited=commit,
+            **kwargs
+        )
 
     def get_mark_as_void_html_id(self):
         """
@@ -1167,8 +1240,7 @@ 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)

django_ledger/models/invoice.py

@@ -38,8 +38,21 @@ from django_ledger.io import ASSET_CA_CASH, ASSET_CA_RECEIVABLES, LIABILITY_CL_D
 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.entity import EntityModel
-from django_ledger.models.mixins import CreateUpdateMixIn, AccrualMixIn, MarkdownNotesMixIn, PaymentTermsMixIn, \
+from django_ledger.models.mixins import (
+    CreateUpdateMixIn, AccrualMixIn,
+    MarkdownNotesMixIn, PaymentTermsMixIn,
     ItemizeMixIn
+)
+
+from django_ledger.models.signals import (
+    invoice_status_draft,
+    invoice_status_in_review,
+    invoice_status_approved,
+    invoice_status_paid,
+    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()
@@ -446,7 +459,7 @@ class InvoiceModelAbstract(
 
             if self.can_generate_invoice_number():
                 self.generate_invoice_number(commit=commit)
-                ledger_model.ledger_xid=f'invoice-{self.invoice_number.lower()}-{str(ledger_model.entity_id)[-5:]}'
+                ledger_model.ledger_xid = f'invoice-{self.invoice_number.lower()}-{str(ledger_model.entity_id)[-5:]}'
                 ledger_model.save(update_fields=['ledger_xid'])
 
             self.clean()
@@ -1002,6 +1015,9 @@ class InvoiceModelAbstract(
                 'invoice_status',
                 'updated'
             ])
+        invoice_status_draft.send_robust(sender=self.__class__,
+                                         instance=self,
+                                         commited=commit, **kwargs)
 
     def get_mark_as_draft_html_id(self):
         """
@@ -1050,7 +1066,8 @@ class InvoiceModelAbstract(
     def mark_as_review(self,
                        date_in_review: date = None,
                        itemtxs_qs=None,
-                       commit: bool = False, **kwargs):
+                       commit: bool = False,
+                       **kwargs):
         """
         Marks InvoiceModel as In Review.
 
@@ -1088,6 +1105,10 @@ class InvoiceModelAbstract(
                 'date_in_review',
                 'updated'
             ])
+        invoice_status_in_review.send_robust(sender=self.__class__,
+                                             instance=self,
+                                             commited=commit,
+                                             **kwargs)
 
     def get_mark_as_review_html_id(self):
         """
@@ -1189,6 +1210,10 @@ class InvoiceModelAbstract(
                     force_migrate=self.accrue
                 )
             self.ledger.post(commit=commit, raise_exception=raise_exception)
+        invoice_status_approved.send_robust(sender=self.__class__,
+                                            instance=self,
+                                            commited=commit,
+                                            **kwargs)
 
     def get_mark_as_approved_html_id(self):
         """
@@ -1292,6 +1317,10 @@ class InvoiceModelAbstract(
                 je_timestamp=date_paid
             )
             self.lock_ledger(commit=True)
+        invoice_status_paid.send_robust(sender=self.__class__,
+                                        instance=self,
+                                        commited=commit,
+                                        **kwargs)
 
     def get_mark_as_paid_html_id(self):
         """
@@ -1398,6 +1427,10 @@ class InvoiceModelAbstract(
             )
             self.save()
             self.lock_ledger(commit=True, raise_exception=False)
+        invoice_status_void.send_robust(sender=self.__class__,
+                                        instance=self,
+                                        commited=commit,
+                                        **kwargs)
 
     def get_mark_as_void_html_id(self):
         """
@@ -1442,7 +1475,10 @@ class InvoiceModelAbstract(
         return _('Do you want to mark Invoice %s as Void?') % self.invoice_number
 
     # CANCEL
-    def mark_as_canceled(self, date_canceled: date = None, commit: bool = False, **kwargs):
+    def mark_as_canceled(self,
+                         date_canceled: date = None,
+                         commit: bool = False,
+                         **kwargs):
         """
         Mark InvoiceModel as Canceled.
 
@@ -1465,6 +1501,10 @@ class InvoiceModelAbstract(
             self.unlock_ledger(commit=True, raise_exception=False)
             self.unpost_ledger(commit=True, raise_exception=False)
             self.save()
+        invoice_status_canceled.send_robust(sender=self.__class__,
+                                            instance=self,
+                                            commited=commit,
+                                            **kwargs)
 
     def get_mark_as_canceled_html_id(self):
         """
@@ -1787,13 +1827,3 @@ def invoicemodel_presave(instance: InvoiceModel, **kwargs):
 
 
 pre_save.connect(receiver=invoicemodel_presave, sender=InvoiceModel)
-
-# def invoicemodel_predelete(instance: InvoiceModel, **kwargs):
-#     ledger_model = instance.ledger
-#     ledger_model.unpost(commit=False)
-#     ledger_model.remove_wrapped_model_info()
-#     ledger_model.itemtransactonmodel_set.all().delete()
-#     instance.ledger.delete()
-#
-#
-# pre_delete.connect(receiver=invoicemodel_predelete, sender=InvoiceModel)