{% include "financialInputs/cashBalance.html" %}
diff --git a/blocnote/apps/financialInputs/urls.py b/blocnote/apps/financialInputs/urls.py
index 0a0786b2d955a1ac33643c16746046b69f58b7ba..8856aed8d065ed1e90ccf7034c71e7d213bb24e7 100644
--- a/blocnote/apps/financialInputs/urls.py
+++ b/blocnote/apps/financialInputs/urls.py
@@ -10,4 +10,5 @@ urlpatterns = [
url(r'^customer-preference/$', views.CustomerPreferenceView.as_view(), name='customer_preference'),
url(r'^liabilities/$', views.LiabilitiesTable.as_view(), name='liabilities'),
url(r'^cash-balance/$', views.CashBalanceView.as_view(), name='cash_balance'),
+ url(r'^income-statement/$', views.IncomeStatementTable.as_view(), name='income_statement'),
]
diff --git a/blocnote/apps/financialInputs/views.py b/blocnote/apps/financialInputs/views.py
index ea50b691b20d80b64c65d24955c75edb6fec2956..67fc7bf1fba3dc67012e7d05e35dc77b566abf10 100644
--- a/blocnote/apps/financialInputs/views.py
+++ b/blocnote/apps/financialInputs/views.py
@@ -6,9 +6,10 @@ from django.views import View
from datetime import date
from bpfin.utilbills.bill_backend_call import bill_prior_proj_rough_annual
-from bpfin.financials.cash_balance import cash_balance
+from bpfin.financials.financial_lib import organize_bill_overview
+from bpfin.financials.financial_lib import Income_Statement_Table
-from .models import FinancingOverview, Bills, BillsOverview, CustomerPreference, EstimationAlgorithm, Liabilities, CashBalance
+from .models import FinancingOverview, Bills, BillsOverview, CustomerPreference, EstimationAlgorithm, Liabilities, CashBalance, IncomeStatement
from .forms import BlocNoteHeaderForm
@@ -745,3 +746,204 @@ class CashBalanceView(View):
)
return JsonResponse({'instance': 'OK'})
+
+class IncomeStatementTable(View):
+ """Income Statement table.
+
+ Store income statement data. Calculate historical income statement information and one year in the future.
+ Calculate the average of the historical year and the one future year and display in a new column.
+ """
+
+ model = IncomeStatement
+
+ def convert_response_format(self, put):
+ """Convert PUT body format.
+
+ Convert the data in HTTP PUT request into format accepted by bpfin. Obtain the growth rate as well.
+
+ Args:
+ put: HTTP PUT request from frontend.
+
+ Returns:
+ result: Dictionary with year as key and income statement information dictionary as value.
+ growth rate: The selected growth rate to project the future income statement.
+ """
+ result = {}
+ for record in put:
+ if 'growth-rate' not in record:
+ value = {}
+ value['revenue'] = float(record['revenue'])
+ value['utility_expense'] = float(record['utility-expense'])
+ value['non_utility_expense'] = float(record['non-utility-operating-expense'])
+ result[int(record['year'])] = value
+ else:
+ growth_rate = float(record['growth-rate'])
+ return result, growth_rate
+
+ def get_bills_overview_data(self, building_id):
+ """Get Bills overview table data.
+
+ Query the database to get bills overview data.
+
+ Args:
+ building_id: id of the building.
+
+ Returns:
+ bill_overview: A dictionary with utility as key and value a list. This list contains the first element
+ a dictionary with key the year and value the charge for that particular year(actual or
+ projected). The second element is the flag which is true if the utility bill does exist.
+ """
+ objs = BillsOverview.objects.filter(building_id=building_id)
+ bill_overview = {}
+ electricity = {}
+ gas = {}
+ oil = {}
+ water = {}
+ if objs:
+ for obj in objs:
+ electricity[obj.year] = float(obj.electricity)
+ gas[obj.year] = float(obj.gas)
+ oil[obj.year] = float(obj.oil)
+ water[obj.year] = float(obj.water)
+ bill_overview = {
+ 'electricity': [electricity, not obj.electricity_is_user_input],
+ 'gas': [gas, not obj.gas_is_user_input],
+ 'oil': [oil, not obj.oil_is_user_input],
+ 'water': [water, not obj.water_is_user_input],
+ }
+ return bill_overview
+
+ def save(self, result, building_id):
+ """Save income statement data in database.
+
+ Args:
+ result: List of historical income statement data to be stored in the database.
+ building_id: id of the building.
+ """
+ self.model.objects.filter(building_id=building_id).delete()
+ for record in result:
+ self.model.objects.create(
+ building_id=building_id,
+ year=record['year'],
+ revenue=record['revenue'],
+ utility_expense=record['utility_expense'],
+ other_utility_expense=record['other_utility'],
+ non_utility_operating_expense=record['non_utility_expense']
+ )
+
+ def put(self, request, building_id):
+ """Handle HTTP PUT request.
+
+ Receive income statement data from frontend. Convert the format to use in bpfin function. Store result from
+ bpfin logic to the database. Send the historical remaining calculated income statement data, future one year
+ data and average back to the frontend.
+
+ Args:
+ request: HTTP PUT request with the income statement inputs in the body.
+ building_id: id of the building.
+
+ Returns:
+ JsonResponse: Dictionary with key-value as instance with value the historical results, future with future
+ results and average with average results.
+ """
+ put = json.loads(request.body.decode())
+
+ # Convert the response body to the format bpfin accepts.
+ raw_income_statement_input, growth_rate = self.convert_response_format(put)
+
+ # Get bills overview data from the database.
+ bill_overview = self.get_bills_overview_data(building_id)
+
+ # Get the analysis date from the financing overview model.
+ financing_overview_obj = FinancingOverview.objects.get(building_id=building_id)
+ analysis_date = {
+ 'proforma_start': financing_overview_obj.pro_forma_start_date,
+ 'proforma_duration': financing_overview_obj.pro_forma_duration,
+ }
+
+ # organize_bill_overview takes in the bills overview and analysis date and fills in average values in places
+ # where there are no values.
+ bill_overview_organized = organize_bill_overview(bill_overview, analysis_date)
+
+ # income statement table is an object that takes in the income statement input and bill_overview_organized.
+ income_statement_table = Income_Statement_Table(raw_income_statement_input, bill_overview_organized)
+
+ # income_statement_full is the list of records with historical income statement data.
+ income_statement_full = income_statement_table.get_hist_table()
+
+ # cagr is compound annual growth rate.
+ cagr = income_statement_table.get_cagr()
+
+ # project function calculates the income statement data for the next few years based on the growth rate.
+ income_statement_table.project(growth_rate, analysis_date, bill_overview_organized)
+
+ # result stores the historical income statement data as a list.
+ result = [income_statement_full[year] for year in income_statement_full]
+
+ # result_dict has the income statement data for the next year.
+ result_dict = income_statement_table.get_single_year(income_statement_table.hist_end_year + 1)
+
+ # average_dict has the income statement data for the 3 historical years and the next year projected.
+ average_dict = income_statement_table.get_average()
+
+ # save function stores the data in the database.
+ self.save(result, building_id)
+
+ # Change the float formatting to have only 2 decimal places.
+ for record in result:
+ record['energy_opex'] = float("{0:.2f}".format(record['energy_opex']))
+ record['other_utility'] = float("{0:.2f}".format(record['other_utility']))
+ record['net_non_energy_opex'] = float("{0:.2f}".format(record['net_non_energy_opex']))
+ result_dict['energy_opex'] = float("{0:.2f}".format(result_dict['energy_opex']))
+ result_dict['other_utility'] = float("{0:.2f}".format(result_dict['other_utility']))
+ result_dict['net_non_energy_opex'] = float("{0:.2f}".format(result_dict['net_non_energy_opex']))
+ result_dict['revenue'] = float("{0:.2f}".format(result_dict['revenue']))
+ result_dict['utility_expense'] = float("{0:.2f}".format(result_dict['utility_expense']))
+ result_dict['non_utility_expense'] = float("{0:.2f}".format(result_dict['non_utility_expense']))
+ result_dict['total_opex'] = float("{0:.2f}".format(result_dict['total_opex']))
+ result_dict['noi'] = float("{0:.2f}".format(result_dict['noi']))
+
+ average_dict['electricity_opex'] = float("{0:.2f}".format(average_dict['electricity_opex']))
+ average_dict['gas_opex'] = float("{0:.2f}".format(average_dict['gas_opex']))
+ average_dict['oil_opex'] = float("{0:.2f}".format(average_dict['oil_opex']))
+ average_dict['water_opex'] = float("{0:.2f}".format(average_dict['water_opex']))
+ average_dict['energy_opex'] = float("{0:.2f}".format(average_dict['energy_opex']))
+ average_dict['other_utility'] = float("{0:.2f}".format(average_dict['other_utility']))
+ average_dict['net_non_energy_opex'] = float("{0:.2f}".format(average_dict['net_non_energy_opex']))
+ average_dict['revenue'] = float("{0:.2f}".format(average_dict['revenue']))
+ average_dict['utility_expense'] = float("{0:.2f}".format(average_dict['utility_expense']))
+ average_dict['non_utility_expense'] = float("{0:.2f}".format(average_dict['non_utility_expense']))
+ average_dict['total_opex'] = float("{0:.2f}".format(average_dict['total_opex']))
+ average_dict['noi'] = float("{0:.2f}".format(average_dict['noi']))
+
+ cagr = float("{0:.2f}".format(cagr))
+ return JsonResponse({'instance': result, 'future': result_dict, 'average': average_dict, 'CAGR': cagr})
+
+ def get(self, request, building_id):
+ """Handle HTTP GET request.
+
+ Fetch stored income statement data from the database and send to frontend to display.
+
+ Args:
+ request: HTTP GET request.
+ building_id: id of the building.
+
+ Returns:
+ JsonResponse: Instance which contains a list of records. Each record is a dictionary with income
+ statement information from the database.
+ """
+ objs = self.model.objects.filter(building_id=building_id)
+ instance = {}
+ instance['present'] = False
+ if objs:
+ instance['present'] = True
+ result = []
+ for obj in objs:
+ record = {}
+ record['year'] = obj.year
+ record['revenue'] = obj.revenue
+ record['utility_expense'] = obj.utility_expense
+ record['non_utility_operating_expense'] = obj.non_utility_operating_expense
+ result.append(record)
+ instance['result'] = result
+ return JsonResponse({'instance': instance})