Two-part tariff review set adjustment factors

app/controllers/bill-runs.controller.js

@@ -7,6 +7,7 @@
 
 const Boom = require('@hapi/boom')
 
+const AmendAdjustmentFactorService = require('../services/bill-runs/two-part-tariff/amend-adjustment-factor.service.js')
 const AmendBillableReturnsService = require('../services/bill-runs/two-part-tariff/amend-billable-returns.service.js')
 const CancelBillRunService = require('../services/bill-runs/cancel-bill-run.service.js')
 const ChargeReferenceDetailsService = require('../services/bill-runs/two-part-tariff/charge-reference-details.service.js')
@@ -18,6 +19,7 @@ const ReviewBillRunService = require('../services/bill-runs/two-part-tariff/revi
 const ReviewLicenceService = require('../services/bill-runs/two-part-tariff/review-licence.service.js')
 const SendBillRunService = require('../services/bill-runs/send-bill-run.service.js')
 const StartBillRunProcessService = require('../services/bill-runs/start-bill-run-process.service.js')
+const SubmitAmendedAdjustmentFactorService = require('../services/bill-runs/two-part-tariff/submit-amended-adjustment-factor.service.js')
 const SubmitAmendedBillableReturnsService = require('..//services/bill-runs/two-part-tariff/submit-amended-billable-returns.service.js')
 const SubmitCancelBillRunService = require('../services/bill-runs/submit-cancel-bill-run.service.js')
 const SubmitRemoveBillRunLicenceService = require('../services/bill-runs/two-part-tariff/submit-remove-bill-run-licence.service.js')
@@ -26,6 +28,18 @@ const SubmitReviewLicenceService = require('../services/bill-runs/two-part-tarif
 const SubmitSendBillRunService = require('../services/bill-runs/submit-send-bill-run.service.js')
 const ViewBillRunService = require('../services/bill-runs/view-bill-run.service.js')
 
+async function amendAdjustmentFactor (request, h) {
+  const { id: billRunId, licenceId, reviewChargeReferenceId } = request.params
+
+  const pageData = await AmendAdjustmentFactorService.go(billRunId, licenceId, reviewChargeReferenceId)
+
+  return h.view('bill-runs/amend-adjustment-factor.njk', {
+    pageTitle: 'Set the adjustment factors',
+    activeNavBar: 'bill-runs',
+    ...pageData
+  })
+}
+
 async function amendBillableReturns (request, h) {
   const { id: billRunId, licenceId, reviewChargeElementId } = request.params
 
@@ -149,6 +163,23 @@ async function send (request, h) {
   })
 }
 
+async function submitAmendedAdjustmentFactor (request, h) {
+  const { id: billRunId, licenceId, reviewChargeReferenceId } = request.params
+  const pageData = await SubmitAmendedAdjustmentFactorService.go(
+    billRunId,
+    licenceId,
+    reviewChargeReferenceId,
+    request.payload,
+    request.yar
+  )
+
+  if (pageData.error) {
+    return h.view('bill-runs/amend-adjustment-factor.njk', pageData)
+  }
+
+  return h.redirect(`/system/bill-runs/${billRunId}/review/${licenceId}/charge-reference-details/${reviewChargeReferenceId}`)
+}
+
 async function submitAmendedBillableReturns (request, h) {
   const { id: billRunId, licenceId, reviewChargeElementId } = request.params
 
@@ -236,6 +267,7 @@ async function view (request, h) {
 }
 
 module.exports = {
+  amendAdjustmentFactor,
   amendBillableReturns,
   cancel,
   chargeReferenceDetails,
@@ -246,6 +278,7 @@ module.exports = {
   review,
   reviewLicence,
   send,
+  submitAmendedAdjustmentFactor,
   submitAmendedBillableReturns,
   submitCancel,
   submitReview,

app/presenters/bill-runs/two-part-tariff/amend-adjustment-factor.presenter.js

@@ -0,0 +1,79 @@
+'use strict'
+
+/**
+ * Formats the two part tariff review data ready for presenting in the amend adjustment factor page
+ * @module AmendAdjustmentFactorPresenter
+ */
+
+const { formatLongDate, formatFinancialYear } = require('../../base.presenter.js')
+
+/**
+ * Prepares and processes bill run and review charge reference data for presenting
+ *
+ * @param {module:BillRunModel} billRun - the data from the bill run
+ * @param {module:ReviewChargeReference} reviewChargeReference - the data from the review charge reference
+ * @param {String} licenceId - the UUID of the licence being reviewed
+ *
+ * @returns {Object} the prepared bill run and charge reference data to be passed to the amend adjustment factor page
+ */
+function go (billRun, reviewChargeReference, licenceId) {
+  return {
+    billRunId: billRun.id,
+    licenceId,
+    financialYear: formatFinancialYear(billRun.toFinancialYearEnding),
+    chargePeriod: _prepareDate(
+      reviewChargeReference.reviewChargeVersion.chargePeriodStartDate,
+      reviewChargeReference.reviewChargeVersion.chargePeriodEndDate
+    ),
+    chargeReference: {
+      id: reviewChargeReference.id,
+      description: reviewChargeReference.chargeReference.chargeCategory.shortDescription,
+      aggregateFactor: reviewChargeReference.amendedAggregate,
+      chargeAdjustment: reviewChargeReference.amendedChargeAdjustment,
+      otherAdjustments: _otherAdjustments(reviewChargeReference)
+    }
+  }
+}
+
+function _otherAdjustments (reviewChargeReference) {
+  const { supportedSourceName, waterCompanyCharge } = reviewChargeReference.chargeReference
+
+  const adjustments = []
+
+  if (supportedSourceName) {
+    adjustments.push(`Supported source ${supportedSourceName}`)
+  }
+
+  if (waterCompanyCharge) {
+    adjustments.push('Public Water Supply')
+  }
+
+  if (reviewChargeReference.abatementAgreement !== 1) {
+    adjustments.push(`Abatement agreement (${reviewChargeReference.abatementAgreement})`)
+  }
+
+  if (reviewChargeReference.winterDiscount) {
+    adjustments.push('Winter discount')
+  }
+
+  if (reviewChargeReference.twoPartTariffAgreement) {
+    adjustments.push('Two part tariff agreement')
+  }
+
+  if (reviewChargeReference.canalAndRiverTrustAgreement) {
+    adjustments.push('Canal and River trust agreement')
+  }
+
+  return adjustments
+}
+
+function _prepareDate (startDate, endDate) {
+  const preparedStartDate = formatLongDate(startDate)
+  const preparedEndDate = formatLongDate(endDate)
+
+  return `${preparedStartDate} to ${preparedEndDate}`
+}
+
+module.exports = {
+  go
+}

app/presenters/bill-runs/two-part-tariff/charge-reference-details.presenter.js

@@ -27,6 +27,7 @@ function go (billRun, reviewChargeReference, licenceId) {
       reviewChargeReference.reviewChargeVersion.chargePeriodEndDate
     ),
     chargeReference: {
+      id: reviewChargeReference.id,
       reference: reviewChargeReference.chargeReference.chargeCategory.reference,
       description: reviewChargeReference.chargeReference.chargeCategory.shortDescription,
       totalBillableReturns: _totalBillableReturns(reviewChargeReference.reviewChargeElements),

app/routes/bill-runs.routes.js

@@ -162,6 +162,32 @@ const routes = [
       description: 'Review a charge reference from a two-part tariff licence'
     }
   },
+  {
+    method: 'GET',
+    path: '/bill-runs/{id}/review/{licenceId}/charge-reference-details/{reviewChargeReferenceId}/amend-adjustment-factor',
+    handler: BillRunsController.amendAdjustmentFactor,
+    options: {
+      auth: {
+        access: {
+          scope: ['billing']
+        }
+      },
+      description: 'Amend a charge references adjustment factors from a two-part tariff licence'
+    }
+  },
+  {
+    method: 'POST',
+    path: '/bill-runs/{id}/review/{licenceId}/charge-reference-details/{reviewChargeReferenceId}/amend-adjustment-factor',
+    handler: BillRunsController.submitAmendedAdjustmentFactor,
+    options: {
+      auth: {
+        access: {
+          scope: ['billing']
+        }
+      },
+      description: 'Submit the amended charge references adjustment factors from a two-part tariff licence'
+    }
+  },
   {
     method: 'GET',
     path: '/bill-runs/{id}/review/{licenceId}/match-details/{reviewChargeElementId}',

app/services/bill-runs/two-part-tariff/amend-adjustment-factor.service.js

@@ -0,0 +1,33 @@
+'use strict'
+
+/**
+ * Orchestrates fetching and presenting the data needed for the amend adjustment factor page
+ * @module AmendAdjustmentFactorService
+ */
+
+const AmendAdjustmentFactorPresenter = require('../../../presenters/bill-runs/two-part-tariff/amend-adjustment-factor.presenter.js')
+const FetchReviewChargeReferenceService = require('./fetch-review-charge-reference.service.js')
+
+/**
+ * Orchestrates fetching and presenting the data needed for the amend adjustment factor page
+ *
+ * @param {String} billRunId - The UUID for the bill run
+ * @param {String} licenceId - The UUID of the licence that is being reviewed
+ * @param {String} reviewChargeReferenceId - The UUID of the review charge reference being viewed
+ *
+ * @returns {Promise<Object>} the 'pageData' needed to view the amend adjustment factor page
+ */
+async function go (billRunId, licenceId, reviewChargeReferenceId) {
+  const {
+    billRun,
+    reviewChargeReference
+  } = await FetchReviewChargeReferenceService.go(billRunId, reviewChargeReferenceId)
+
+  const pageData = AmendAdjustmentFactorPresenter.go(billRun, reviewChargeReference, licenceId)
+
+  return pageData
+}
+
+module.exports = {
+  go
+}

app/services/bill-runs/two-part-tariff/charge-reference-details.service.js

@@ -16,19 +16,24 @@ const FetchReviewChargeReferenceService = require('./fetch-review-charge-referen
  * @param {String} billRunId - The UUID for the bill run
  * @param {String} licenceId - The UUID of the licence that is being reviewed
  * @param {String} reviewChargeReferenceId - The UUID of the charge reference being reviewed
+ * @param {Object} yar - The Hapi `request.yar` session manager passed on by the controller
  *
  * @returns {Promise<Object>} the 'pageData' needed for the review charge reference page. It contains details of the
  * bill run, charge reference and the charge adjustments
  */
-async function go (billRunId, licenceId, reviewChargeReferenceId) {
+async function go (billRunId, licenceId, reviewChargeReferenceId, yar) {
   const {
     billRun,
     reviewChargeReference
   } = await FetchReviewChargeReferenceService.go(billRunId, reviewChargeReferenceId)
 
+  const [bannerMessage] = yar.flash('banner')
   const pageData = ChargeReferenceDetailsPresenter.go(billRun, reviewChargeReference, licenceId)
 
-  return pageData
+  return {
+    bannerMessage,
+    ...pageData
+  }
 }
 
 module.exports = {

app/services/bill-runs/two-part-tariff/submit-amended-adjustment-factor.service.js

@@ -0,0 +1,91 @@
+'use strict'
+
+/**
+ * Orchestrates validating and patching the data for the amend adjustment factors page
+ * @module SubmitAmendedAdjustmentFactorService
+*/
+
+const AdjustmentFactorValidator = require('../../../validators/bill-runs/two-part-tariff/adjustment-factor.validator.js')
+const AmendAdjustmentFactorPresenter = require('../../../presenters/bill-runs/two-part-tariff/amend-adjustment-factor.presenter.js')
+const FetchReviewChargeReferenceService = require('./fetch-review-charge-reference.service.js')
+const ReviewChargeReferenceModel = require('../../../models/review-charge-reference.model.js')
+
+/**
+ * Orchestrates validating the data for the amend adjustment factor page and patching the db value
+
+ * @param {String} billRunId - The UUID for the bill run
+ * @param {String} licenceId - The UUID of the licence that is being reviewed
+ * @param {String} reviewChargeReferenceId - The UUID of the review charge reference being updated
+ * @param {Object} payload - The submitted form data
+ * @param {Object} yar - The Hapi `request.yar` session manager passed on by the controller
+ *
+ * @returns {Promise<Object>} The updated value for the adjustment factor
+ */
+async function go (billRunId, licenceId, reviewChargeReferenceId, payload, yar) {
+  const validationResult = _validate(payload)
+
+  if (!validationResult) {
+    await _persistAmendedAdjustmentFactor(reviewChargeReferenceId, payload)
+    yar.flash('banner', 'The adjustment factors for this licence have been updated')
+
+    return { error: null }
+  }
+
+  const pageData = await _getPageData(billRunId, reviewChargeReferenceId, licenceId)
+
+  return {
+    activeNavBar: 'search',
+    pageTitle: 'Set the adjustment factors',
+    error: validationResult,
+    inputtedAggregateValue: payload.amendedAggregateFactor,
+    inputtedChargeValue: payload.amendedChargeAdjustment,
+    ...pageData
+  }
+}
+
+async function _getPageData (billRunId, reviewChargeReferenceId, licenceId) {
+  const {
+    billRun,
+    reviewChargeReference
+  } = await FetchReviewChargeReferenceService.go(billRunId, reviewChargeReferenceId)
+
+  return AmendAdjustmentFactorPresenter.go(billRun, reviewChargeReference, licenceId)
+}
+
+async function _persistAmendedAdjustmentFactor (reviewChargeReferenceId, payload) {
+  await ReviewChargeReferenceModel.query()
+    .findById(reviewChargeReferenceId)
+    .patch({ amendedAggregate: payload.amendedAggregateFactor })
+
+  await ReviewChargeReferenceModel.query()
+    .findById(reviewChargeReferenceId)
+    .patch({ amendedChargeAdjustment: payload.amendedChargeAdjustment })
+}
+
+function _validate (payload) {
+  const maxDecimalsForAggregateValue = 2
+  const maxDecimalsForChargeAdjustmentValue = 15
+
+  const aggregateValidation = AdjustmentFactorValidator.go(
+    payload.amendedAggregateFactor,
+    maxDecimalsForAggregateValue,
+    'aggregate')
+
+  const chargeValidation = AdjustmentFactorValidator.go(
+    payload.amendedChargeAdjustment,
+    maxDecimalsForChargeAdjustmentValue,
+    'charge')
+
+  if (!aggregateValidation.error && !chargeValidation.error) {
+    return null
+  }
+
+  return {
+    aggregateFactorElement: aggregateValidation.error ? { text: aggregateValidation.error.details[0].message } : null,
+    chargeAdjustmentElement: chargeValidation.error ? { text: chargeValidation.error.details[0].message } : null
+  }
+}
+
+module.exports = {
+  go
+}