Move supplementary-billing to new billing folder

https://eaflood.atlassian.net/browse/WATER-4057

We are on the cusp of adding our second bill run type; two-part tariff. Our experience of implementing the first, supplementary billing has shown that we're going to need a lot of services! 😁

So, ahead of starting to implement we are doing some housekeeping in our services folder. The first of these was to [Move db-export services to data folder](#299). The second of these is to move the `services/supplementary-billing/` to `services/billing/supplementary/`.

Author: Cruikshanks

app/controllers/bill-runs/bill-runs.controller.js

@@ -8,7 +8,7 @@
 const Boom = require('@hapi/boom')
 
 const CreateBillRunValidator = require('../../validators/bill-runs/create-bill-run.validator.js')
-const NewBillingBatchService = require('../../services/supplementary-billing/new-billing-batch.service.js')
+const NewBillingBatchService = require('../../services/billing/supplementary/new-billing-batch.service.js')
 
 async function create (request, h) {
   const validatedData = CreateBillRunValidator.go(request.payload)

app/services/supplementary-billing/billing-periods.service.js renamed to app/services/billing/supplementary/billing-periods.service.js

@@ -5,7 +5,7 @@
  * @module CheckLiveBillRunService
  */
 
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
 
 const LIVE_STATUSES = ['processing', 'ready', 'review', 'queued']
 

app/services/supplementary-billing/calculate-authorised-and-billable-days.service.js renamed to app/services/billing/supplementary/calculate-authorised-and-billable-days.service.js

@@ -5,9 +5,9 @@
  * @module CreateBillingBatchEventService
  */
 
-const CreateBillingBatchEventPresenter = require('../../presenters/supplementary-billing/create-billing-batch-event.presenter.js')
-const EventModel = require('../../models/water/event.model.js')
-const GeneralLib = require('../../lib/general.lib.js')
+const CreateBillingBatchEventPresenter = require('../../../presenters/supplementary-billing/create-billing-batch-event.presenter.js')
+const EventModel = require('../../../models/water/event.model.js')
+const GeneralLib = require('../../../lib/general.lib.js')
 
 /**
  * Create an event for when a new bill run is initialised

app/services/supplementary-billing/check-live-bill-run.service.js renamed to app/services/billing/supplementary/check-live-bill-run.service.js

@@ -5,7 +5,7 @@
  * @module CreateBillingBatchService
  */
 
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
 
 /**
  * Create a new billing batch

app/services/supplementary-billing/consolidate-date-ranges.service.js renamed to app/services/billing/supplementary/consolidate-date-ranges.service.js

@@ -5,7 +5,7 @@
  * @module CreateTransactionsService
  */
 
-const BillingTransactionModel = require('../../models/water/billing-transaction.model.js')
+const BillingTransactionModel = require('../../../models/water/billing-transaction.model.js')
 
 /**
  * Persists a billing transaction in the db

app/services/supplementary-billing/create-billing-batch-event.service.js renamed to app/services/billing/supplementary/create-billing-batch-event.service.js

@@ -7,8 +7,8 @@
 
 const { ref } = require('objection')
 
-const ChargeVersion = require('../../models/water/charge-version.model.js')
-const ChargeVersionWorkflow = require('../../models/water/charge-version-workflow.model.js')
+const ChargeVersion = require('../../../models/water/charge-version.model.js')
+const ChargeVersionWorkflow = require('../../../models/water/charge-version-workflow.model.js')
 
 /**
  * Fetch all SROC charge versions to be processed as part of supplementary billing

app/services/supplementary-billing/create-billing-batch.service.js renamed to app/services/billing/supplementary/create-billing-batch.service.js

@@ -5,7 +5,7 @@
  * @module FetchInvoiceAccountNumbersService
  */
 
-const InvoiceAccountModel = require('../../models/crm-v2/invoice-account.model.js')
+const InvoiceAccountModel = require('../../../models/crm-v2/invoice-account.model.js')
 
 /**
  * Fetch all invoice account numbers for the supplied charge versions

app/services/supplementary-billing/create-billing-transaction.service.js renamed to app/services/billing/supplementary/create-billing-transaction.service.js

@@ -5,7 +5,7 @@
  * @module FetchInvoicesToBeReissuedService
  */
 
-const BillingInvoiceModel = require('../../models/water/billing-invoice.model.js')
+const BillingInvoiceModel = require('../../../models/water/billing-invoice.model.js')
 
 /**
  * Takes a region and fetches billing invoices in that region marked for reissuing, along with their transactions

app/services/supplementary-billing/determine-charge-period.service.js renamed to app/services/billing/supplementary/determine-charge-period.service.js

@@ -6,7 +6,7 @@
  * @module FetchPreviousBillingTransactionsService
  */
 
-const { db } = require('../../../db/db.js')
+const { db } = require('../../../../db/db.js')
 
 /**
  * Fetches the previously billed transactions that match the invoice, licence and year provided, removing any debits

app/services/supplementary-billing/determine-minimum-charge.service.js renamed to app/services/billing/supplementary/determine-minimum-charge.service.js

@@ -5,7 +5,7 @@
  * @module FetchRegionService
  */
 
-const RegionModel = require('../../models/water/region.model.js')
+const RegionModel = require('../../../models/water/region.model.js')
 
 /**
  * Fetches the region with the matching NALD Region ID

app/services/supplementary-billing/fetch-charge-versions.service.js renamed to app/services/billing/supplementary/fetch-charge-versions.service.js

@@ -5,7 +5,7 @@
  * @module HandleErroredBillingBatchService
  */
 
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
 
 /**
  * Sets the status of the specified billing batch to `error`, and logs an error if this can't be done.

app/services/supplementary-billing/fetch-invoice-account-numbers.service.js renamed to app/services/billing/supplementary/fetch-invoice-account-numbers.service.js

@@ -5,12 +5,12 @@
  * @module InitiateBillingBatchService
  */
 
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
-const ChargingModuleCreateBillRunService = require('../charging-module/create-bill-run.service.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
+const ChargingModuleCreateBillRunService = require('../../charging-module/create-bill-run.service.js')
 const CheckLiveBillRunService = require('./check-live-bill-run.service.js')
 const CreateBillingBatchService = require('./create-billing-batch.service.js')
 const CreateBillingBatchEventService = require('./create-billing-batch-event.service.js')
-const ExpandedError = require('../../errors/expanded.error.js')
+const ExpandedError = require('../../../errors/expanded.error.js')
 
 /**
  * Initiate a new billing batch

app/services/supplementary-billing/fetch-invoices-to-be-reissued.service.js renamed to app/services/billing/supplementary/fetch-invoices-to-be-reissued.service.js

@@ -6,7 +6,7 @@
  */
 
 const BillingPeriodsService = require('./billing-periods.service.js')
-const CreateBillingBatchPresenter = require('../../presenters/supplementary-billing/create-billing-batch.presenter.js')
+const CreateBillingBatchPresenter = require('../../../presenters/supplementary-billing/create-billing-batch.presenter.js')
 const InitiateBillingBatchService = require('./initiate-billing-batch.service.js')
 const ProcessBillingBatchService = require('./process-billing-batch.service.js')
 

app/services/supplementary-billing/fetch-previous-billing-transactions.service.js renamed to app/services/billing/supplementary/fetch-previous-billing-transactions.service.js

@@ -5,17 +5,17 @@
  * @module ProcessBillingBatchService
  */
 
-const BillingBatchError = require('../../errors/billing-batch.error.js')
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
-const ChargingModuleGenerateService = require('../charging-module/generate-bill-run.service.js')
+const BillingBatchError = require('../../../errors/billing-batch.error.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
+const ChargingModuleGenerateService = require('../../charging-module/generate-bill-run.service.js')
 const FetchChargeVersionsService = require('./fetch-charge-versions.service.js')
 const HandleErroredBillingBatchService = require('./handle-errored-billing-batch.service.js')
-const LegacyRequestLib = require('../../lib/legacy-request.lib.js')
+const LegacyRequestLib = require('../../../lib/legacy-request.lib.js')
 const ProcessBillingPeriodService = require('./process-billing-period.service.js')
 const ReissueInvoicesService = require('./reissue-invoices.service.js')
 const UnflagUnbilledLicencesService = require('./unflag-unbilled-licences.service.js')
 
-const FeatureFlagsConfig = require('../../../config/feature-flags.config.js')
+const FeatureFlagsConfig = require('../../../../config/feature-flags.config.js')
 
 /**
  * Process a given billing batch for the given billing periods. In this case, "process" means that we create the

app/services/supplementary-billing/fetch-region.service.js renamed to app/services/billing/supplementary/fetch-region.service.js

@@ -5,11 +5,11 @@
  * @module ProcessBillingPeriodService
  */
 
-const BillingBatchError = require('../../errors/billing-batch.error.js')
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
-const BillingInvoiceModel = require('../../models/water/billing-invoice.model.js')
-const BillingInvoiceLicenceModel = require('../../models/water/billing-invoice-licence.model.js')
-const BillingTransactionModel = require('../../models/water/billing-transaction.model.js')
+const BillingBatchError = require('../../../errors/billing-batch.error.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
+const BillingInvoiceModel = require('../../../models/water/billing-invoice.model.js')
+const BillingInvoiceLicenceModel = require('../../../models/water/billing-invoice-licence.model.js')
+const BillingTransactionModel = require('../../../models/water/billing-transaction.model.js')
 const DetermineChargePeriodService = require('./determine-charge-period.service.js')
 const DetermineMinimumChargeService = require('./determine-minimum-charge.service.js')
 const GenerateBillingTransactionsService = require('./generate-billing-transactions.service.js')

app/services/supplementary-billing/generate-billing-invoice-licence.service.js renamed to app/services/billing/supplementary/generate-billing-invoice-licence.service.js

@@ -6,9 +6,9 @@
  */
 const { randomUUID } = require('crypto')
 
-const ChargingModuleReissueInvoiceService = require('../charging-module/reissue-invoice.service.js')
-const ChargingModuleViewInvoiceService = require('../charging-module/view-invoice.service.js')
-const ExpandedError = require('../../errors/expanded.error.js')
+const ChargingModuleReissueInvoiceService = require('../../charging-module/reissue-invoice.service.js')
+const ChargingModuleViewInvoiceService = require('../../charging-module/view-invoice.service.js')
+const ExpandedError = require('../../../errors/expanded.error.js')
 const GenerateBillingInvoiceLicenceService = require('./generate-billing-invoice-licence.service.js')
 const GenerateBillingInvoiceService = require('./generate-billing-invoice.service.js')
 

app/services/supplementary-billing/generate-billing-invoice.service.js renamed to app/services/billing/supplementary/generate-billing-invoice.service.js

@@ -5,9 +5,9 @@
  * @module ReissueInvoicesService
  */
 
-const BillingInvoiceModel = require('../../models/water/billing-invoice.model.js')
-const BillingInvoiceLicenceModel = require('../../models/water/billing-invoice-licence.model.js')
-const BillingTransactionModel = require('../../models/water/billing-transaction.model.js')
+const BillingInvoiceModel = require('../../../models/water/billing-invoice.model.js')
+const BillingInvoiceLicenceModel = require('../../../models/water/billing-invoice-licence.model.js')
+const BillingTransactionModel = require('../../../models/water/billing-transaction.model.js')
 const FetchInvoicesToBeReissuedService = require('./fetch-invoices-to-be-reissued.service.js')
 const ReissueInvoiceService = require('./reissue-invoice.service.js')
 

app/services/supplementary-billing/generate-billing-transactions.service.js renamed to app/services/billing/supplementary/generate-billing-transactions.service.js

@@ -5,10 +5,10 @@
  * @module SendBillingTransactionsService
  */
 
-const BillingBatchError = require('../../errors/billing-batch.error.js')
-const BillingBatchModel = require('../../models/water/billing-batch.model.js')
-const ChargingModuleCreateTransactionService = require('../charging-module/create-transaction.service.js')
-const ChargingModuleCreateTransactionPresenter = require('../../presenters/charging-module/create-transaction.presenter.js')
+const BillingBatchError = require('../../../errors/billing-batch.error.js')
+const BillingBatchModel = require('../../../models/water/billing-batch.model.js')
+const ChargingModuleCreateTransactionService = require('../../charging-module/create-transaction.service.js')
+const ChargingModuleCreateTransactionPresenter = require('../../../presenters/charging-module/create-transaction.presenter.js')
 
 /**
  * Sends the provided transactions to the Charging Module and returns an array of the sent transactions, each updated

app/services/supplementary-billing/handle-errored-billing-batch.service.js renamed to app/services/billing/supplementary/handle-errored-billing-batch.service.js

@@ -5,7 +5,7 @@
  * @module UnflagUnbilledLicencesService
  */
 
-const LicenceModel = require('../../models/water/licence.model.js')
+const LicenceModel = require('../../../models/water/licence.model.js')
 
 /**
  * Unflag any licences that were not billed as part of a bill run

app/services/supplementary-billing/initiate-billing-batch.service.js renamed to app/services/billing/supplementary/initiate-billing-batch.service.js

@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Things we need to stub
-const NewBillingBatchService = require('../../../app/services/supplementary-billing/new-billing-batch.service.js')
+const NewBillingBatchService = require('../../../app/services/billing/supplementary/new-billing-batch.service.js')
 const Boom = require('@hapi/boom')
 
 // For running our service

app/services/supplementary-billing/new-billing-batch.service.js renamed to app/services/billing/supplementary/new-billing-batch.service.js

@@ -9,7 +9,7 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const BillingPeriodsService = require('../../../app/services/supplementary-billing/billing-periods.service.js')
+const BillingPeriodsService = require('../../../../app/services/billing/supplementary/billing-periods.service.js')
 
 describe('Billing Periods service', () => {
   let clock

app/services/supplementary-billing/pre-generate-billing-data.service.js renamed to app/services/billing/supplementary/pre-generate-billing-data.service.js

@@ -8,12 +8,12 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const ChargeElementHelper = require('../../support/helpers/water/charge-element.helper.js')
-const ChargePurposeHelper = require('../../support/helpers/water/charge-purpose.helper.js')
-const DatabaseHelper = require('../../support/helpers/database.helper.js')
+const ChargeElementHelper = require('../../../support/helpers/water/charge-element.helper.js')
+const ChargePurposeHelper = require('../../../support/helpers/water/charge-purpose.helper.js')
+const DatabaseHelper = require('../../../support/helpers/database.helper.js')
 
 // Thing under test
-const CalculateAuthorisedAndBillableDaysService = require('../../../app/services/supplementary-billing/calculate-authorised-and-billable-days.service.js')
+const CalculateAuthorisedAndBillableDaysService = require('../../../../app/services/billing/supplementary/calculate-authorised-and-billable-days.service.js')
 
 // NOTE: You might find it helpful to refresh your understanding of abstraction periods and what the service is trying
 // to fathom when referencing them to the billing and charge periods. See the documentation in the service. Also, a

app/services/supplementary-billing/process-billing-batch.service.js renamed to app/services/billing/supplementary/process-billing-batch.service.js

@@ -8,11 +8,11 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const BillingBatchHelper = require('../../support/helpers/water/billing-batch.helper.js')
-const DatabaseHelper = require('../../support/helpers/database.helper.js')
+const BillingBatchHelper = require('../../../support/helpers/water/billing-batch.helper.js')
+const DatabaseHelper = require('../../../support/helpers/database.helper.js')
 
 // Thing under test
-const CheckLiveBillRunService = require('../../../app/services/supplementary-billing/check-live-bill-run.service.js')
+const CheckLiveBillRunService = require('../../../../app/services/billing/supplementary/check-live-bill-run.service.js')
 
 describe('Check Live Bill Run service', () => {
   let billRun

app/services/supplementary-billing/process-billing-period.service.js renamed to app/services/billing/supplementary/process-billing-period.service.js

@@ -8,7 +8,7 @@ const { describe, it } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const ConsolidateDateRangesService = require('../../../app/services/supplementary-billing/consolidate-date-ranges.service')
+const ConsolidateDateRangesService = require('../../../../app/services/billing/supplementary/consolidate-date-ranges.service')
 
 describe('ConsolidateDateRanges service', () => {
   describe('when the provided ranges are non-overlapping', () => {

app/services/supplementary-billing/process-billing-transactions.service.js renamed to app/services/billing/supplementary/process-billing-transactions.service.js

@@ -9,14 +9,14 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const BillingBatchHelper = require('../../support/helpers/water/billing-batch.helper.js')
-const BillingBatchModel = require('../../../app/models/water/billing-batch.model.js')
-const DatabaseHelper = require('../../support/helpers/database.helper.js')
-const EventModel = require('../../../app/models/water/event.model.js')
-const RegionHelper = require('../../support/helpers/water/region.helper.js')
+const BillingBatchHelper = require('../../../support/helpers/water/billing-batch.helper.js')
+const BillingBatchModel = require('../../../../app/models/water/billing-batch.model.js')
+const DatabaseHelper = require('../../../support/helpers/database.helper.js')
+const EventModel = require('../../../../app/models/water/event.model.js')
+const RegionHelper = require('../../../support/helpers/water/region.helper.js')
 
 // Thing under test
-const CreateBillingBatchEventService = require('../../../app/services/supplementary-billing/create-billing-batch-event.service.js')
+const CreateBillingBatchEventService = require('../../../../app/services/billing/supplementary/create-billing-batch-event.service.js')
 
 describe('Create Event service', () => {
   let clock

app/services/supplementary-billing/reissue-invoice.service.js renamed to app/services/billing/supplementary/reissue-invoice.service.js

@@ -8,13 +8,13 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const BillingBatchModel = require('../../../app/models/water/billing-batch.model.js')
-const DatabaseHelper = require('../../support/helpers/database.helper.js')
-const RegionHelper = require('../../support/helpers/water/region.helper.js')
-const RegionModel = require('../../../app/models/water/region.model.js')
+const BillingBatchModel = require('../../../../app/models/water/billing-batch.model.js')
+const DatabaseHelper = require('../../../support/helpers/database.helper.js')
+const RegionHelper = require('../../../support/helpers/water/region.helper.js')
+const RegionModel = require('../../../../app/models/water/region.model.js')
 
 // Thing under test
-const CreateBillingBatchService = require('../../../app/services/supplementary-billing/create-billing-batch.service.js')
+const CreateBillingBatchService = require('../../../../app/services/billing/supplementary/create-billing-batch.service.js')
 
 describe('Create Billing Batch service', () => {
   const financialYearEndings = { fromFinancialYearEnding: 2023, toFinancialYearEnding: 2024 }

app/services/supplementary-billing/reissue-invoices.service.js renamed to app/services/billing/supplementary/reissue-invoices.service.js

@@ -8,10 +8,10 @@ const { describe, it } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const BillingTransactionModel = require('../../../app/models/water/billing-transaction.model.js')
+const BillingTransactionModel = require('../../../../app/models/water/billing-transaction.model.js')
 
 // Thing under test
-const CreateBillingTransactionService = require('../../../app/services/supplementary-billing/create-billing-transaction.service.js')
+const CreateBillingTransactionService = require('../../../../app/services/billing/supplementary/create-billing-transaction.service.js')
 
 describe('Create billing transaction service', () => {
   const transactionData = {

app/services/supplementary-billing/reverse-billing-transactions.service.js renamed to app/services/billing/supplementary/reverse-billing-transactions.service.js

@@ -8,7 +8,7 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const DetermineChargePeriodService = require('../../../app/services/supplementary-billing/determine-charge-period.service.js')
+const DetermineChargePeriodService = require('../../../../app/services/billing/supplementary/determine-charge-period.service.js')
 
 describe('Determine charge period service', () => {
   const billingPeriod = {

app/services/supplementary-billing/send-billing-transactions.service.js renamed to app/services/billing/supplementary/send-billing-transactions.service.js

@@ -8,12 +8,12 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const ChangeReasonHelper = require('../../support/helpers/water/change-reason.helper.js')
-const ChargeVersionHelper = require('../../support/helpers/water/charge-version.helper.js')
-const DatabaseHelper = require('../../support/helpers/database.helper.js')
+const ChangeReasonHelper = require('../../../support/helpers/water/change-reason.helper.js')
+const ChargeVersionHelper = require('../../../support/helpers/water/charge-version.helper.js')
+const DatabaseHelper = require('../../../support/helpers/database.helper.js')
 
 // Thing under test
-const DetermineMinimumChargeService = require('../../../app/services/supplementary-billing/determine-minimum-charge.service.js')
+const DetermineMinimumChargeService = require('../../../../app/services/billing/supplementary/determine-minimum-charge.service.js')
 
 describe('Determine minimum charge service', () => {
   const chargePeriod = {