CSV export for invoices (#4894)

Fixes #4875

Add CSV export for invoices, implemented in the same way as submission
CSV export.

## Test Steps

 - [ ] Test that CSV exports work

Author: frjo

hypha/apply/funds/templates/funds/includes/table_filter_and_search.html

@@ -49,6 +49,19 @@ <h2 class="section-header">{{ heading }}</h2>
                 </label>
             </form>
         {% endif %}
+
+        {% if invoice_export %}
+            <a
+                class="btn btn-square"
+                hx-get="{% url 'apply:projects:invoice-export-status' %}"
+                hx-swap="outerHTML"
+                hx-target="this"
+                hx-push-url="false"
+                hx-trigger="load"
+            >
+                {% heroicon_mini "arrow-down-tray" %}
+            </a>
+        {% endif %}
     </div>
 {% endif %}
 

hypha/apply/projects/migrations/0107_invoiceexportmanager.py

@@ -0,0 +1,55 @@
+# Generated by Django 5.2.15 on 2026-06-13 15:29
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("application_projects", "0106_project_contract_number"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="InvoiceExportManager",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("export_data", models.TextField()),
+                ("created_time", models.DateTimeField(auto_now_add=True)),
+                ("completed_time", models.DateTimeField(null=True)),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("error", "Failed"),
+                            ("success", "Success"),
+                            ("generating", "In Progress"),
+                        ],
+                        default="generating",
+                    ),
+                ),
+                ("total_export", models.IntegerField(null=True)),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "invoice export manager",
+                "verbose_name_plural": "invoice export managers",
+            },
+        ),
+    ]

hypha/apply/projects/models/__init__.py

@@ -1,4 +1,4 @@
-from .payment import Invoice, InvoiceTag, SupportingDocument
+from .payment import Invoice, InvoiceExportManager, InvoiceTag, SupportingDocument
 from .project import (
     Contract,
     ContractDocumentCategory,
@@ -28,6 +28,7 @@
     "DocumentCategory",
     "ContractDocumentCategory",
     "Invoice",
+    "InvoiceExportManager",
     "InvoiceTag",
     "SupportingDocument",
 ]

hypha/apply/projects/models/payment.py

@@ -7,23 +7,21 @@
 from django.db.models import Q, Sum, Value
 from django.db.models.functions import Coalesce
 from django.urls import reverse
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from viewflow.fsm import State
 
 from hypha.apply.utils.storage import PrivateStorage
 
+EXPORT_STATUS_ERROR = "error"
+EXPORT_STATUS_SUCCESS = "success"
+EXPORT_STATUS_GENERATING = "generating"
 
-class InvoiceTag(models.Model):
-    name = models.CharField(max_length=100, unique=True)
-
-    class Meta:
-        verbose_name = _("invoice tag")
-        verbose_name_plural = _("invoice tags")
-        ordering = ["name"]
-
-    def __str__(self):
-        return self.name
-
+EXPORT_STATUS_CHOICES = [
+    (EXPORT_STATUS_ERROR, _("Failed")),
+    (EXPORT_STATUS_SUCCESS, _("Success")),
+    (EXPORT_STATUS_GENERATING, _("In Progress")),
+]
 
 SUBMITTED = "submitted"
 RESUBMITTED = "resubmitted"
@@ -77,6 +75,18 @@ def invoice_path(instance, filename):
     return f"projects/{instance.project_id}/payment_invoices/{filename}"
 
 
+class InvoiceTag(models.Model):
+    name = models.CharField(max_length=100, unique=True)
+
+    class Meta:
+        verbose_name = _("invoice tag")
+        verbose_name_plural = _("invoice tags")
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+
 class InvoiceQueryset(models.QuerySet):
     def in_progress(self):
         return self.exclude(status__in=[DECLINED, PAID])
@@ -333,3 +343,33 @@ def get_absolute_url(self):
                 "file_pk": self.pk,
             },
         )
