Update requirements.txt / clean up to use shared code now moved to pa…

…y-api eft service

queue_services/payment-reconciliations/requirements.txt

@@ -1,6 +1,6 @@
 -e git+https://github.com/bcgov/lear.git@30dba30463c99aaedfdcfd463213e71ba0d35b51#egg=entity_queue_common&subdirectory=queue_services/common
 -e git+https://github.com/bcgov/sbc-common-components.git@b93585ea3ac273b9e51c4dd5ddbc8190fd95da6a#egg=sbc_common_components&subdirectory=python
--e git+https://github.com/bcgov/sbc-pay.git@1a1cb0c7b00978a36aed7c0e9d7bcd7148e0401a#egg=pay_api&subdirectory=pay-api
+-e git+https://github.com/bcgov/sbc-pay.git@951df024496956194ecdfb68325f3631d5db0808#egg=pay_api&subdirectory=pay-api
 Flask-Caching==2.0.2
 Flask-Migrate==2.7.0
 Flask-Moment==1.0.5

queue_services/payment-reconciliations/src/reconciliations/eft/eft_reconciliation.py

@@ -31,20 +31,17 @@
 
 from _decimal import Decimal
 from entity_queue_common.service_utils import logger
-from flask import current_app
 from pay_api import db
 from pay_api.factory.payment_system_factory import PaymentSystemFactory
 from pay_api.models import EFTCredit as EFTCreditModel
 from pay_api.models import EFTFile as EFTFileModel
 from pay_api.models import EFTShortnames as EFTShortnameModel
 from pay_api.models import EFTTransaction as EFTTransactionModel
 from pay_api.models import Invoice as InvoiceModel
-from pay_api.models import InvoiceReference as InvoiceReferenceModel
-from pay_api.models import Payment as PaymentModel
 from pay_api.models import PaymentAccount as PaymentAccountModel
-from pay_api.models import Receipt as ReceiptModel
-from pay_api.utils.enums import (
-    EFTFileLineType, EFTProcessStatus, InvoiceReferenceStatus, InvoiceStatus, PaymentMethod, PaymentStatus)
+from pay_api.services.eft_service import EftService as EFTService
+from pay_api.services.eft_short_names import EFTShortnames
+from pay_api.utils.enums import EFTFileLineType, EFTProcessStatus, InvoiceStatus, PaymentMethod
 from sentry_sdk import capture_message
 
 from reconciliations.eft import EFTHeader, EFTRecord, EFTTrailer
@@ -64,7 +61,7 @@ async def reconcile_eft_payments(msg: Dict[str, any]):  # pylint: disable=too-ma
     6: Calculate total transaction balance per short name - dictionary
     7: Apply balance to outstanding EFT invoices - Update invoice paid amount and status, create payment,
         invoice reference, and receipt
