Create transaction fee match rules based on CPF for memberships

Author: rennerocha

thebook/bookkeeping/importers/csv.py

@@ -140,7 +140,7 @@ def run(self, start_date=None, end_date=None, ignored_memos=None):
                     # We don't process USD recurring here
                     continue
 
-                current_membership_fees = (75, 85, 110)
+                current_membership_fees = (75, 85, 110, 120)
                 recurring_fee_type = (
                     "Mensalidade"
                     if transaction_amount in current_membership_fees
@@ -166,7 +166,7 @@ def run(self, start_date=None, end_date=None, ignored_memos=None):
                     Transaction(
                         reference=f"{transaction_reference}T",
                         date=transaction_date,
-                        description=f"Taxa Intermediação - {recurring_fee_type} - {transaction_name}",
+                        description=f"Taxa PayPal - {recurring_fee_type} - {transaction_name}",
                         amount=transaction_tax,
                         bank_account=self.bank_account,
                         category=self.categories[BANK_FEES],

thebook/members/models.py

@@ -1,6 +1,7 @@
 import calendar
 import datetime
 import itertools
+import re
 
 from dateutil.relativedelta import relativedelta
 from localflavor.br.models import BRCPFField
@@ -104,6 +105,10 @@ def __str__(self):
         active_status = "Active" if self.active else "Inactive"
         return f"{active_status} membership of {self.member.name}"
 
+    def save(self, **kwargs):
+        self.create_receivable_fee_transaction_match_rules()
+        super().save(**kwargs)
+
     def create_next_receivable_fee(self, commit=True):
         if not self.active:
             return None
@@ -158,6 +163,23 @@ def _next_period(current_date, payment_interval):
 
         return receivable_fee
 
+    def create_receivable_fee_transaction_match_rules(self):
+        member_cpf = self.member.cpf
+        member_cpf_only_digits = re.sub(r"[^\d]+", "", member_cpf)
+
+        if not member_cpf_only_digits:
+            return
+
+        pattern_1 = f".*{member_cpf_only_digits}.*"
+        ReceivableFeeTransactionMatchRule.objects.get_or_create(
+            membership=self, pattern=pattern_1
+        )
+
+        pattern_2 = f".*{member_cpf_only_digits[:3]}.{member_cpf_only_digits[3:6]}.{member_cpf_only_digits[6:9]}-{member_cpf_only_digits[9:]}.*"
+        ReceivableFeeTransactionMatchRule.objects.get_or_create(
+            membership=self, pattern=pattern_2
+        )
+
     @property
     def next_membership_fee_payment_date(self):
         allowed_months = sorted(

thebook/members/tests/models/test_membership.py

@@ -13,6 +13,7 @@
     Member,
     Membership,
     ReceivableFee,
+    ReceivableFeeTransactionMatchRule,
 )
 
 
@@ -149,3 +150,115 @@ def test_when_membership_is_activated_add_first_receivable_fee(db):
 
     assert membership.receivable_fees.exists()
     assert membership.receivable_fees.count() == 1
+
+
+@pytest.mark.parametrize(
+    "cpf,expected_patterns",
+    [
+        ("123.456.789-10", (".*123.456.789-10.*", ".*12345678910.*")),
+        ("12345678910", (".*123.456.789-10.*", ".*12345678910.*")),
+    ],
+)
+def test_when_membership_is_created_add_receivable_fee_match_rule_with_their_cpf(
+    db, cpf, expected_patterns
+):
+    """Some transactions contains the CPF of the member, so this is the simplest rule to match a receivable fee payment"""
+    member = baker.make(Member, cpf=cpf)
+
+    membership = Membership.objects.create(
+        member=member,
+        start_date=date(2025, 8, 11),
+        membership_fee_amount=Decimal("85"),
+        payment_interval=FeeIntervals.MONTHLY,
+        active=False,
+    )
+
+    assert (
+        ReceivableFeeTransactionMatchRule.objects.filter(membership=membership).count()
+        == 2
+    )
+    for expected_pattern in expected_patterns:
+        assert ReceivableFeeTransactionMatchRule.objects.filter(
+            membership=membership, pattern=expected_pattern
+        ).exists()
+
+
+def test_when_membership_is_created_do_not_add_receivable_fee_match_rule_with_member_without_cpf(
+    db,
+):
+    """Some transactions contains the CPF of the member, so this is the simplest rule to match a receivable fee payment"""
+    member = baker.make(Member, cpf="")
+
+    membership = Membership.objects.create(
+        member=member,
+        start_date=date(2025, 8, 11),
+        membership_fee_amount=Decimal("85"),
+        payment_interval=FeeIntervals.MONTHLY,
+        active=False,
+    )
+
+    assert (
+        ReceivableFeeTransactionMatchRule.objects.filter(membership=membership).count()
+        == 0
+    )
+
+
+def test_when_membership_do_not_add_duplicated_receivable_fee_match_rule_if_already_exists(
+    db,
+):
+    """Some transactions contains the CPF of the member, so this is the simplest rule to match a receivable fee payment"""
+    member = baker.make(Member, cpf="123.456.789-10")
+
+    membership = Membership.objects.create(
+        member=member,
+        start_date=date(2025, 8, 11),
+        membership_fee_amount=Decimal("85"),
+        payment_interval=FeeIntervals.MONTHLY,
+        active=False,
+    )
+    assert (
+        ReceivableFeeTransactionMatchRule.objects.filter(membership=membership).count()
+        == 2
+    )
+
+    membership.membership_fee_amount = Decimal("110")
+    membership.save()
+
+    assert (
+        ReceivableFeeTransactionMatchRule.objects.filter(membership=membership).count()
+        == 2
+    )
+
+
+def test_keep_existing_receivable_fee_match_rule_that_exist(db):
+    """Some transactions contains the CPF of the member, so this is the simplest rule to match a receivable fee payment"""
+    member = baker.make(Member, cpf="")
+    membership = Membership.objects.create(
+        member=member,
+        start_date=date(2025, 8, 11),
+        membership_fee_amount=Decimal("85"),
+        payment_interval=FeeIntervals.MONTHLY,
+        active=False,
+    )
+    ReceivableFeeTransactionMatchRule.objects.create(
+        membership=membership, pattern=".*Member name.*"
+    )
+
+    member.cpf = "123.456.789-10"
+    member.save()
+
+    membership.save()
+
+    assert (
+        ReceivableFeeTransactionMatchRule.objects.filter(membership=membership).count()
+        == 3
+    )
+    assert ReceivableFeeTransactionMatchRule.objects.filter(
+        membership=membership, pattern=".*Member name.*"
+    ).exists()
+    assert ReceivableFeeTransactionMatchRule.objects.filter(
+        membership=membership, pattern=".*12345678910.*"
+    ).exists()
+    assert ReceivableFeeTransactionMatchRule.objects.filter(
+        membership=membership, pattern=".*123.456.789-10.*"
+    ).exists()