Merge pull request #3908 from bcgov/369-obligation-reminder

Compliance/Automatic Emails - Reminder of Outstanding Obligation #369

Author: BCerki

bc_obps/common/migrations/0091_reminder_of_obligation_due_email_template.py

@@ -0,0 +1,72 @@
+# Generated by Django 5.1.10 on 2025-10-07 21:57
+
+from django.db import migrations
+
+
+def create_obligation_reminder_template(apps, schema_editor):
+    EmailNotificationTemplate = apps.get_model('common', 'EmailNotificationTemplate')
+    EmailNotificationTemplate.objects.create(
+        name='Reminder of Compliance Obligation Due',
+        subject='BCIERS Reminder – Compliance Obligation Due on November 30th',
+        body='''
+            <p style="text-align: center;">Province of British Columbia</p>
+            <p style="text-align: center;">B.C. Industrial Emissions Reporting System (BCIERS)</p>
+            <br/>
+            <p>Dear {{operator_legal_name}},</p>
+            <br/>
+            <p>This is a reminder to meet your compliance obligation by <b>November 30, {{year_due}}</b>.
+            </p>
+            <br/>
+            <p>Based on our records, <b>{{operation_name}}</b> has an outstanding compliance obligation of {{tonnes_of_co2}} in the amount of {{outstanding_balance}} that must be met using the BC Industrial Emissions Reporting System (BCIERS).
+            </p>
+            <br/>
+            <p>If you have recently submitted payment and/or compliance units, please check that the details provided in your Payment Notification are accurate and that you have paid in full. It may take up to five business days for payments to be processed and reconciled.   </p><br/>
+            <p>If the details in your Payment Notification are correct and you have met your compliance obligation, you may disregard this email. </p><br/>
+            <p>If the payment information does not match the details provided in your Payment Notification email as required in the Payment Instructions available in BCIERS, we cannot process your payment.</p>
+            <br/>
+
+
+
+            <p>If you need to correct the details in your Payment Notification, please contact us at <a href="mailto:OBPSPayments@gov.bc.ca">OBPSPayments@gov.bc.ca</a>.
+            </p>
+            <br/ >
+            <p>To review your compliance obligation, including how it was calculated, log-into BCIERS at <a
+              href="https://industrialemissions.gov.bc.ca/onboarding">https://industrialemissions.gov.bc.ca/onboarding</a>.</p><br/>
+            <p>To meet your compliance obligation:  </p>
+            <ol>
+            <li>Navigate to the Compliance module and click <em>My Compliance > Compliance Summaries</em>.</li>
+            <li>Find your operation in the grid and click <em>Manage Obligation</em>.</li>
+            </ol>
+
+            <p>
+            <b>Please note:</b> Unmet obligations after the payment deadline of November 30 will be subject to daily compounding penalties, as well as interest under the <em>Financial Administration Act</em> (FAA).  </p><br/>
+            <p><b>It may take up to five business days for payments to be processed and reconciled.</b> Once payment is received, BCIERS updates the obligation status accordingly. The Ministry uses the payment date to determine compliance with the deadline and whether a penalty exists. For clarity, the payment date is the date when payment is deposited to the B.C. OBPS bank account. If a payment date is on or before the deadline and processed after the deadline, BCIERS may temporarily show that a penalty exists until the payment is processed and the system refreshes the information. Please refer to the B.C. OBPS compliance module guidance document on our website for further information.  </p><br/ >
+            <p><em>Please do not reply to this email. This email is auto-generated. If you have any questions, or need further assistance, please reach out to our support team at <a href="mailto:GHGRegulator@gov.bc.ca">GHGRegulator@gov.bc.ca</a></em></p>
+            <br/>
+            <p>Best Regards,</p>
+            <p>Ministry of Energy and Climate Solutions</p>
+            <p>Email: <a href="mailto:GHGRegulator@gov.bc.ca">GHGRegulator@gov.bc.ca</a></p>
+            <p>Website: <a href="https://www2.gov.bc.ca/gov/content/environment/climate-change/industry/bc-output-based-pricing-system">BC
+              Government Website Link</a>
+            </p>
+        ''',
+    )
+
+
+def reverse_obligation_reminder_template(apps, schema_editor):
+    EmailNotificationTemplate = apps.get_model('common', 'EmailNotificationTemplate')
+    EmailNotificationTemplate.objects.filter(name='Reminder of Compliance Obligation Due').delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('common', '0090_V4_2_0'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            create_obligation_reminder_template,
+            reverse_obligation_reminder_template,
+            elidable=True,
+        )
+    ]

bc_obps/compliance/emails.py

