Add server-side utils to display current exchange rate in reports

IMA-WorldHealth · Jan 13, 2022 · c9c5ebb · c9c5ebb
1 parent cddd292
commit c9c5ebb
Show file tree

Hide file tree

Showing 40 changed files with 179 additions and 214 deletions.
diff --git a/client/src/modules/reports/generate/annual_clients_report/annual_clients_report.html b/client/src/modules/reports/generate/annual_clients_report/annual_clients_report.html
@@ -30,11 +30,6 @@ <h3 class="text-capitalize" translate>REPORT.CLIENTS.TITLE</h3>
             required="true">
           </bh-fiscal-year-select>
 
-          <bh-currency-select
-            currency-id="ReportConfigCtrl.reportDetails.currencyId"
-            on-change="ReportConfigCtrl.onSelectCurrency(currency)">
-          </bh-currency-select>
-
           <bh-yes-no-radios
             label="REPORT.CLIENTS.HIDE_LOCKED_CLIENTS"
             value="ReportConfigCtrl.reportDetails.hideLockedClients"
@@ -51,6 +46,11 @@ <h3 class="text-capitalize" translate>REPORT.CLIENTS.TITLE</h3>
             on-change-callback="ReportConfigCtrl.onIncludeCashClientsToggle(value)">
           </bh-yes-no-radios>
 
+          <bh-currency-select
+            currency-id="ReportConfigCtrl.reportDetails.currencyId"
+            on-change="ReportConfigCtrl.onSelectCurrency(currency)">
+          </bh-currency-select>
+
           <!--preview-->
           <bh-loading-button loading-state="ConfigForm.$loading">
             <span translate>REPORT.UTIL.PREVIEW</span>

