Merge pull request dimagi#911 from dimagi/hy/inv-adm-rep

Invoice Admin Report

Author: hemant10yadav

commcare_connect/opportunity/views.py

@@ -181,7 +181,7 @@
 from commcare_connect.program.utils import is_program_manager
 from commcare_connect.users.models import User
 from commcare_connect.utils.analytics import GA_CUSTOM_DIMENSIONS, Event, GATrackingInfo, send_event_to_ga
-from commcare_connect.utils.celery import CELERY_TASK_SUCCESS, get_task_progress_message
+from commcare_connect.utils.celery import download_export_file, render_export_status
 from commcare_connect.utils.file import get_file_extension
 from commcare_connect.utils.flags import FlagLabels, Flags
 from commcare_connect.utils.tables import PAGE_SIZE_OPTIONS, get_duration_min, get_validated_page_size
@@ -503,40 +503,29 @@ def review_visit_export(request, org_slug, opp_id):
 @org_member_required
 @require_GET
 def export_status(request, org_slug, task_id):
-    task = AsyncResult(task_id)
-    task_meta = task._get_task_meta()
-    opportunity_id = task_meta.get("args")[0]
-    # Make sure opportunity exists for the given org_slug
-    get_opportunity_or_404(org_slug=org_slug, pk=opportunity_id)
-    status = task_meta.get("status")
-    progress = {"complete": status == CELERY_TASK_SUCCESS, "message": get_task_progress_message(task)}
-    if status == "FAILURE":
-        progress["error"] = task_meta.get("result")
-    return render(
+    def ownership_check(request, task_meta):
+        opportunity_id = task_meta.get("args")[0]
+        get_opportunity_or_404(org_slug=org_slug, pk=opportunity_id)
+
+    return render_export_status(
         request,
-        "components/upload_progress_bar.html",
-        {
-            "task_id": task_id,
-            "current_time": now().microsecond,
-            "progress": progress,
-        },
+        task_id=task_id,
+        download_url=reverse("opportunity:download_export", args=(org_slug, task_id)),
+        export_status_url=reverse("opportunity:export_status", args=(org_slug, task_id)),
+        ownership_check=ownership_check,
     )
 
 
 @org_member_required
 @require_GET
 def download_export(request, org_slug, task_id):
     task_meta = AsyncResult(task_id)._get_task_meta()
-    saved_filename = task_meta.get("result")
     opportunity_id = task_meta.get("args")[0]
     opportunity = get_opportunity_or_404(org_slug=org_slug, pk=opportunity_id)
     op_slug = slugify(opportunity.name)
-    export_format = saved_filename.split(".")[-1]
-    filename = f"{org_slug}_{op_slug}_export.{export_format}"
-
-    export_file = storages["default"].open(saved_filename)
-    return FileResponse(
-        export_file, as_attachment=True, filename=filename, content_type=TableExport.FORMATS[export_format]
+    return download_export_file(
+        task_id=task_id,
+        filename_without_ext=f"{org_slug}_{op_slug}_export",
     )
 
 

commcare_connect/reports/tables.py

@@ -1,6 +1,11 @@
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.translation import gettext as _
 from django_tables2 import columns, tables
 
+from commcare_connect.opportunity.models import PaymentInvoice
 from commcare_connect.opportunity.tables import SumColumn
+from commcare_connect.utils.tables import DMYTColumn
 
 
 class AdminReportTable(tables.Table):
@@ -34,3 +39,57 @@ def render_avg_time_to_payment(self, record, value):
 
     def render_max_time_to_payment(self, record, value):
         return f"{value} days"
+
+
+class InvoiceReportTable(tables.Table):
+    opportunity_id = columns.Column(
+        accessor="opportunity__id",
+        verbose_name=_("Opportunity ID"),
+    )
+    opportunity_name = columns.Column(
+        accessor="opportunity__name",
+        verbose_name=_("Opportunity Name"),
+    )
+    invoice_number = columns.Column(orderable=False, verbose_name=_("Invoice Number"))
+    amount = columns.Column(verbose_name=_("Amount"))
+    amount_usd = columns.Column(verbose_name=_("Amount (USD)"))
+    invoice_type = columns.Column(verbose_name=_("Type"), accessor="service_delivery")
+    status = columns.Column(verbose_name=_("Status"))
+    date = DMYTColumn(verbose_name=_("Date of Payment"), accessor="date_paid")
+
+    class Meta:
+        model = PaymentInvoice
+        fields = (
+            "opportunity_id",
+            "opportunity_name",
+            "invoice_number",
+            "amount",
+            "amount_usd",
+            "invoice_type",
+            "status",
+            "date",
+        )
+
+    def render_invoice_number(self, value, record):
+        url = reverse(
+            "opportunity:invoice_review",
+            args=[record.org_slug, record.opportunity_id, record.id],
+        )
+        return format_html(
+            '<a href="{}" class="underline text-brand-deep-purple">{}</a>',
+            url,
+            value,
+        )
+
+    def value_invoice_number(self, value, record):
+        return value
+
+    def render_amount(self, record):
+        return f"{record.opportunity.currency_code} {record.amount}"
+
+    def render_invoice_type(self, record):
+        return (
+            PaymentInvoice.InvoiceType.service_delivery.label
+            if record.service_delivery
+            else PaymentInvoice.InvoiceType.custom.label
+        )

commcare_connect/reports/tasks.py

@@ -1,9 +1,13 @@
 import logging
+import uuid
 from collections import defaultdict
 from itertools import chain
 
+from django.core.files.base import ContentFile
+from django.core.files.storage import default_storage
 from django.db.models import Case, Count, DateTimeField, F, IntegerField, Max, Min, Q, Sum, Value, When
 from django.db.models.lookups import GreaterThanOrEqual
+from django_tables2.export.export import TableExport
 
 from commcare_connect.connect_id_client.main import fetch_user_analytics
 from commcare_connect.opportunity.models import CompletedWorkStatus, OpportunityAccess
@@ -128,3 +132,20 @@ def sync_user_analytics_data():
     )
 
     logger.info(f"Updated UserAnalyticsData for {len(result)} users.")
+
+
+@celery_app.task()
+def export_invoice_report_task(filters_data):
+    from commcare_connect.reports.views import InvoiceReportFilter, InvoiceReportTable, InvoiceReportView
+
+    logger.info("Starting invoice report export task with filters: %s", filters_data)
+
+    qs = InvoiceReportView.get_invoice_queryset()
+    filterset = InvoiceReportFilter(filters_data, queryset=qs)
+    table = InvoiceReportTable(filterset.qs)
+
+    exporter = TableExport("csv", table)
+    filename = f"invoice-report-{uuid.uuid4()}.csv"
+    content = exporter.export()
+    default_storage.save(filename, ContentFile(content.encode("utf-8")))
+    return filename

commcare_connect/reports/urls.py

@@ -6,4 +6,8 @@
 
 urlpatterns = [
     path("delivery_stats", view=views.DeliveryStatsReportView.as_view(), name="delivery_stats_report"),
+    path("invoice_report", view=views.InvoiceReportView.as_view(), name="invoice_report"),
+    path("export_invoice_report", view=views.export_invoice_report, name="export_invoice_report"),
+    path("export_status/<slug:task_id>", view=views.export_status, name="export_status"),
+    path("download_export/<slug:task_id>", view=views.download_export, name="download_export"),
 ]

commcare_connect/reports/views.py

@@ -1,20 +1,32 @@
 from datetime import date, timedelta
+from urllib.parse import urlencode
 
 import django_filters
 import django_tables2 as tables
 from crispy_forms.helper import FormHelper
-from crispy_forms.layout import Column, Layout, Row
+from crispy_forms.layout import Column, Field, Layout, Row
+from django import forms
+from django.contrib.auth.decorators import login_required, permission_required
+from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin
+from django.db.models import F
+from django.http import HttpResponse
 from django.urls import reverse
 from django.utils.functional import cached_property
+from django.utils.translation import gettext as _
+from django.views.decorators.http import require_GET, require_POST
 from django_filters.views import FilterView
+from django_tables2.views import SingleTableMixin
 
-from commcare_connect.opportunity.models import CompletedWork, DeliveryType, Opportunity
+from commcare_connect.opportunity.models import CompletedWork, DeliveryType, InvoiceStatus, Opportunity, PaymentInvoice
 from commcare_connect.organization.models import Organization
-from commcare_connect.program.models import Program
+from commcare_connect.program.models import ManagedOpportunity, Program
 from commcare_connect.reports.decorators import KPIReportMixin
 from commcare_connect.reports.helpers import get_table_data_for_year_month
-
-from .tables import AdminReportTable
+from commcare_connect.reports.tables import AdminReportTable, InvoiceReportTable
+from commcare_connect.reports.tasks import export_invoice_report_task
+from commcare_connect.utils.celery import download_export_file, render_export_status
+from commcare_connect.utils.permission_const import ALL_ORG_ACCESS
+from commcare_connect.utils.tables import DEFAULT_PAGE_SIZE, get_validated_page_size
 
 COUNTRY_CURRENCY_CHOICES = [
     ("ETB", "Ethiopia"),
@@ -135,3 +147,165 @@ def filter_values(self):
     @property
     def object_list(self):
         return get_table_data_for_year_month(**self.filter_values)
+
+
+class InvoiceReportFilter(django_filters.FilterSet):
+    opportunity_name = django_filters.ModelChoiceFilter(
+        field_name="opportunity",
+        queryset=ManagedOpportunity.objects.only("id", "name"),
+        label=_("Opportunity"),
+        widget=forms.Select(
+            attrs={
+                "data-tomselect": "1",
+                "placeholder": "Select Opportunity (Name - ID)",
+            }
+        ),
+    )
+
+    status = django_filters.MultipleChoiceFilter(
+        choices=InvoiceStatus.choices,
+        label=_("Status"),
+        widget=forms.SelectMultiple(
+            attrs={
+                "data-tomselect": "1",
+                "placeholder": "Select status",
+            }
+        ),
+    )
+
+    from_date = django_filters.DateFilter(
+        field_name="date_paid__date",
+        lookup_expr="gte",
+        label=_("From Payment Date"),
+        widget=forms.DateInput(attrs={"type": "date"}, format="%Y-%m-%d"),
+        required=False,
+        input_formats=["%Y-%m-%d"],
+    )
+
+    to_date = django_filters.DateFilter(
+        field_name="date_paid__date",
+        lookup_expr="lte",
+        label=_("To Payment Date"),
+        widget=forms.DateInput(attrs={"type": "date"}, format="%Y-%m-%d"),
+        required=False,
+        input_formats=["%Y-%m-%d"],
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.filters["opportunity_name"].field.label_from_instance = lambda obj: f"{obj.name} - {obj.id}"
+        self.form.helper = FormHelper()
+        self.form.helper.form_tag = False
+        self.form.helper.disable_csrf = True
+        self.form.helper.layout = Layout(
+            Field("opportunity_name"),
+            Field("status"),
+            Row(
+                Field("from_date"),
+                Field("to_date"),
+                css_class="grid grid-cols-2 gap-4",
+            ),
+        )
+
+    class Meta:
+        model = PaymentInvoice
+        fields = ["opportunity_name", "status", "from_date", "to_date"]
+
+
+class InvoiceReportView(
+    LoginRequiredMixin,
+    PermissionRequiredMixin,
+    SingleTableMixin,
+    FilterView,
+):
+    model = PaymentInvoice
+    table_class = InvoiceReportTable
+    filterset_class = InvoiceReportFilter
+    permission_required = ALL_ORG_ACCESS
+    paginate_by = DEFAULT_PAGE_SIZE
+
+    def get_paginate_by(self, table):
+        return get_validated_page_size(self.request)
+
+    def get_template_names(self):
+        return ["reports/invoice_report.html"]
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["title"] = "Invoice Report"
+        context["task_id"] = self.request.GET.get("task_id")
+
+        if self.filterset:
+            filter_fields = self.filterset.form.fields.keys()
+            context["filters_applied_count"] = sum(
+                1 for key in filter_fields if self.filterset.data.get(key) not in ("", None)
+            )
+        else:
+            context["filters_applied_count"] = 0
+
+        return context
+
+    @classmethod
+    def get_invoice_queryset(cls):
+        return (
+            PaymentInvoice.objects.select_related(
+                "opportunity__managedopportunity__program__organization",
+                "payment",
+            )
+            .annotate(
+                date_paid=F("payment__date_paid"),
+                org_slug=F("opportunity__managedopportunity__program__organization__slug"),
+            )
+            .order_by("-date")
+        )
+
+    def get_queryset(self):
+        return self.get_invoice_queryset()
+
+
+@require_POST
+@login_required
+@permission_required(ALL_ORG_ACCESS, raise_exception=True)
+def export_invoice_report(request):
+    filterset = InvoiceReportFilter(request.POST, queryset=PaymentInvoice.objects.none())
+    if not filterset.is_valid():
+        return HttpResponse("Invalid filters", status=400)
+
+    filters_data = filterset.form.cleaned_data
+    if filters_data.get("opportunity_name"):
+        filters_data["opportunity_name"] = filters_data["opportunity_name"].id
+    if filters_data.get("from_date"):
+        filters_data["from_date"] = filters_data["from_date"].isoformat()
+    if filters_data.get("to_date"):
+        filters_data["to_date"] = filters_data["to_date"].isoformat()
+
+    task = export_invoice_report_task.delay(filters_data)
+
+    #  Build redirect URL preserving applied filters
+    query_params = {k: v for k, v in filters_data.items() if v not in [None, "", []]}
+    query_params["task_id"] = task.id
+    redirect_url = f"{reverse('reports:invoice_report')}?{urlencode(query_params, doseq=True)}"
+    response = HttpResponse(status=204)
+    response["HX-Redirect"] = redirect_url
+    return response
+
+
+@require_GET
+@login_required
+@permission_required(ALL_ORG_ACCESS, raise_exception=True)
+def export_status(request, task_id):
+    return render_export_status(
+        request,
+        task_id=task_id,
+        download_url=reverse("reports:download_export", args=(task_id,)),
+        export_status_url=reverse("reports:export_status", args=(task_id,)),
+        ownership_check=None,
+    )
+
+
+@require_GET
+@login_required
+@permission_required(ALL_ORG_ACCESS, raise_exception=True)
+def download_export(request, task_id):
+    return download_export_file(task_id=task_id, filename_without_ext=f"invoice_export_{request.user.name}")

commcare_connect/templates/components/upload_progress_bar.html

@@ -1,7 +1,7 @@
 <div
   class="flex items-center justify-center"
   {% if not progress.complete %}
-    hx-get="{% url 'opportunity:export_status' request.org.slug task_id %}"
+    hx-get="{{ export_status_url }}"
     hx-trigger="load delay:2s"
     hx-target="this"
     hx-swap="outerHTML"
@@ -34,7 +34,7 @@
     {% if not progress.message %}
       <div>
         <a class="button button-sm text-brand-deep-purple"
-           href="{% url 'opportunity:download_export' request.org.slug task_id %}">
+           href="{{ download_url }}">
           <i class="fa-solid fa-circle-down"></i> Download Export
         </a>
       </div>