17829 - Implement summary route for statements.

pay-api/src/pay_api/resources/v1/account_statements.py

@@ -37,10 +37,10 @@
 @_jwt.requires_auth
 def get_account_statements(account_id):
     """Get all statements records for an account."""
-    current_app.logger.info('<Aget_account_statements')
+    current_app.logger.info('<get_account_statements')
 
     # Check if user is authorized to perform this action
-    check_auth(business_identifier=None, account_id=account_id, contains_role=EDIT_ROLE, is_premium=True)
+    check_auth(business_identifier=None, account_id=account_id, contains_role=EDIT_ROLE)
 
     page: int = int(request.args.get('page', '1'))
     limit: int = int(request.args.get('limit', '10'))
@@ -60,12 +60,26 @@ def get_account_statement(account_id: str, statement_id: str):
     response_content_type = request.headers.get('Accept', ContentType.PDF.value)
 
     # Check if user is authorized to perform this action
-    auth = check_auth(business_identifier=None, account_id=account_id, contains_role=EDIT_ROLE, is_premium=True)
+    auth = check_auth(business_identifier=None, account_id=account_id, contains_role=EDIT_ROLE)
 
     report, report_name = StatementService.get_statement_report(statement_id=statement_id,
                                                                 content_type=response_content_type, auth=auth)
     response = Response(report, 200)
     response.headers.set('Content-Disposition', 'attachment', filename=report_name)
     response.headers.set('Content-Type', response_content_type)
     response.headers.set('Access-Control-Expose-Headers', 'Content-Disposition')
+    current_app.logger.info('>get_account_statement')
     return response
+
+
+@bp.route('/summary', methods=['GET', 'OPTIONS'])
+@cross_origin(origins='*', methods=['GET'])
+@_tracing.trace()
+@_jwt.requires_auth
+def get_account_statement_summary(account_id: str):
+    """Create the statement report."""
+    current_app.logger.info('<get_account_statement_summary')
+    check_auth(business_identifier=None, account_id=account_id, contains_role=EDIT_ROLE)
+    response, status = StatementService.get_summary(account_id), HTTPStatus.OK
+    current_app.logger.info('>get_account_statement_summary')
+    return jsonify(response), status

pay-api/src/pay_api/services/statement.py

@@ -15,12 +15,17 @@
 from datetime import date, datetime
 
 from flask import current_app
+from sqlalchemy import func
 
+from pay_api.models import db
+from pay_api.models import Invoice as InvoiceModel
+from pay_api.models import PaymentAccount as PaymentAccountModel
 from pay_api.models import Statement as StatementModel
+from pay_api.models import StatementInvoices as StatementInvoicesModel
 from pay_api.models import StatementSchema as StatementModelSchema
-from pay_api.utils.enums import ContentType, StatementFrequency
+from pay_api.utils.enums import ContentType, InvoiceStatus, StatementFrequency
 from pay_api.utils.constants import DT_SHORT_FORMAT
-
+from pay_api.utils.util import get_local_formatted_date
 from .payment import Payment as PaymentService
 
 