@@ -144,18 +144,9 @@ def send_notice_of_credits_requested_generated_email(compliance_earned_credit_id
     _send_email_or_raise(template, email_context, recipient_emails)
 
 
-def send_notice_of_obligation_due_email(obligation_id: int) -> None:
-    """
-    Sends an email to every operator's industry user when compliance obligation invoices are generated, notifying that they can now pay their obligation.
-
-     Args:
-       obligation_id: The id of the obligation instance for which to send notification emails.
-    """
+def _prepare_obligation_context(obligation: ComplianceObligation) -> Dict:
     from compliance.service.compliance_report_version_service import ComplianceReportVersionService
 
-    obligation = ComplianceObligation.objects.get(id=obligation_id)
-    template = EmailNotificationTemplateService.get_template_by_name('Notice of Compliance Obligation Due')
-
     report_version = obligation.compliance_report_version
     report = report_version.compliance_report.report
     report_operation = report_version.report_compliance_summary.report_version.report_operation
@@ -169,6 +160,39 @@ def send_notice_of_obligation_due_email(obligation_id: int) -> None:
         "tonnes_of_co2": f"{ComplianceReportVersionService.calculate_outstanding_balance_tco2e(report_version):,.4f}",
         "outstanding_balance": f"${obligation.elicensing_invoice.outstanding_balance:,.2f}",  # type: ignore[union-attr]
     }
+    return email_context
+
+
+def send_notice_of_obligation_due_email(obligation_id: int) -> None:
+    """
+    Sends an email to every operator's industry user when compliance obligation invoices are generated, notifying that they can now pay their obligation.
+
+     Args:
+       obligation_id: The id of the obligation instance for which to send notification emails.
+    """
+
+    obligation = ComplianceObligation.objects.get(id=obligation_id)
+    template = EmailNotificationTemplateService.get_template_by_name('Notice of Compliance Obligation Due')
+
+    email_context = _prepare_obligation_context(obligation)
+
+    _send_email_to_operators_approved_users_or_raise(
+        obligation.compliance_report_version.compliance_report.report.operator, template, email_context
+    )
+
+
+def send_reminder_of_obligation_due_email(obligation_id: int) -> None:
+    """
+    Sends an email to every operator's industry user if an operation hasn't paid its obligation, reminding everyone when the obligation is due.
+
+     Args:
+        obligation_id: The id of the obligation instance for which to send notification emails.
+    """
+
+    obligation = ComplianceObligation.objects.get(id=obligation_id)
+    template = EmailNotificationTemplateService.get_template_by_name('Reminder of Compliance Obligation Due')
+
+    email_context = _prepare_obligation_context(obligation)
 
     _send_email_to_operators_approved_users_or_raise(
         obligation.compliance_report_version.compliance_report.report.operator, template, email_context

bc_obps/compliance/service/elicensing/elicensing_obligation_service.py

@@ -226,3 +226,54 @@ def _get_obligations_for_invoice_generation(
                 'compliance_report_version__compliance_report__compliance_period', 'compliance_report_version'
             )
         )
+
+    @classmethod
+    def _get_obligations_for_reminders(cls, compliance_period: CompliancePeriod) -> QuerySet[ComplianceObligation]:
+        """
+        Get obligations that need reminders for the given compliance period.
+
+        Returns obligations that:
+        1. Belong to the specified compliance period
+        2. Haven't already been paid (outstanding balance > 0)
+        3. Have a status of unmet obligation
+        3. Don't have a void invoice
+        """
+        return ComplianceObligation.objects.filter(
+            compliance_report_version__compliance_report__compliance_period=compliance_period,
+            compliance_report_version__status=ComplianceReportVersion.ComplianceStatus.OBLIGATION_NOT_MET,
+            elicensing_invoice__isnull=False,
+            elicensing_invoice__outstanding_balance__gt=0,
+            elicensing_invoice__is_void=False,
+        ).select_related('compliance_report_version__compliance_report__compliance_period', 'compliance_report_version')
+
+    @classmethod
+    def send_reminders_for_current_period(cls) -> None:
+        """
+        Sends reminders for obligations in the current compliance period
+        that haven't been paid.
+
+        This method:
+        1. Gets the current reporting year
+        2. Finds the corresponding compliance period
+        3. Sends a reminder email for all obligations for that period that have an outstanding balance > 0
+        """
+
+        from service.reporting_year_service import ReportingYearService
+        from compliance.tasks import retryable_send_reminder_of_obligation_due_email
+
+        current_reporting_year = ReportingYearService.get_current_reporting_year()
+
+        try:
+            compliance_period = CompliancePeriod.objects.get(reporting_year=current_reporting_year)
+        except CompliancePeriod.DoesNotExist:
+            logger.warning(f"No compliance period found for reporting year {current_reporting_year.reporting_year}")
+            return
+
+        obligations = cls._get_obligations_for_reminders(compliance_period)
+
+        if not obligations.exists():
+            logger.info("No obligations found that need reminders")
+            return
+
+        for obligation in obligations:
+            retryable_send_reminder_of_obligation_due_email.execute(obligation.id)

