MMCA-4919 | Made reasonForSecurity as an option (#142)

hmrc · Sep 12, 2024 · 19cd4df · 19cd4df
1 parent 0d25f04
commit 19cd4df
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 8 deletions.
diff --git a/app/models/TaxGroup.scala b/app/models/TaxGroup.scala
@@ -20,7 +20,7 @@ import play.api.libs.json.{Json, OFormat}
 
 case class TaxGroup(taxGroupDescription: TaxGroupType, amount: BigDecimal, taxTypes: Seq[TaxType])
 
-case class TaxType(reasonForSecurity: String, taxTypeID: String, amount: BigDecimal)
+case class TaxType(reasonForSecurity: Option[String], taxTypeID: String, amount: BigDecimal)
 
 object TaxType {
   implicit val format: OFormat[TaxType] = Json.format[TaxType]

diff --git a/test/models/DeclarationSpec.scala b/test/models/DeclarationSpec.scala
@@ -71,7 +71,7 @@ class DeclarationSpec extends SpecBase {
     val declarantReference = "UCR12345"
     val secureMovementReferenceNumber = "5a71a767-5c1c-4df8-8eef-2b83769b8fda"
 
-    val taxTypes: Seq[TaxType] = Seq(TaxType(reasonForSecurity = "Reason", taxTypeID = "50", amount = thousand))
+    val taxTypes: Seq[TaxType] = Seq(TaxType(reasonForSecurity = Some("Reason"), taxTypeID = "50", amount = thousand))
 
     val declarations: Declaration = Declaration(
       movementReferenceNumber = movementReferenceNumber,

diff --git a/test/models/TaxGroupSpec.scala b/test/models/TaxGroupSpec.scala
@@ -25,7 +25,7 @@ class TaxGroupSpec extends SpecBase {
 
     "serialize and deserialize TaxType correctly" in new Setup {
 
-      val expectedTaxType: TaxType = TaxType("Reason", "VAT", hundred)
+      val expectedTaxType: TaxType = TaxType(Some("Reason"), "VAT", hundred)
       val serialized: JsValue = Json.toJson(expectedTaxType)
       val deserialized: TaxType = serialized.as[TaxType]
 
@@ -88,7 +88,7 @@ class TaxGroupSpec extends SpecBase {
     val twoHundred: BigDecimal = BigDecimal(200.50)
     val fiveHundred: BigDecimal = BigDecimal(500.00)
 
-    val taxType: TaxType = TaxType("Reason", "VAT", hundred)
+    val taxType: TaxType = TaxType(Some("Reason"), "VAT", hundred)
 
     val taxGroup: TaxGroup = TaxGroup(
       taxGroupDescription = CustomsDuty,

diff --git a/test/viewmodels/CashTransactionCsvRowSpec.scala b/test/viewmodels/CashTransactionCsvRowSpec.scala
@@ -46,7 +46,17 @@ class CashTransactionCsvRowSpec extends SpecBase {
       TaxGroup(ExciseDuty, -3.45, taxTypes))
 
     val declarations: Seq[Declaration] =
-      Seq(Declaration("someMRN", Some("someImporterEORI"), "someEORI", None, dateWithDay4, -1234.56, taxGroups, Some(sMRN)))
+      Seq(
+        Declaration("someMRN",
+          Some("someImporterEORI"),
+          "someEORI",
+          None,
+          dateWithDay4,
+          -1234.56,
+          taxGroups,
+          Some(sMRN)
+        )
+      )
 
     override val dailyStatement: CashDailyStatement =
       CashDailyStatement(dateWithDay4, amountZero, amountZero, declarations, Nil)
@@ -198,7 +208,12 @@ class CashTransactionCsvRowSpec extends SpecBase {
     val dateWithDay4: LocalDate = LocalDate.of(year2020, month3, day4)
     val dateForDailyStatement: LocalDate = LocalDate.of(year2020, month3, day4)
 
-    val taxTypes: Seq[TaxType] = Seq(TaxType(reasonForSecurity = "Reason", taxTypeID = "50", amount = fiveHundred))
+    val taxTypes: Seq[TaxType] = Seq(
+      TaxType(
+        reasonForSecurity = Some("Reason"),
+        taxTypeID = "50",
+        amount = fiveHundred
+      ))
 
     val dailyStatement: CashDailyStatement =
       CashDailyStatement(dateForDailyStatement, amountZero, amountZero, Nil, Seq(transferIn))

diff --git a/test/viewmodels/DeclarationDetailViewModelSpec.scala b/test/viewmodels/DeclarationDetailViewModelSpec.scala
@@ -161,7 +161,7 @@ class DeclarationDetailViewModelSpec extends SpecBase {
     val declarantReference: Option[String] = Some("UCR12345")
     val secureMovementReferenceNumber: Option[String] = Some("5a71a767-5c1c-4df8-8eef-2b83769b8fda")
 
-    val taxTypes: Seq[TaxType] = Seq(TaxType(reasonForSecurity = "Reason", taxTypeID = "50", amount = hundred))
+    val taxTypes: Seq[TaxType] = Seq(TaxType(reasonForSecurity = Some("Reason"), taxTypeID = "50", amount = hundred))
 
     val declaration: Declaration = Declaration(
       movementReferenceNumber = movementReferenceNumber,

diff --git a/test/views/CashAccountDeclarationDetailsSpec.scala b/test/views/CashAccountDeclarationDetailsSpec.scala
@@ -74,7 +74,12 @@ class CashAccountDeclarationDetailsSpec extends ViewTestHelper {
     val declarantEori = "GB987654321000"
     val declarantReference: Option[String] = Some("UCR12345")
 
-    val taxTypes: Seq[TaxType] = Seq(TaxType(reasonForSecurity = "Reason", taxTypeID = "50", amount = fourHundred))
+    val taxTypes: Seq[TaxType] = Seq(
+      TaxType(
+        reasonForSecurity = Some("Reason"),
+        taxTypeID = "50",
+        amount = fourHundred
+      ))
 
     val declaration: Declaration = Declaration(
       movementReferenceNumber = movementReferenceNumber,