From c2ef469d5d731b8d0cbeb04ac29e6a8df6cc5f3d Mon Sep 17 00:00:00 2001 From: Joe Banks Date: Sun, 27 Oct 2024 13:11:42 +0000 Subject: [PATCH] Finance dashboard (#600) * Enable commas for float thousands separation * Add new invoice dashboard template * Add new view controller for finance dashboard * Add finance dashboard to dropdown * Update finance URLs to put dashboard at index route * Add payment methods to generated sample data * Flip 'outstanding' and 'waiting' cards on dashboard to match order in dropdown Also made them link to their respective lists and fixed low text contrast --------- Co-authored-by: FreneticScribbler --- PyRIGS/settings.py | 2 + .../commands/generateSampleRIGSData.py | 2 +- RIGS/templates/base_rigs.html | 1 + RIGS/templates/invoice_dashboard.html | 105 ++++++++++++++++++ RIGS/urls.py | 3 +- RIGS/views/finance.py | 72 +++++++++++- 6 files changed, 181 insertions(+), 4 deletions(-) create mode 100644 RIGS/templates/invoice_dashboard.html diff --git a/PyRIGS/settings.py b/PyRIGS/settings.py index 20d1ac1f..5116440a 100644 --- a/PyRIGS/settings.py +++ b/PyRIGS/settings.py @@ -224,6 +224,8 @@ USE_L10N = True USE_TZ = True +USE_THOUSAND_SEPARATOR = True + # Need to allow seconds as datetime-local input type spits out a time that has seconds DATETIME_INPUT_FORMATS = ('%Y-%m-%dT%H:%M', '%Y-%m-%dT%H:%M:%S') diff --git a/RIGS/management/commands/generateSampleRIGSData.py b/RIGS/management/commands/generateSampleRIGSData.py index 0f89cc07..b8331891 100644 --- a/RIGS/management/commands/generateSampleRIGSData.py +++ b/RIGS/management/commands/generateSampleRIGSData.py @@ -254,7 +254,7 @@ class Command(BaseCommand): new_invoice.void = True elif random.randint(0, 2) > 1: # 1 in 3 have been paid models.Payment.objects.create(invoice=new_invoice, amount=new_invoice.balance, - date=datetime.date.today()) + date=datetime.date.today(), method=random.choice(models.Payment.METHODS)[0]) if i == 1 or random.randint(0, 5) > 0: # Event 1 and 1 in 5 have a RA models.RiskAssessment.objects.create(event=new_event, supervisor_consulted=bool(random.getrandbits(1)), nonstandard_equipment=bool(random.getrandbits(1)), diff --git a/RIGS/templates/base_rigs.html b/RIGS/templates/base_rigs.html index 16d06ba9..68a27e8e 100644 --- a/RIGS/templates/base_rigs.html +++ b/RIGS/templates/base_rigs.html @@ -45,6 +45,7 @@ Invoices {{ todo }}
+ Dashboard {% if perms.RIGS.add_invoice %} Waiting {{ waiting }} {% endif %} diff --git a/RIGS/templates/invoice_dashboard.html b/RIGS/templates/invoice_dashboard.html new file mode 100644 index 00000000..5086d555 --- /dev/null +++ b/RIGS/templates/invoice_dashboard.html @@ -0,0 +1,105 @@ +{% extends 'base_rigs.html' %} + +{% block content %} + +
+
+
+ + +
+
+
+ + + +

Overview

+ + + +
+
+ +
+
Total Waiting
+

£{{ total_waiting|floatformat:2 }}

+
+ +
+
+ +
+
Total Outstanding
+

£{{ total_outstanding|floatformat:2 }}

+
+ +
+
+
+
Total Events
+

{{ total_events }}

+
+
+
+
+
Total Invoices
+

{{ total_invoices }}

+
+
+
+ +
+ +

Payments

+ +
+ +

Sources

+ +
+ +{% for source in payment_methods %} +
+
+
{{ source.method }}
+

£{{ source.total|floatformat:2 }}

+
+
+{% endfor %} + +
+ +

Total

+ +
+ +
+
+
Total Income
+

£{{ total_income|floatformat:2 }}

+
+
+ +
+ +

Invoice Payment Time

+ +
+ +
+
+
Average Time to Pay
+

{{ mean_invoice_to_payment|floatformat:2 }} days

+
+
+ +{% endblock %} diff --git a/RIGS/urls.py b/RIGS/urls.py index 5c263c48..6c5682ca 100644 --- a/RIGS/urls.py +++ b/RIGS/urls.py @@ -115,7 +115,8 @@ urlpatterns = [ path('event/webhook/', views.RecieveForumWebhook.as_view(), name='webhook_recieve'), # Finance - path('invoice/', permission_required_with_403('RIGS.view_invoice')(views.InvoiceIndex.as_view()), + path('invoice/', permission_required_with_403('RIGS.view_invoice')(views.InvoiceDashboard.as_view()), name='invoice_dashboard'), + path('invoice/outstanding', permission_required_with_403('RIGS.view_invoice')(views.InvoiceOutstanding.as_view()), name='invoice_list'), path('invoice/archive/', permission_required_with_403('RIGS.view_invoice')(views.InvoiceArchive.as_view()), name='invoice_archive'), diff --git a/RIGS/views/finance.py b/RIGS/views/finance.py index 405de166..997519b7 100644 --- a/RIGS/views/finance.py +++ b/RIGS/views/finance.py @@ -5,7 +5,7 @@ import reversion from django import forms from django.contrib import messages from django.db import transaction -from django.db.models import Q +from django.db.models import Sum from django.http import Http404, HttpResponseRedirect from django.http import HttpResponse from django.shortcuts import get_object_or_404 @@ -18,8 +18,76 @@ from RIGS import models forms.DateField.widget = forms.DateInput(attrs={'type': 'date'}) +TIME_FILTERS = ["all", "year", "month", "week"] -class InvoiceIndex(generic.ListView): + +def days_between(d1, d2): + diff = d2 - d1 + return diff.total_seconds() / datetime.timedelta(days=1).total_seconds() + + +class InvoiceDashboard(generic.TemplateView): + template_name = 'invoice_dashboard.html' + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context['page_title'] = "Invoice Dashboard" + context['description'] = "Overview of financial status of TEC rigs." + + time_filter = self.request.GET.get('time_filter', 'all') + + if time_filter not in TIME_FILTERS: + time_filter = 'all' + + if time_filter == 'all': + context['events'] = models.Event.objects.all() + context['invoices'] = models.Invoice.objects.all() + context['payments'] = models.Payment.objects.all() + elif time_filter == 'year': + context['events'] = models.Event.objects.filter(start_date__gte=datetime.date.today() - datetime.timedelta(days=365)) + context['invoices'] = models.Invoice.objects.filter(invoice_date__gte=datetime.date.today() - datetime.timedelta(days=365)) + context['payments'] = models.Payment.objects.filter(date__gte=datetime.date.today() - datetime.timedelta(days=365)) + elif time_filter == 'month': + context['events'] = models.Event.objects.filter(start_date__gte=datetime.date.today() - datetime.timedelta(days=30)) + context['invoices'] = models.Invoice.objects.filter(invoice_date__gte=datetime.date.today() - datetime.timedelta(days=30)) + context['payments'] = models.Payment.objects.filter(date__gte=datetime.date.today() - datetime.timedelta(days=30)) + elif time_filter == 'week': + context['events'] = models.Event.objects.filter(start_date__gte=datetime.date.today() - datetime.timedelta(days=7)) + context['invoices'] = models.Invoice.objects.filter(invoice_date__gte=datetime.date.today() - datetime.timedelta(days=7)) + context['payments'] = models.Payment.objects.filter(date__gte=datetime.date.today() - datetime.timedelta(days=7)) + + context["time_filter"] = time_filter + + context['total_outstanding'] = sum([i.balance for i in models.Invoice.objects.outstanding_invoices()]) + context['total_waiting'] = sum([i.sum_total for i in models.Event.objects.waiting_invoices()]) + context['total_events'] = len(context['events']) + context['total_invoices'] = len(context['invoices']) + context['total_payments'] = len(context['payments']) + + payment_methods = dict(models.Payment.METHODS) + + context['payment_methods'] = context["payments"].values('method').annotate(total=Sum('amount')).order_by('method') + + for method in context['payment_methods']: + method['method'] = payment_methods.get(method['method'], f"Unknown method ({method['method']})") + + context["total_income"] = sum([i['total'] for i in context['payment_methods']]) + + payments = context['payments'] + mean_duration = 0 + + for payment in payments: + mean_duration += days_between(payment.invoice.invoice_date, payment.date) + + if len(payments) > 0: + mean_duration /= len(payments) + + context['mean_invoice_to_payment'] = mean_duration + + return context + + +class InvoiceOutstanding(generic.ListView): model = models.Invoice template_name = 'invoice_list.html'