Add in disbursement reversal date for CSO (bcgov#1680)

docs/docs/api_contract/pay-api.yaml

@@ -5,7 +5,7 @@ info:
     <p>BC Registries Pay system is used by the BC Registries account services and integrated systems to create payment transactions to pay for the products purchased. This abstracts the integrated systems from the underlying payment integrations and payment methods. <br/>
     With this API you can submit the following transactions:<ul><li>Create payment transactions</li><li>Get payment status</li><li>Delete unpaid payment transactions</li><li>Generate PDF receipt</li><li>Retrieve account statements</li><li>Generate account transactions reports</li></ul>
     <p>All requests must include an Account ID.</p>
-  version: 1.0.6
+  version: 1.0.7
   contact:
     name: BC Registries
 paths:
@@ -1617,6 +1617,9 @@ components:
         disbursementDate:
           type: string
           description: date when disbursement status code was set
+        disbursementReversalDate:
+          type: string
+          description: date when disbursement reversal status code was set
         overdueDate:
           type: string
           description: date when payment is overdue (EFT / ONLINE_BANKING)

pay-api/src/pay_api/models/invoice.py

@@ -291,6 +291,7 @@ class InvoiceSearchModel:  # pylint: disable=too-few-public-methods, too-many-in
     payment_date: datetime
     refund_date: datetime
     disbursement_date: datetime
+    disbursement_reversal_date: datetime
     # Add disbursement_reversal_date when CSO is prepared.
 
     @classmethod
@@ -321,4 +322,5 @@ def from_row(cls, row):
                    payment_date=row.payment_date,
                    refund_date=row.refund_date,
                    disbursement_date=row.disbursement_date,
+                   disbursement_reversal_date=row.disbursement_reversal_date,
                    invoice_number=invoice_number)

pay-api/src/pay_api/models/payment.py

@@ -227,6 +227,7 @@ def search_purchase_history(cls,  # noqa:E501; pylint:disable=too-many-arguments
                           Invoice.filing_id,
                           Invoice.bcol_account,
                           Invoice.disbursement_date,
+                          Invoice.disbursement_reversal_date,
                           Invoice.overdue_date
                           ),
                 contains_eager(Invoice.payment_line_items)

pay-api/src/pay_api/version.py

@@ -22,4 +22,4 @@
 Development release segment: .devN
 """
 
-__version__ = '1.21.7'  # pylint: disable=invalid-name
+__version__ = '1.21.8'  # pylint: disable=invalid-name

pay-api/tests/unit/api/test_account.py

@@ -17,6 +17,7 @@
 Test-Suite to ensure that the /accounts endpoint is working as expected.
 """
 
+from datetime import datetime, timezone
 import json
 from unittest.mock import patch
 
@@ -54,6 +55,10 @@ def test_account_purchase_history(session, client, jwt, app):
     invoice: Invoice = Invoice.find_by_id(rv.json.get('id'))
     pay_account: PaymentAccount = PaymentAccount.find_by_id(invoice.payment_account_id)
 
+    invoice.disbursement_date = datetime.now(tz=timezone.utc)
+    invoice.disbursement_reversal_date = datetime.now(tz=timezone.utc)
+    invoice.save()
+
     rv = client.post(f'/api/v1/accounts/{pay_account.auth_account_id}/payments/queries', data=json.dumps({}),
                      headers=headers)
 
@@ -64,7 +69,7 @@ def test_account_purchase_history(session, client, jwt, app):
     assert invoice
     required_fields = ['id', 'corpTypeCode', 'createdOn', 'statusCode', 'total', 'serviceFees',
                        'paid', 'refund', 'folioNumber', 'createdName', 'paymentMethod', 'details',
-                       'businessIdentifier', 'createdBy', 'filingId']
+                       'businessIdentifier', 'createdBy', 'filingId', 'disbursementReversalDate', 'disbursementDate']
 
     for field in required_fields:
         assert field in invoice