+
+
+class InvoiceExportManager(models.Model):
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+    )
+    export_data = models.TextField()
+    created_time = models.DateTimeField(auto_now_add=True)
+    completed_time = models.DateTimeField(null=True)
+    status = models.CharField(
+        choices=EXPORT_STATUS_CHOICES, default=EXPORT_STATUS_GENERATING
+    )
+    total_export = models.IntegerField(null=True)
+
+    class Meta:
+        verbose_name = _("invoice export manager")
+        verbose_name_plural = _("invoice export managers")
+
+    def set_completed_and_save(self) -> None:
+        self.status = EXPORT_STATUS_SUCCESS
+        self.completed_time = timezone.now()
+        self.save()
+
+    def set_failed_and_save(self) -> None:
+        self.status = EXPORT_STATUS_ERROR
+        self.save()
+
+    def get_absolute_url(self) -> str:
+        return reverse("apply:projects:invoices")

hypha/apply/projects/tasks.py

@@ -0,0 +1,62 @@
+from typing import List
+
+from celery import shared_task
+from django.conf import settings
+
+from hypha.apply.projects.models.payment import InvoiceExportManager
+from hypha.apply.projects.utils import export_invoices_to_csv
+from hypha.apply.todo.options import (
+    DOWNLOAD_INVOICES_EXPORT,
+    FAILED_INVOICES_EXPORT,
+)
+from hypha.apply.todo.views import add_task_to_user
+from hypha.apply.users.models import User
+
+
+@shared_task
+def generate_invoice_csv(qs_ids: List[int], request_user_id: int) -> None:
+    """Celery task to generate a CSV file containing the given invoice IDs.
+
+    Updates the user's InvoiceExportManager object with status/final data, then
+    adds a download task to the user's `My Tasks` when completed.
+    """
+    try:
+        from hypha.apply.projects.models.payment import Invoice
+
+        qs = (
+            Invoice.objects.filter(id__in=qs_ids)
+            .select_related("project", "project__user")
+            .prefetch_related("tags")
+        )
+        request_user = User.objects.get(pk=request_user_id)
+
+        if current := InvoiceExportManager.objects.filter(user=request_user):
+            current.delete()
+
+        export_manager = InvoiceExportManager.objects.create(
+            user=request_user, total_export=len(qs_ids)
+        )
+        export_manager.export_data = export_invoices_to_csv(
+            qs.iterator(chunk_size=2000)
+        )
+        export_manager.set_completed_and_save()
+
+        user_task = DOWNLOAD_INVOICES_EXPORT
+
+    except Exception as exc:
+        export_manager.set_failed_and_save()
+        user_task = FAILED_INVOICES_EXPORT
+
+        if settings.SENTRY_DSN:
+            from sentry_sdk import capture_exception
+
+            capture_exception(exc)
+        else:
+            raise exc
+    finally:
+        if not settings.CELERY_TASK_ALWAYS_EAGER:
+            add_task_to_user(
+                code=user_task,
+                user=request_user,
+                related_obj=export_manager,
+            )

hypha/apply/projects/templates/application_projects/invoice_list.html

@@ -1,7 +1,7 @@
 {% extends "base-apply.html" %}
 
 {% load render_table from django_tables2 %}
-{% load i18n static %}
+{% load i18n static heroicons %}
 
 {% block title %}{% trans "Invoices" %}{% endblock %}
 
@@ -18,7 +18,7 @@
     <div class="my-4">
         {% if table %}
             {% trans "invoices" as search_placeholder %}
-            {% include "funds/includes/table_filter_and_search.html" with search_term=search_term use_search=True invoice_batch_actions=True search_placeholder=search_placeholder %}
+            {% include "funds/includes/table_filter_and_search.html" with search_term=search_term use_search=True invoice_batch_actions=True search_placeholder=search_placeholder invoice_export=can_export_invoices %}
             {% render_table table %}
         {% else %}
             <p>{% trans "No Invoices available" %}</p>

hypha/apply/projects/templates/application_projects/partials/export-invoice-button.html