diff --git a/client/src/modules/reports/generate/open_debtors/open_debtors.config.js b/client/src/modules/reports/generate/open_debtors/open_debtors.config.js
@@ -54,7 +54,6 @@ function OpenDebtorsConfigController(
 
   vm.onSelectCurrency = currency => {
     vm.reportDetails.currencyId = currency.id;
-    vm.reportDetails.currencySymbol = currency.symbol;
   };
 
   vm.requestSaveAs = function requestSaveAs() {

diff --git a/client/src/modules/reports/generate/stock_entry/stock_entry.html b/client/src/modules/reports/generate/stock_entry/stock_entry.html
@@ -39,11 +39,6 @@ <h3 translate>REPORT.STOCK.ENTRY_REPORT</h3>
             required="true">
           </bh-date-interval>
 
-          <bh-currency-select
-            currency-id="ReportConfigCtrl.reportDetails.currencyId"
-            on-change="ReportConfigCtrl.onSelectCurrency(currency)" >
-          </bh-currency-select>          
-
           <!-- stock entry type -->
           <div ng-class="{'has-error': ConfigForm.$submitted && !ReportConfigCtrl.hasOneChecked}">
             <div class="checkbox">
@@ -76,15 +71,18 @@ <h3 translate>REPORT.STOCK.ENTRY_REPORT</h3>
             <em ng-if="ConfigForm.$submitted && !ReportConfigCtrl.hasOneChecked" class="help-block" translate>STOCK.AT_LEAST_ONE_CHECKED</em>
           </div>
 
-          <hr>
-
           <div class="checkbox">
             <label>
               <input type="checkbox" ng-true-value="1" ng-false-value="0" ng-model="ReportConfigCtrl.reportDetails.showDetails">
               <span translate>REPORT.STOCK.SHOW_DETAILS</span>
             </label>
           </div>
 
+          <bh-currency-select
+            currency-id="ReportConfigCtrl.reportDetails.currencyId"
+            on-change="ReportConfigCtrl.onSelectCurrency(currency)" >
+          </bh-currency-select>
+
           <!-- preview -->
           <bh-loading-button loading-state="ConfigForm.$loading">
             <span translate>REPORT.UTIL.PREVIEW</span>

diff --git a/client/src/modules/reports/generate/stock_exit/stock_exit.html b/client/src/modules/reports/generate/stock_exit/stock_exit.html
@@ -39,11 +39,6 @@ <h3 translate>REPORT.STOCK.EXIT_REPORT</h3>
             required="true">
           </bh-date-interval>
 
-          <bh-currency-select
-            currency-id="ReportConfigCtrl.currency_id"
-            on-change="ReportConfigCtrl.onSelectCurrency(currency)" >
-          </bh-currency-select>
-
           <!-- stock exit type -->
           <div ng-class="{'has-error': ConfigForm.$submitted && !ReportConfigCtrl.hasOneChecked}">
             <div class="checkbox">
@@ -90,15 +85,18 @@ <h3 translate>REPORT.STOCK.EXIT_REPORT</h3>
             <em ng-if="ConfigForm.$submitted && !ReportConfigCtrl.hasOneChecked" class="help-block" translate>STOCK.AT_LEAST_ONE_CHECKED</em>
           </div>
 
-          <hr>
-
           <div class="checkbox">
             <label>
               <input type="checkbox" ng-true-value="1" ng-false-value="0" ng-model="ReportConfigCtrl.showDetails">
               <span translate>REPORT.STOCK.SHOW_DETAILS</span>
             </label>
           </div>
 
+          <bh-currency-select
+            currency-id="ReportConfigCtrl.currency_id"
+            on-change="ReportConfigCtrl.onSelectCurrency(currency)" >
+          </bh-currency-select>
+
           <!-- preview -->
           <bh-loading-button loading-state="ConfigForm.$loading">
             <span translate>REPORT.UTIL.PREVIEW</span>

diff --git a/client/src/modules/reports/generate/stock_value/stock_value.html b/client/src/modules/reports/generate/stock_value/stock_value.html
@@ -40,13 +40,6 @@ <h3 translate>REPORT.STOCK_VALUE.TITLE</h3>
             on-change="ReportConfigCtrl.onDateChange(date)">
           </bh-date-editor>
 
-           <!-- the currency to be used in the footer -->
-          <bh-currency-select
-           currency-id="ReportConfigCtrl.currency_id"
-           on-change="ReportConfigCtrl.onSelectCurrency(currency)">
-          </bh-currency-select>
-
-          <hr>
           <div class="checkbox">
             <label>
               <input type="checkbox" ng-true-value="1" ng-false-value="0"
@@ -56,6 +49,12 @@ <h3 translate>REPORT.STOCK_VALUE.TITLE</h3>
             </label>
           </div>
 
+          <!-- the currency to be used in the footer -->
+          <bh-currency-select
+           currency-id="ReportConfigCtrl.currency_id"
+           on-change="ReportConfigCtrl.onSelectCurrency(currency)">
+          </bh-currency-select>
+
           <!-- preview -->
           <bh-loading-button loading-state="ConfigForm.$loading">
             <span translate>REPORT.UTIL.PREVIEW</span>

diff --git a/server/controllers/finance/exchange.js b/server/controllers/finance/exchange.js
@@ -6,8 +6,8 @@
  */
 
 const db = require('../../lib/db');
-const NotFound = require('../../lib/errors/NotFound');
 const util = require('../../lib/util');
+const NotFound = require('../../lib/errors/NotFound');
 
 exports.getExchangeRate = getExchangeRate;
 exports.formatExchangeRateForDisplay = formatExchangeRateForDisplay;
@@ -22,7 +22,7 @@ function getExchangeRate(enterpriseId, currencyId, date) {
     .then(rows => rows[0]);
 }
 
-// gets a positive number for the exchange rate display.
+// gets a non-fractional number for the exchange rate display.
 function formatExchangeRateForDisplay(value) {
   return (value < 1) ? util.roundDecimal(1 / value, 2) : value;
 }

diff --git a/server/controllers/finance/reports/client_debts/report.handlebars b/server/controllers/finance/reports/client_debts/report.handlebars
@@ -24,7 +24,6 @@
           </tr>
         </thead>
 
-
         <tbody>
           <tr>
             <th colspan="2">{{translate 'REPORT.CLIENT_SUMMARY.NOT_EMPLOYEES_DEBTS' }} ({{patients.length}})</th>

diff --git a/server/controllers/finance/reports/cost_center_step_down/income_and_expense.handlebars b/server/controllers/finance/reports/cost_center_step_down/income_and_expense.handlebars
@@ -20,7 +20,7 @@
           <strong class="text-capitalize">{{date dateTo "MMMM YYYY"}}</strong>
         </h4>
 
-        {{> exchangeRate lastRateUsed=lastRateUsed firstCurrency=firstCurrency secondCurrency=secondCurrency dateTo=dateTo}}
+        {{> exchangeRate rate=lastRateUsed currencyId=currencyId date=dateTo}}
 
         <table style="page-break-after: always;" class="table table-striped table-condensed table-report table-bordered">
           <thead>

diff --git a/server/controllers/finance/reports/cost_center_step_down/income_and_expense.js b/server/controllers/finance/reports/cost_center_step_down/income_and_expense.js
@@ -40,9 +40,9 @@ async function buildAccountsReport(params, session) {
 
   const queryTotals = `
     SELECT
-      z.label, 
-      SUM(z.income * IFNULL(GetExchangeRate(?, ?, ?), 1)) income, 
-      SUM(z.expense * IFNULL(GetExchangeRate(?, ?, ?), 1)) expense, 
+      z.label,
+      SUM(z.income * IFNULL(GetExchangeRate(?, ?, ?), 1)) income,
+      SUM(z.expense * IFNULL(GetExchangeRate(?, ?, ?), 1)) expense,
       SUM((z.income - expense) * IFNULL(GetExchangeRate(?, ?, ?), 1)) AS balance
     FROM
     (
@@ -51,9 +51,9 @@ async function buildAccountsReport(params, session) {
         SUM(IF(a.type_id = 4, gl.credit_equiv - gl.debit_equiv, 0)) AS income,
         SUM(IF(a.type_id = 5, gl.debit_equiv - gl.credit_equiv, 0)) AS expense,
         gl.cost_center_id AS ccId
-      FROM general_ledger gl 
+      FROM general_ledger gl
       JOIN cost_center cc ON cc.id = gl.cost_center_id
-      JOIN account a ON a.id = gl.account_id 
+      JOIN account a ON a.id = gl.account_id
       WHERE gl.period_id >= ? AND gl.period_id <= ?
       GROUP BY cc.id
     )z
@@ -78,7 +78,7 @@ async function buildAccountsReport(params, session) {
   const totals = await db.exec(queryTotals, parameters);
 
   const context = {
-    currencyId : options.currency_id,
+    currencyId : Number(options.currency_id),
     dateFrom,
     dateTo,
     data,

diff --git a/server/controllers/finance/reports/debtors/annual_clients_report.handlebars b/server/controllers/finance/reports/debtors/annual_clients_report.handlebars
@@ -12,11 +12,7 @@
       {{ fiscalYear.label }}
     </h4>
 
-    {{#unless isEnterpriseCurrency}}
-      <div class="alert alert-warning">
-        <p>{{translate "REPORT.REPORT_ACCOUNTS.WARN_CURRENCY"}}</p>
-      </div>
-    {{/unless}}
+    {{> exchangeRate rate=exchangeRate currencyId=currencyId}}
 
     <section>
       <table class="table table-condensed table-report table-bordered">

diff --git a/server/controllers/finance/reports/debtors/annual_clients_report.js b/server/controllers/finance/reports/debtors/annual_clients_report.js
@@ -11,20 +11,19 @@ const TEMPLATE = './server/controllers/finance/reports/debtors/annual_clients_re
 exports.annualClientsReport = annualClientsReport;
 exports.reporting = reporting;
 
-async function setupAnnualClientsReport(options, enterpriseCurrencyId) {
+async function setupAnnualClientsReport(options, enterprise) {
   const {
-    fiscalId, currencyId, hideLockedClients, includeCashClients,
+    fiscalId, hideLockedClients, includeCashClients,
   } = options;
+  const currencyId = Number(options.currencyId);
 
   // convert to an integer
   const shouldHideLockedClients = Number(hideLockedClients);
   const shouldIncludeCashClients = Number(includeCashClients);
 
-  const isEnterpriseCurrency = parseInt(currencyId, 10) === enterpriseCurrencyId;
-
   const [fiscalYear, exchange] = await Promise.all([
     Fiscal.lookupFiscalYear(fiscalId),
-    Exchange.getExchangeRate(enterpriseCurrencyId, currencyId, new Date()),
+    Exchange.getExchangeRate(enterprise.id, currencyId, new Date()),
   ]);
 
   const rate = exchange.rate || 1;
@@ -35,7 +34,7 @@ async function setupAnnualClientsReport(options, enterpriseCurrencyId) {
   ]);
 
   return {
-    rows, footer, fiscalYear, rate, isEnterpriseCurrency,
+    rows, footer, fiscalYear, exchangeRate : rate, currencyId,
   };
 }
 
@@ -54,7 +53,7 @@ async function annualClientsReport(req, res, next) {
 
   try {
     const reportManager = new ReportManager(TEMPLATE, req.session, options);
-    const data = await setupAnnualClientsReport(req.query, req.session.enterprise.currency_id);
+    const data = await setupAnnualClientsReport(req.query, req.session.enterprise);
     const { headers, report } = await reportManager.render(data);
     res.set(headers).send(report);
   } catch (e) {

diff --git a/server/controllers/finance/reports/debtors/openDebtors.handlebars b/server/controllers/finance/reports/debtors/openDebtors.handlebars
@@ -12,17 +12,8 @@
       {{#if details.limitDate}}{{date details.reportDateLimit}} - {{/if}}
       {{date this.timestamp }}
     </h4>
-    {{#unless enterpriseCurrency}}
-      {{#if showReciprocalRate}}
-      <h5 class="text-center">
-        {{ translate 'FORM.LABELS.EXCHANGE_RATE' }}:  {{currency reciprocalRate enterpriseCurrencyId}} {{translate 'FORM.INFO.PER'}} {{ currencySymbol }}
-      </h5>
-      {{else}}
-      <h5 class="text-center">
-        {{ translate 'FORM.LABELS.EXCHANGE_RATE' }}:  {{currency rate currencyId}} {{translate 'FORM.INFO.PER'}} {{ enterpriseCurrencySymbol }}
-      </h5>
-      {{/if}}
-    {{/unless}}
+
+    {{> exchangeRate rate=exchangeRate currencyId=currencyId}}
 
     <!-- margin is the cell size -->
     <section>

diff --git a/server/controllers/finance/reports/debtors/openDebtors.js b/server/controllers/finance/reports/debtors/openDebtors.js
@@ -33,6 +33,7 @@
 const _ = require('lodash');
 const ReportManager = require('../../../../lib/ReportManager');
 const db = require('../../../../lib/db');
+const Exchange = require('../../exchange');
 
 // path to the template to render
 const TEMPLATE = './server/controllers/finance/reports/debtors/openDebtors.handlebars';
@@ -61,7 +62,6 @@ function build(req, res, next) {
   qs.enterpriseCurrencySymbol = metadata.enterprise.currencySymbol;
 
   let report;
-
   try {
     report = new ReportManager(TEMPLATE, metadata, qs);
   } catch (e) {
@@ -92,16 +92,10 @@ function requestOpenDebtors(params) {
   const reportDateLimit = new Date(params.reportDateLimit);
   const currencyId = parseInt(params.currencyId, 10);
   const enterpriseId = parseInt(params.enterpriseId, 10);
-  const enterpriseCurrencyId = parseInt(params.enterpriseCurrencyId, 10);
-  const enterpriseCurrency = params.currencyId === params.enterpriseCurrencyId;
 
   // TODO(@jniles) respect the ordering in the open debtors field.
   const ordering = parseOrdering(params.order);
 
-  const exchangeRateQuery = `
-    SELECT GetExchangeRate(?, ?, NOW()) AS rate
-  `;
-
   const unverifiedSource = `
     (SELECT entity_uuid, reference_uuid, trans_date, credit_equiv, debit_equiv from general_ledger
       UNION ALL
@@ -130,17 +124,11 @@ function requestOpenDebtors(params) {
       reportDateLimit,
     },
     currencyId,
-    currencySymbol : params.currencySymbol,
-    enterpriseCurrencyId,
-    enterpriseCurrencySymbol : params.enterpriseCurrencySymbol,
-    enterpriseCurrency,
   };
 
-  return db.one(exchangeRateQuery, [enterpriseId, currencyId])
+  return Exchange.getExchangeRate(enterpriseId, currencyId, new Date())
     .then((exRate) => {
-      debtorReport.rate = exRate.rate ? exRate.rate : 1;
-      debtorReport.reciprocalRate = 1.0 / debtorReport.rate;
-      debtorReport.showReciprocalRate = debtorReport.rate < 1.0;
+      debtorReport.exchangeRate = exRate.rate ? exRate.rate : 1;
       return db.exec(debtorQuery);
     })
     .then((debtorsDebts) => {

diff --git a/server/controllers/finance/reports/financial.all_employees.handlebars b/server/controllers/finance/reports/financial.all_employees.handlebars
@@ -10,12 +10,6 @@
     </span>
   </h3>
 
-  {{#unless isEnterpriseCurrency}}
-    <div class="alert alert-warning">
-      <p>{{translate "REPORT.REPORT_ACCOUNTS.WARN_CURRENCY"}}</p>
-    </div>
-  {{/unless}}
-
   {{#if limitTimeInterval}}
     <div class="text-center">
       <strong>
@@ -24,6 +18,8 @@
     </div>
   {{/if}}
 
+  {{> exchangeRate rate=exchangeRate currencyId=currencyId date=dateExchangeRate}}
+
   <section>
     <table class="table table-condensed table-bordered table-report">
     {{#if summary}}

diff --git a/server/controllers/finance/reports/financial.all_employees.js b/server/controllers/finance/reports/financial.all_employees.js
@@ -157,18 +157,20 @@ async function build(req, res, next) {
       `;
     }
 
+    const currencyId = Number(options.currency_id);
+
     const [financialData, exchange] = await Promise.all([
       db.exec(sql),
       Exchange.getExchangeRate(
         req.session.enterprise.id,
-        Number(options.currency_id),
+        currencyId,
         dateExchangeRate,
       ),
     ]);
 
+    data.currencyId = currencyId;
     data.exchangeRate = exchange.rate || 1;
-    data.currencyId = options.currency_id;
-    data.isEnterpriseCurrency = req.session.enterprise.currency_id === Number(options.currency_id);
+    data.dateExchangeRate = dateExchangeRate;
 
     let sumDebit = 0;
     let sumCredit = 0;