Show payment metrics

commcare_connect/opportunity/migrations/0059_completedwork_payment_date.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.5 on 2024-10-03 02:33
+
+from django.db import migrations, models
+from django.db import transaction
+
+from commcare_connect.opportunity.models import OpportunityAccess
+from commcare_connect.opportunity.visit_import import update_work_payment_date
+
+
+@transaction.atomic
+def update_paid_date_from_payments(apps, schema_editor):
+    accesses = OpportunityAccess.objects.all()
+    for access in accesses:
+        update_work_payment_date(access)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("opportunity", "0058_paymentinvoice_payment_invoice"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="completedwork",
+            name="payment_date",
+            field=models.DateTimeField(null=True),
+        ),
+        migrations.RunPython(update_paid_date_from_payments, migrations.RunPython.noop),
+    ]

commcare_connect/opportunity/models.py

@@ -434,6 +434,7 @@ class CompletedWork(models.Model):
     entity_name = models.CharField(max_length=255, null=True, blank=True)
     reason = models.CharField(max_length=300, null=True, blank=True)
     status_modified_date = models.DateTimeField(null=True)
+    payment_date = models.DateTimeField(null=True)
 
     def __init__(self, *args, **kwargs):
         self.status = CompletedWorkStatus.incomplete

commcare_connect/opportunity/utils/completed_work.py

@@ -1,4 +1,11 @@
-from commcare_connect.opportunity.models import CompletedWorkStatus, VisitReviewStatus, VisitValidationStatus
+from commcare_connect.opportunity.models import (
+    CompletedWork,
+    CompletedWorkStatus,
+    OpportunityAccess,
+    Payment,
+    VisitReviewStatus,
+    VisitValidationStatus,
+)
 
 
 def update_status(completed_works, opportunity_access, compute_payment=True):
@@ -35,3 +42,32 @@ def update_status(completed_works, opportunity_access, compute_payment=True):
     if compute_payment:
         opportunity_access.payment_accrued = payment_accrued
         opportunity_access.save()
+
+
+def update_work_payment_date(access: OpportunityAccess):
+    payments = Payment.objects.filter(opportunity_access=access).order_by("date_paid")
+    completed_works = CompletedWork.objects.filter(opportunity_access=access).order_by("status_modified_date")
+
+    paid = 0
+    works_to_update = []
+    completed_works_iter = iter(completed_works)
+
+    try:
+        current_work = next(completed_works_iter)
+    except StopIteration:
+        return
+
+    for payment in payments:
+        paid += payment.amount
+
+        while paid > current_work.payment_accrued:
+            current_work.payment_date = payment.date_paid
+            works_to_update.append(current_work)
+
+            try:
+                current_work = next(completed_works_iter)
+            except StopIteration:
+                break
+
+    if works_to_update:
+        CompletedWork.objects.bulk_update(works_to_update, ["payment_date"])

commcare_connect/opportunity/visit_import.py

@@ -19,7 +19,7 @@
     VisitValidationStatus,
 )
 from commcare_connect.opportunity.tasks import send_payment_notification
-from commcare_connect.opportunity.utils.completed_work import update_status
+from commcare_connect.opportunity.utils.completed_work import update_status, update_work_payment_date
 from commcare_connect.utils.file import get_file_extension
 from commcare_connect.utils.itertools import batched
 
@@ -263,6 +263,7 @@ def _bulk_update_payments(opportunity: Opportunity, imported_data: Dataset) -> P
             payment = Payment.objects.create(opportunity_access=access, amount=amount)
             seen_users.add(username)
             payment_ids.append(payment.pk)
+            update_work_payment_date(access)
     missing_users = set(usernames) - seen_users
     send_payment_notification.delay(opportunity.id, payment_ids)
     return PaymentImportStatus(seen_users, missing_users)