@@ -163,3 +168,26 @@ def get_statement_report(statement_id: str, content_type: str, template_name='st
         current_app.logger.debug('>get_statement_report')
 
         return report_response, report_name
+
+    @staticmethod
+    def get_summary(auth_account_id: str):
+        """Get summary for statements by account id."""
+        # This is written outside of the model, because we have multiple model references that need to be included.
+        # If we include these references inside of a model, it runs the risk of having circular dependencies.
+        # It's easier to build out features if our models don't rely on other models.
+        result = db.session.query(func.sum(InvoiceModel.total - InvoiceModel.paid).label('total_due'),
+                                  func.min(InvoiceModel.overdue_date).label('oldest_overdue_date')) \
+            .join(PaymentAccountModel) \
+            .join(StatementInvoicesModel) \
+            .filter(PaymentAccountModel.auth_account_id == auth_account_id) \
+            .filter(InvoiceModel.invoice_status_code == InvoiceStatus.OVERDUE.value) \
+            .filter(StatementInvoicesModel.invoice_id == InvoiceModel.id) \
+            .group_by(InvoiceModel.payment_account_id) \
+            .one_or_none()
+
+        total_due = float(result.total_due) if result else 0
+        oldest_overdue_date = get_local_formatted_date(result.oldest_overdue_date) if result else None
+        return {
+            'total_due': total_due,
+            'oldest_overdue_date': oldest_overdue_date
+        }

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

@@ -17,11 +17,13 @@
 Test-Suite to ensure that the /accounts endpoint is working as expected.
 """
 
+from datetime import datetime
 import json
 
 from pay_api.models import PaymentAccount
 from pay_api.models.invoice import Invoice
-from pay_api.utils.enums import ContentType, StatementFrequency
+from pay_api.utils.enums import ContentType, InvoiceStatus, StatementFrequency
+from pay_api.utils.util import get_local_formatted_date
 from tests.utilities.base_test import (
     factory_statement, factory_statement_invoices, factory_statement_settings, get_claims, get_payment_request,
     token_header)
@@ -222,3 +224,55 @@ def test_get_monthly_statement_report_as_csv(session, client, jwt, app):
     rv = client.get(f'/api/v1/accounts/{pay_account.auth_account_id}/statements/{statement_model.id}',
                     headers=headers)
     assert rv.status_code == 200
+
+
+def test_statement_summary(session, client, jwt, app):
+    """Assert the statement summary is working."""
+    headers = {
+        'Authorization': f'Bearer {jwt.create_jwt(get_claims(), token_header)}',
+        'content-type': 'application/json'
+    }
+
+    # Check if this works without any invoices in OVERDUE.
+    rv = client.post('/api/v1/payment-requests',
+                     data=json.dumps(get_payment_request(business_identifier='CP0002000')),
+                     headers=headers)
+    invoice: Invoice = Invoice.find_by_id(rv.json.get('id'))
+    payment_account_id = invoice.payment_account_id
+    pay_account: PaymentAccount = PaymentAccount.find_by_id(payment_account_id)
+    rv = client.get(f'/api/v1/accounts/{pay_account.auth_account_id}/statements/summary',
+                    headers=headers)
+    assert rv.status_code == 200
+    assert rv.json.get('totalDue') == 0
+    assert rv.json.get('oldestOverdueDate') is None
+
+    # Create multiple OVERDUE invoices and check they add up.
+    total_due = 0
+    payment_account_id = 0
+    invoice_ids = []
+    oldest_overdue_date = datetime.now()
+    for _ in range(5):
+        rv = client.post('/api/v1/payment-requests',
+                         data=json.dumps(get_payment_request(business_identifier='CP0002000')),
+                         headers=headers)
+
+        invoice: Invoice = Invoice.find_by_id(rv.json.get('id'))
+        invoice_ids.append(invoice.id)
+        invoice.invoice_status_code = InvoiceStatus.OVERDUE.value
+        invoice.overdue_date = oldest_overdue_date
+        total_due += invoice.total - invoice.paid
+        invoice.save()
+
+    settings_model = factory_statement_settings(payment_account_id=pay_account.id,
+                                                frequency=StatementFrequency.MONTHLY.value)
+    statement_model = factory_statement(payment_account_id=pay_account.id,
+                                        frequency=StatementFrequency.MONTHLY.value,
+                                        statement_settings_id=settings_model.id)
+    for invoice_id in invoice_ids:
+        factory_statement_invoices(statement_id=statement_model.id, invoice_id=invoice_id)
+
+    rv = client.get(f'/api/v1/accounts/{pay_account.auth_account_id}/statements/summary',
+                    headers=headers)
+    assert rv.status_code == 200
+    assert rv.json.get('totalDue') == float(total_due)
+    assert rv.json.get('oldestOverdueDate') == get_local_formatted_date(oldest_overdue_date)