-    8: Create EFT Credit records
+    8: Create EFT Credit records for left over balances
     9: Finalize and complete
     """
     # Fetch EFT File
@@ -260,14 +257,13 @@ def _process_eft_payments(shortname_balance: Dict, eft_file: EFTFileModel) -> bo
             try:
                 auth_account_id = eft_shortname_model.auth_account_id
                 # Find invoices to be paid
-                invoices: List[InvoiceModel] = _get_invoices_owing(auth_account_id)
+                invoices: List[InvoiceModel] = EFTShortnames.get_invoices_owing(auth_account_id)
                 payment_account: PaymentAccountModel = PaymentAccountModel.find_by_auth_account_id(auth_account_id)
                 if invoices is not None:
                     for invoice in invoices:
                         _pay_invoice(payment_account=payment_account,
                                      invoice=invoice,
-                                     shortname_balance=shortname_balance[shortname],
-                                     receipt_number=invoice.id)
+                                     shortname_balance=shortname_balance[shortname])
 
             except Exception as e:  # NOQA pylint: disable=broad-exception-caught
                 has_eft_transaction_errors = True
@@ -431,8 +427,7 @@ def _shortname_balance_as_dict(eft_transactions: List[EFTRecord]) -> Dict:
     return shortname_balance
 
 
-def _pay_invoice(payment_account: PaymentAccountModel, invoice: InvoiceModel, shortname_balance: Dict,
-                 receipt_number=None):
+def _pay_invoice(payment_account: PaymentAccountModel, invoice: InvoiceModel, shortname_balance: Dict):
     """Pay for an invoice and update invoice state."""
     payment_date = shortname_balance.get('transaction_date') or datetime.now()
     balance = shortname_balance.get('balance')
@@ -455,50 +450,23 @@ def _pay_invoice(payment_account: PaymentAccountModel, invoice: InvoiceModel, sh
     db.session.add(invoice)
 
     # Create the payment record
-    payment = _save_payment(payment_account=payment_account,
-                            invoice=invoice,
-                            payment_date=payment_date,
-                            paid_amount=payable_amount)
+    eft_payment_service: EFTService = PaymentSystemFactory.create_from_payment_method(PaymentMethod.EFT.value)
+    payment = eft_payment_service.create_payment(payment_account=payment_account,
+                                                 invoice=invoice,
+                                                 payment_date=payment_date,
+                                                 paid_amount=payable_amount)
 
-    invoice_reference = InvoiceReferenceModel()
-    invoice_reference.invoice_id = invoice.id
-    invoice_reference.status_code = InvoiceReferenceStatus.ACTIVE.value
-    invoice_reference.invoice_number = payment.invoice_number
+    invoice_reference = EFTService.create_invoice_reference(invoice=invoice, payment=payment)
+    receipt = EFTService.create_receipt(invoice=invoice, payment=payment)
 
+    db.session.add(payment)
     db.session.add(invoice_reference)
-
-    # Create Receipt records
-    receipt: ReceiptModel = ReceiptModel()
-    receipt.receipt_date = payment_date
-    receipt.receipt_amount = payable_amount
-    receipt.invoice_id = invoice.id
-    receipt.receipt_number = receipt_number
     db.session.add(receipt)
 
     # Paid - update the shortname balance
     shortname_balance['balance'] -= payable_amount
 
 
-def _save_payment(payment_account: PaymentAccountModel, invoice: InvoiceModel, payment_date: datetime,
-                  paid_amount, receipt_number=None) -> PaymentModel:
-    """Create a payment record for an invoice."""
-    pay_service = PaymentSystemFactory.create_from_payment_method(PaymentMethod.EFT.value)
-
-    payment = PaymentModel()
-    payment.payment_method_code = pay_service.get_payment_method_code()
-    payment.payment_status_code = PaymentStatus.COMPLETED.value
-    payment.payment_system_code = pay_service.get_payment_system_code()
-    payment.invoice_number = f'{current_app.config["EFT_INVOICE_PREFIX"]}{invoice.id}'
-    payment.invoice_amount = invoice.total
-    payment.payment_account_id = payment_account.id
-    payment.payment_date = payment_date
-    payment.paid_amount = paid_amount
-    payment.receipt_number = receipt_number
-    db.session.add(payment)
-
-    return payment
-
-
 def _get_invoice_unpaid_total(invoice: InvoiceModel) -> Decimal:
     invoice_total = invoice.total or 0
     invoice_paid = invoice.paid or 0

queue_services/payment-reconciliations/tests/integration/test_eft_reconciliation.py

@@ -270,7 +270,7 @@ async def test_eft_tdi17_basic_process(session, app, stan_server, event_loop, cl
     assert eft_file_model.number_of_details == 5
     assert eft_file_model.total_deposit_cents == 3733750
 
-    # Partial as shortname is not mapped to an account
+    # Complete - short name is not mapped but credited
     assert eft_file_model.status_code == EFTProcessStatus.COMPLETED.value
 
     # Stored as part of the EFT File record - expecting none when no errors
@@ -420,15 +420,16 @@ async def test_eft_tdi17_process(session, app, stan_server, event_loop, client_i
     assert payment.payment_status_code == PaymentStatus.COMPLETED.value
     assert payment.payment_method_code == PaymentMethod.EFT.value
     assert payment.invoice_amount == expected_amount
+    assert payment.paid_amount == expected_amount
 
     invoice_reference: InvoiceReferenceModel = InvoiceReferenceModel\
-        .find_by_invoice_id_and_status(invoice.id, InvoiceReferenceStatus.ACTIVE.value)
+        .find_by_invoice_id_and_status(invoice.id, InvoiceReferenceStatus.COMPLETED.value)
 
     assert invoice_reference is not None
     assert invoice_reference.invoice_id == invoice.id
     assert invoice_reference.invoice_number == payment.invoice_number
     assert invoice_reference.invoice_number == expected_invoice_number
-    assert invoice_reference.status_code == InvoiceReferenceStatus.ACTIVE.value
+    assert invoice_reference.status_code == InvoiceReferenceStatus.COMPLETED.value
 
     eft_credits: List[EFTCreditModel] = db.session.query(EFTCreditModel).all()
     assert eft_credits is not None
@@ -575,13 +576,13 @@ async def test_eft_tdi17_rerun(session, app, stan_server, event_loop, client_id,
     assert payment.invoice_amount == expected_amount
 
     invoice_reference: InvoiceReferenceModel = InvoiceReferenceModel \
-        .find_by_invoice_id_and_status(invoice.id, InvoiceReferenceStatus.ACTIVE.value)
+        .find_by_invoice_id_and_status(invoice.id, InvoiceReferenceStatus.COMPLETED.value)
 
     assert invoice_reference is not None
     assert invoice_reference.invoice_id == invoice.id
     assert invoice_reference.invoice_number == payment.invoice_number
     assert invoice_reference.invoice_number == expected_invoice_number
-    assert invoice_reference.status_code == InvoiceReferenceStatus.ACTIVE.value
+    assert invoice_reference.status_code == InvoiceReferenceStatus.COMPLETED.value
 
     eft_credits: List[EFTCreditModel] = db.session.query(EFTCreditModel).all()
     assert eft_credits is not None