bc_obps/compliance/tasks.py

@@ -7,6 +7,7 @@
     send_notice_of_no_obligation_no_credits_generated_email,
     send_notice_of_obligation_due_email,
     send_notice_of_obligation_generated_email,
+    send_reminder_of_obligation_due_email,
 )
 from task_scheduler.service.retry_task.factories import create_retryable
 from task_scheduler.service.scheduled_task.dataclass import ScheduledTaskConfig
@@ -59,6 +60,12 @@
     max_retries=5,
     retry_delay_minutes=10,
 )
+retryable_send_reminder_of_obligation_due_email = create_retryable(
+    func=send_reminder_of_obligation_due_email,
+    tag="obligation_reminder_email_notifications",
+    max_retries=5,
+    retry_delay_minutes=10,
+)
 
 ###################
 # Scheduled tasks #
@@ -88,4 +95,13 @@
         schedule_minute=0,
         tag="invoice_generation",
     ),
+    ScheduledTaskConfig(
+        func=ElicensingObligationService.send_reminders_for_current_period,
+        schedule_type="yearly",
+        schedule_day_of_month=15,
+        schedule_month=11,
+        schedule_hour=4,
+        schedule_minute=0,
+        tag="obligation_reminder",
+    ),
 ]

bc_obps/compliance/tests/service/elicensing/test_elicensing_obligation_service.py