@@ -0,0 +1,81 @@
+{% load i18n heroicons %}
+
+
+{% if not_async %}
+    {% comment %} For sync uses: no polling, just a download after pressing the button {% endcomment %}
+    <a
+        class="btn btn-square"
+        aria-label="{% trans 'Invoices: Export as CSV' %}"
+        href="{{ start_export_url }}"
+        data-tippy-content="{% trans 'Export as CSV' %}"
+        onclick="return confirm('{% blocktrans %}Are you sure you want to export the invoices as a CSV file? This file may contain sensitive information, so please handle it carefully.{% endblocktrans %}')"
+    >
+        {% heroicon_mini "arrow-down-tray" aria_hidden=true %}
+    </a>
+{% else %}
+    {% if generating %}
+        {% comment %} Disabled button used to indicate generation of the CSV is in progress {% endcomment %}
+        <span
+            class="btn btn-square btn-outline"
+            aria-label="{% trans 'Invoices: Generating downloadable CSV' %}"
+            title="{% trans 'Generating downloadable CSV...' %}"
+            data-tippy-content="{% trans 'Generating downloadable CSV...' %}"
+            disabled
+            hx-get="{% url 'apply:projects:invoice-export-status' %}"
+            hx-swap="outerHTML"
+            hx-target="this"
+            hx-trigger="every {{ poll_time }}s"
+            hx-push-url="false"
+            hx-noprog
+        >
+            <span class="loading loading-spinner text-info"></span>
+        </span>
+    {% elif success %}
+        {% comment %} The final download link for the generated CSV {% endcomment %}
+        <a
+            class="btn btn-square btn-primary btn-outline"
+            aria-label="{% trans 'Invoices: Download generated CSV' %}"
+            href="{% url 'apply:projects:invoice-export-download' %}"
+            data-tippy-content="{% trans 'Download generated CSV' %}"
+            hx-get="{% url 'apply:projects:invoice-export-status' %}"
+            hx-swap="outerHTML"
+            hx-target="this"
+            hx-trigger="every 2s"
+            hx-push-url="false"
+            hx-noprog
+        >
+            <span class="flex absolute top-0 right-0 -mt-1 -mr-1 size-3">
+                <span class="inline-flex absolute w-full h-full bg-green-400 rounded-full opacity-75 animate-ping"></span>
+                <span class="inline-flex relative bg-green-500 rounded-full size-3"></span>
+            </span>
+            {% heroicon_mini "arrow-down-tray" aria_hidden=true %}
+        </a>
+
+    {% else %}
+        {% comment %} Button that will begin the generation of the CSV, used to start a generation or retry a failed one {% endcomment %}
+        <button
+            class="btn btn-square"
+            aria-label="{% trans 'Invoices: Generate downloadable CSV' %}"
+            {% if failed %}
+                data-tippy-content="{% trans 'Generation failed, click to retry generating downloadable CSV' %}"
+            {% else %}
+                data-tippy-content="{% trans 'Generate downloadable CSV' %}"
+            {% endif %}
+            hx-get="{{ start_export_url }}"
+            hx-swap="outerHTML"
+            hx-target="this"
+            hx-push-url="false"
+            hx-confirm="{% trans 'Are you sure you want to export the invoices as a CSV file? This file may contain sensitive information, so please handle it carefully.' %}"
+        >
+            {% if not failed %}
+                {% heroicon_mini "arrow-down-tray" aria_hidden=true %}
+            {% else %}
+                <span class="flex absolute top-0 right-0 -mt-1 -mr-1 size-3">
+                    <span class="inline-flex absolute w-full h-full bg-red-400 rounded-full opacity-75 animate-ping"></span>
+                    <span class="inline-flex relative bg-red-500 rounded-full size-3"></span>
+                </span>
+                {% heroicon_mini "exclamation-circle" aria_hidden=true %}
+            {% endif %}
+        </button>
+    {% endif %}
+{% endif %}

hypha/apply/projects/urls.py

@@ -41,6 +41,8 @@
     UploadContractDocumentView,
     UploadContractView,
     UploadDocumentView,
+    invoice_export_download,
+    invoice_export_status,
     partial_contracting_documents,
     partial_get_invoice_detail_actions,
     partial_get_invoice_status,
@@ -62,6 +64,16 @@
     path("all/", ProjectListView.as_view(), name="all"),
     path("reports/", include("hypha.apply.projects.reports.urls"), name="reports"),
     path("invoices/", InvoiceListView.as_view(), name="invoices"),
+    path(
+        "invoices/export-status/",
+        invoice_export_status,
+        name="invoice-export-status",
+    ),
+    path(
+        "invoices/export-download/",
+        invoice_export_download,
+        name="invoice-export-download",
+    ),
     path(
         "all/bulk_invoice_status_update/",
         BatchUpdateInvoiceStatusView.as_view(),