simplify quote schedules

Author: simontreanor

io/out/GeneratedDate.html

@@ -1 +1 @@
-<p>Generated: <i>2025-05-22 18:35:34 +01:00</i> using library version: <i>2.5.0</i></p>
+<p>Generated: <i>2025-05-27 12:34:29 +01:00</i> using library version: <i>2.5.0</i></p>

src/Quotes.fs

@@ -34,18 +34,14 @@ module Quotes =
     type Quote = {
         // the quote result
         QuoteResult: QuoteResult
-        // a statement showing the schedule at the time the quote was generated
-        CurrentSchedules: GenerationResult
         // the revised schedule showing the settlement, if applicable
-        RevisedSchedules: GenerationResult
+        Schedules: GenerationResult
     }
 
     /// calculates a revised schedule showing the generated payment for the given quote type
     let getQuote (p: Parameters) (actualPayments: Map<int<OffsetDay>, ActualPayment array>) =
-        // generate a statement showing the current state of the amortisation schedule - this will only be used in the return value in case the caller requires a comparison
-        let currentSchedules = amortise p actualPayments
         // generate a revised statement showing a generated settlement figure on the relevant date
-        let revisedSchedules =
+        let schedules =
             amortise
                 {
                     p with
@@ -55,7 +51,7 @@ module Quotes =
                 actualPayments
         // try to get the schedule item containing the generated value
         let si =
-            revisedSchedules.AmortisationSchedule.ScheduleItems
+            schedules.AmortisationSchedule.ScheduleItems
             |> Map.values
             |> Seq.tryFind (fun si ->
                 match si.GeneratedPayment, si.PaymentStatus with
@@ -67,7 +63,7 @@ module Quotes =
             |> Option.defaultWith (fun () -> failwith "Unable to find relevant schedule item")
         // get an array of payments pending anywhere in the revised amortisation schedule
         let pendingPayments =
-            revisedSchedules.AmortisationSchedule.ScheduleItems
+            schedules.AmortisationSchedule.ScheduleItems
             |> Map.values
             |> Seq.sumBy (_.ActualPayments >> Array.sumBy ActualPayment.totalPending)
         // produce a quote result
@@ -135,6 +131,5 @@ module Quotes =
         // return the quote result
         {
             QuoteResult = quoteResult
-            CurrentSchedules = currentSchedules
-            RevisedSchedules = revisedSchedules
+            Schedules = schedules
         }

src/Refinancing.fs

@@ -179,7 +179,7 @@ module Refinancing =
 
         // append the new schedule to the old schedule up to the point of settlement
         let oldPaymentSchedule =
-            quote.RevisedSchedules.AmortisationSchedule.ScheduleItems
+            quote.Schedules.AmortisationSchedule.ScheduleItems
             |> Map.filter (fun _ si -> ScheduledPayment.isSome si.ScheduledPayment)
             |> Map.map (fun _ si -> si.ScheduledPayment)
             |> Map.toArray
@@ -210,7 +210,7 @@ module Refinancing =
 
         // return the results
         {|
-            OldSchedules = quote.RevisedSchedules
+            OldSchedules = quote.Schedules
             NewSchedules = rescheduledSchedules
         |}
 
@@ -308,6 +308,6 @@ module Refinancing =
 
         // return the results
         {|
-            OldSchedules = quote.RevisedSchedules
+            OldSchedules = quote.Schedules
             NewSchedules = rolledOverSchedules
         |}

tests/EdgeCaseTests.fs

@@ -81,7 +81,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote parameters1 actualPayments
 
-            quote.RevisedSchedules
+            quote.Schedules
             |> Schedule.outputHtmlToFile folder title description parameters1 ""
 
             quote.QuoteResult
@@ -125,8 +125,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote p actualPayments
 
-            quote.RevisedSchedules
-            |> Schedule.outputHtmlToFile folder title description p ""
+            quote.Schedules |> Schedule.outputHtmlToFile folder title description p ""
 
             quote.QuoteResult
 
@@ -169,8 +168,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote p actualPayments
 
-            quote.RevisedSchedules
-            |> Schedule.outputHtmlToFile folder title description p ""
+            quote.Schedules |> Schedule.outputHtmlToFile folder title description p ""
 
             quote.QuoteResult
 
@@ -287,8 +285,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote p actualPayments
 
-            quote.RevisedSchedules
-            |> Schedule.outputHtmlToFile folder title description p ""
+            quote.Schedules |> Schedule.outputHtmlToFile folder title description p ""
 
             quote.QuoteResult
 
@@ -426,8 +423,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote p actualPayments
 
-            quote.RevisedSchedules
-            |> Schedule.outputHtmlToFile folder title description p ""
+            quote.Schedules |> Schedule.outputHtmlToFile folder title description p ""
 
             quote.QuoteResult
 
@@ -560,7 +556,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote parameters2 actualPayments
 
-            quote.RevisedSchedules
+            quote.Schedules
             |> Schedule.outputHtmlToFile folder title description parameters2 ""
 
             quote.QuoteResult
@@ -619,8 +615,7 @@ module EdgeCaseTests =
         let actual =
             let quote = getQuote p actualPayments
 
-            quote.RevisedSchedules
-            |> Schedule.outputHtmlToFile folder title description p ""
+            quote.Schedules |> Schedule.outputHtmlToFile folder title description p ""
 
             quote.QuoteResult