@@ -570,3 +570,167 @@ def test_generate_invoices_for_current_period__single_obligation(
 
         assert mock_handle_integration.call_count == 1
         mock_handle_integration.assert_called_once_with(999, cp)
+
+    @patch("service.reporting_year_service.ReportingYearService.get_current_reporting_year")
+    @patch(
+        "compliance.service.elicensing.elicensing_obligation_service.ElicensingObligationService._get_obligations_for_reminders"
+    )
+    @patch('compliance.tasks.retryable_send_reminder_of_obligation_due_email.execute')
+    def test_send_reminders_for_current_period__happy_path(
+        self,
+        mock_retryable_send_reminder_of_obligation_email,
+        mock_get_obligations_for_reminders,
+        mock_get_current_reporting_year,
+    ):
+
+        ry = ReportingYear.objects.get(reporting_year=2024)
+        cp, created = CompliancePeriod.objects.get_or_create(
+            reporting_year=ry,
+            defaults={"invoice_generation_date": date(2024, 11, 1)},
+        )
+        obligations = _FauxQueryset([MagicMock(id=101), MagicMock(id=202)])
+        mock_get_current_reporting_year.return_value = ry
+        mock_get_obligations_for_reminders.return_value = obligations
+
+        # Act
+        ElicensingObligationService.send_reminders_for_current_period()
+
+        # Assert
+        mock_get_current_reporting_year.assert_called_once()
+        mock_get_obligations_for_reminders.assert_called_once_with(cp)
+
+        assert mock_retryable_send_reminder_of_obligation_email.call_count == 2
+        mock_retryable_send_reminder_of_obligation_email.assert_any_call(101)
+        mock_retryable_send_reminder_of_obligation_email.assert_any_call(202)
+
+    @patch("service.reporting_year_service.ReportingYearService.get_current_reporting_year")
+    @patch(
+        "compliance.service.elicensing.elicensing_obligation_service.ElicensingObligationService._get_obligations_for_reminders"
+    )
+    @patch('compliance.tasks.retryable_send_reminder_of_obligation_due_email.execute')
+    def test_send_reminders_for_current_period__no_compliance_period_found(
+        self,
+        mock_retryable_send_reminder_of_obligation_email,
+        mock_get_obligations_for_reminders,
+        mock_get_current_reporting_year,
+    ):
+        """
+        Test case: No compliance period exists for the current reporting year
+        - Should return early
+        - Should not call subsequent methods
+        """
+        # Arrange
+        ry = ReportingYear.objects.get(reporting_year=2024)
+        mock_get_year.return_value = ry
+
+        # Ensure no compliance period exists for this reporting year
+        CompliancePeriod.objects.filter(reporting_year=ry).delete()
+
+        obligations = _FauxQueryset([MagicMock(id=101), MagicMock(id=202)])
+        mock_get_current_reporting_year.return_value = ry
+        mock_get_obligations_for_reminders.return_value = obligations
+
+        # Act
+
+        ElicensingObligationService.send_reminders_for_current_period()
+
+        # Assert
+        mock_get_current_reporting_year.assert_called_once()
+        mock_get_obligations_for_reminders.assert_not_called()
+        mock_retryable_send_reminder_of_obligation_email.assert_not_called()
+
+    @patch("service.reporting_year_service.ReportingYearService.get_current_reporting_year")
+    @patch(
+        "compliance.service.elicensing.elicensing_obligation_service.ElicensingObligationService._get_obligations_for_reminders"
+    )
+    @patch('compliance.tasks.retryable_send_reminder_of_obligation_due_email.execute')
+    def test_send_reminders_for_current_period__no_obligations_found(
+        self,
+        mock_retryable_send_reminder_of_obligation_email,
+        mock_get_obligations_for_reminders,
+        mock_get_current_reporting_year,
+    ):
+        """
+        Test case: No obligations found that need reminders
+        - Should return early
+        - Should not send emails
+        """
+        # Arrange
+        ry = ReportingYear.objects.get(reporting_year=2024)
+        cp, created = CompliancePeriod.objects.get_or_create(
+            reporting_year=ry,
+            defaults={"invoice_generation_date": date(2024, 11, 1)},
+        )
+
+        empty_obligations = _FauxQueryset([])  # Empty queryset
+
+        mock_get_current_reporting_year.return_value = ry
+        mock_get_obligations_for_reminders.return_value = empty_obligations
+
+        # Act
+
+        ElicensingObligationService.send_reminders_for_current_period()
+
+        # Assert
+        mock_get_current_reporting_year.assert_called_once()
+        mock_get_obligations_for_reminders.assert_called_once_with(cp)
+
+        # Assert
+        mock_get_current_reporting_year.assert_called_once()
+        mock_get_obligations_for_reminders.assert_called_once_with(cp)
+        mock_retryable_send_reminder_of_obligation_email.assert_not_called()
+
+    def test_get_obligations_for_reminders(self):
+        ry_2024 = ReportingYear.objects.get(reporting_year=2024)
+        cp_2024, created = CompliancePeriod.objects.get_or_create(
+            reporting_year=ry_2024,
+            defaults={"invoice_generation_date": date(2024, 11, 1)},
+        )
+        ry_2025 = ReportingYear.objects.get(reporting_year=2025)
+        cp_2025 = make_recipe(
+            'compliance.tests.utils.compliance_period',
+            start_date="2025-01-01",
+            end_date="2025-12-31",
+            compliance_deadline="2026-06-30",
+            invoice_generation_date="2026-11-01",
+            reporting_year=ry_2025,
+        )
+
+        # 2024 obligations with outstanding balances - should all be returned
+        for i in range(1, 5):
+            cr = make_recipe('compliance.tests.utils.compliance_report', compliance_period=cp_2024)
+            crv = make_recipe('compliance.tests.utils.compliance_report_version', compliance_report=cr)
+            invoice = make_recipe('compliance.tests.utils.elicensing_invoice', outstanding_balance=Decimal(i + 100))
+            make_recipe(
+                'compliance.tests.utils.compliance_obligation',
+                compliance_report_version=crv,
+                elicensing_invoice=invoice,
+            )
+
+        # obligation with 0 outstanding balance - should not be returned
+        cr_0 = make_recipe('compliance.tests.utils.compliance_report', compliance_period=cp_2024)
+        crv_0 = make_recipe('compliance.tests.utils.compliance_report_version', compliance_report=cr_0)
+        invoice_0 = make_recipe('compliance.tests.utils.elicensing_invoice', outstanding_balance=Decimal(0))
+        make_recipe(
+            'compliance.tests.utils.compliance_obligation',
+            compliance_report_version=crv_0,
+            elicensing_invoice=invoice_0,
+        )
+
+        # obligation with no invoice - should not be returned
+        cr_none = make_recipe('compliance.tests.utils.compliance_report', compliance_period=cp_2024)
+        crv_none = make_recipe('compliance.tests.utils.compliance_report_version', compliance_report=cr_none)
+        make_recipe('compliance.tests.utils.compliance_obligation', compliance_report_version=crv_none)
+
+        # obligation in a different compliance period - should not be returned
+        cr_2025 = make_recipe('compliance.tests.utils.compliance_report', compliance_period=cp_2025)
+        crv_2025 = make_recipe('compliance.tests.utils.compliance_report_version', compliance_report=cr_2025)
+        invoice_2025 = make_recipe('compliance.tests.utils.elicensing_invoice', outstanding_balance=Decimal(0))
+        make_recipe(
+            'compliance.tests.utils.compliance_obligation',
+            compliance_report_version=crv_2025,
+            elicensing_invoice=invoice_2025,
+        )
+
+        obligations = ElicensingObligationService._get_obligations_for_reminders(cp_2024)
+        assert obligations.count() == 4