YTA-3164 - Retrieve Write Off Information

hmrc · Jan 11, 2018 · af90612 · af90612
1 parent 12ea7b3
commit af90612
Show file tree

Hide file tree

Showing 70 changed files with 228 additions and 113 deletions.
diff --git a/app/uk/gov/hmrc/epayeapi/MicroserviceHelloWorld.scala b/app/uk/gov/hmrc/epayeapi/MicroserviceHelloWorld.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/config/AppContext.scala b/app/uk/gov/hmrc/epayeapi/config/AppContext.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/config/EpayeApiAppLoader.scala b/app/uk/gov/hmrc/epayeapi/config/EpayeApiAppLoader.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/config/microserviceGlobal.scala b/app/uk/gov/hmrc/epayeapi/config/microserviceGlobal.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/config/microserviceWiring.scala b/app/uk/gov/hmrc/epayeapi/config/microserviceWiring.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/connectors/ConnectorBase.scala b/app/uk/gov/hmrc/epayeapi/connectors/ConnectorBase.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/connectors/EpayeConnector.scala b/app/uk/gov/hmrc/epayeapi/connectors/EpayeConnector.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/connectors/ServiceLocatorConnector.scala b/app/uk/gov/hmrc/epayeapi/connectors/ServiceLocatorConnector.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/connectors/stub/FakeAuthConnector.scala b/app/uk/gov/hmrc/epayeapi/connectors/stub/FakeAuthConnector.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/controllers/ApiController.scala b/app/uk/gov/hmrc/epayeapi/controllers/ApiController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/controllers/DocumentationController.scala b/app/uk/gov/hmrc/epayeapi/controllers/DocumentationController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/controllers/GetAnnualStatementController.scala b/app/uk/gov/hmrc/epayeapi/controllers/GetAnnualStatementController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/controllers/GetEmpRefsController.scala b/app/uk/gov/hmrc/epayeapi/controllers/GetEmpRefsController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/controllers/GetMonthlyStatementController.scala b/app/uk/gov/hmrc/epayeapi/controllers/GetMonthlyStatementController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/controllers/GetSummaryController.scala b/app/uk/gov/hmrc/epayeapi/controllers/GetSummaryController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/Formats.scala b/app/uk/gov/hmrc/epayeapi/models/Formats.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/TaxMonth.scala b/app/uk/gov/hmrc/epayeapi/models/TaxMonth.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/TaxYear.scala b/app/uk/gov/hmrc/epayeapi/models/TaxYear.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeAnnualStatement.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeAnnualStatement.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@ case class LineItem(
   charges: BigDecimal,
   payments: BigDecimal,
   credits: BigDecimal,
+  writeOffs: BigDecimal,
   balance: BigDecimal,
   dueDate: LocalDate,
   isSpecified: Boolean = false,
@@ -36,6 +37,7 @@ case class AnnualTotal(
   charges: BigDecimal,
   payments: BigDecimal,
   credits: BigDecimal,
+  writeOffs: BigDecimal,
   balance: BigDecimal
 )
 

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeCode.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeCode.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeMonthlyStatement.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeMonthlyStatement.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@ case class EpayeMonthlyStatement(
   charges: EpayeMonthlyCharges,
   credits: EpayeMonthlyCredits,
   payments: EpayeMonthlyPaymentDetails,
+  writeOffs: EpayeMonthlyChargesDetails,
   hasSpecifiedCharges: Boolean,
   balance: EpayeMonthlyBalance
 )

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeReads.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeReads.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeResponse.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeResponse.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeTaxMonth.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeTaxMonth.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/in/EpayeTotalsResponse.scala b/app/uk/gov/hmrc/epayeapi/models/in/EpayeTotalsResponse.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/AnnualStatementJson.scala b/app/uk/gov/hmrc/epayeapi/models/out/AnnualStatementJson.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@ case class NonRtiChargesJson(
   amount: BigDecimal,
   clearedByCredits: BigDecimal,
   clearedByPayments: BigDecimal,
+  clearedByWriteOffs: BigDecimal,
   balance: BigDecimal,
   dueDate: LocalDate
 )
@@ -41,21 +42,18 @@ object NonRtiChargesJson {
       amount = lineItem.charges,
       clearedByCredits = lineItem.credits,
       clearedByPayments = lineItem.payments,
+      clearedByWriteOffs = lineItem.writeOffs,
       balance = lineItem.balance,
       dueDate = lineItem.dueDate
     )
   }
 }
 
-case class PaymentsAndCreditsJson(
-  payments: BigDecimal,
-  credits: BigDecimal
-)
-
 case class EarlierYearUpdateJson(
   amount: BigDecimal,
   clearedByCredits: BigDecimal,
   clearedByPayments: BigDecimal,
+  clearedByWriteOffs: BigDecimal,
   balance: BigDecimal,
   dueDate: LocalDate
 )
@@ -66,11 +64,12 @@ object EarlierYearUpdateJson {
       .find(_.itemType.contains("eyu"))
       .map { lineItem =>
         EarlierYearUpdateJson(
-          lineItem.charges,
-          lineItem.credits,
-          lineItem.payments,
-          lineItem.balance,
-          lineItem.dueDate
+          amount = lineItem.charges,
+          clearedByCredits = lineItem.credits,
+          clearedByPayments = lineItem.payments,
+          clearedByWriteOffs = lineItem.writeOffs,
+          balance = lineItem.balance,
+          dueDate = lineItem.dueDate
         )
       }
   }
@@ -86,6 +85,7 @@ case class MonthlyChargesJson(
   amount: BigDecimal,
   clearedByCredits: BigDecimal,
   clearedByPayments: BigDecimal,
+  clearedByWriteOffs: BigDecimal,
   balance: BigDecimal,
   dueDate: LocalDate,
   isSpecified: Boolean,
@@ -103,6 +103,7 @@ object MonthlyChargesJson {
       amount = lineItem.charges,
       clearedByCredits = lineItem.credits,
       clearedByPayments = lineItem.payments,
+      clearedByWriteOffs = lineItem.writeOffs,
       balance = lineItem.balance,
       dueDate = lineItem.dueDate,
       isSpecified = lineItem.isSpecified,

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/ApiErrorJson.scala b/app/uk/gov/hmrc/epayeapi/models/out/ApiErrorJson.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/EmpRefsJson.scala b/app/uk/gov/hmrc/epayeapi/models/out/EmpRefsJson.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/JsonWrites.scala b/app/uk/gov/hmrc/epayeapi/models/out/JsonWrites.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -58,7 +58,6 @@ trait JsonWrites {
   implicit lazy val selfLinkWrites: Writes[SelfLink] = writes[SelfLink]
   implicit lazy val monthlyChargesJsonWrites: Writes[MonthlyChargesJson] = writes[MonthlyChargesJson]
   implicit lazy val embeddedRtiChargesJsonWrites: Writes[EmbeddedRtiChargesJson] = writes[EmbeddedRtiChargesJson]
-  implicit lazy val paymentsAndCreditsJsonWrites: Writes[PaymentsAndCreditsJson] = writes[PaymentsAndCreditsJson]
   implicit lazy val earlierYearUpdateJsonWrites: Writes[EarlierYearUpdateJson] = writes[EarlierYearUpdateJson]
   implicit lazy val periodJsonWrites: Writes[PeriodJson] = writes[PeriodJson]
   implicit lazy val nonRtiChargesJsonWrites: Writes[NonRtiChargesJson] = writes[NonRtiChargesJson]

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/Link.scala b/app/uk/gov/hmrc/epayeapi/models/out/Link.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/MonthlyStatementJson.scala b/app/uk/gov/hmrc/epayeapi/models/out/MonthlyStatementJson.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,7 +30,8 @@ case class MonthlyStatementJson(
   interest: Seq[ChargeJson],
   allocatedCredits: Seq[ChargeJson],
   allocatedPayments: Seq[PaymentJson],
-  dueDate: LocalDate,
+  writeOffs: Seq[ChargeJson],
+dueDate: LocalDate,
   summary: MonthlySummaryJson,
   _links: MonthlyStatementLinksJson
 )
@@ -50,6 +51,7 @@ case class MonthlySummaryJson(
   interest: BigDecimal,
   clearedByCredits: BigDecimal,
   clearedByPayments: BigDecimal,
+  clearedByWriteOffs: BigDecimal,
   balance: BigDecimal
 )
 
@@ -73,6 +75,7 @@ object MonthlyStatementJson {
       interest = if (json.charges.others == 0) Seq.empty else Seq(ChargeJson("INTEREST", json.charges.others)),
       allocatedCredits = Charges(json.credits.fps) ++ Charges(json.credits.cis) ++ Charges(json.credits.eps),
       allocatedPayments = Payments(json.payments),
+      writeOffs = Charges(json.writeOffs),
       dueDate = json.balance.dueDate,
       summary = MonthlySummaryJson(json),
       _links = MonthlyStatementLinksJson(apiBaseUrl, empRef, taxYear, taxMonth)
@@ -102,11 +105,12 @@ object PaymentJson {
 object MonthlySummaryJson {
   def apply(json: EpayeMonthlyStatement): MonthlySummaryJson =
     MonthlySummaryJson(
-      json.charges.total - json.charges.others,
-      json.charges.others,
-      json.credits.total,
-      json.payments.total,
-      json.balance.total
+      amount = json.charges.total - json.charges.others,
+      interest = json.charges.others,
+      clearedByCredits = json.credits.total,
+      clearedByPayments = json.payments.total,
+      clearedByWriteOffs = json.writeOffs.total,
+      balance = json.balance.total
     )
 }
 

diff --git a/app/uk/gov/hmrc/epayeapi/models/out/SummaryJson.scala b/app/uk/gov/hmrc/epayeapi/models/out/SummaryJson.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/modules/AppModule.scala b/app/uk/gov/hmrc/epayeapi/modules/AppModule.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/router/ApiRouter.scala b/app/uk/gov/hmrc/epayeapi/router/ApiRouter.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/router/RoutesProvider.scala b/app/uk/gov/hmrc/epayeapi/router/RoutesProvider.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/uk/gov/hmrc/epayeapi/syntax/JsonOps.scala b/app/uk/gov/hmrc/epayeapi/syntax/JsonOps.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 HM Revenue & Customs
+ * Copyright 2018 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/conf/application.conf b/conf/application.conf
@@ -1,4 +1,4 @@
-# Copyright 2017 HM Revenue & Customs
+# Copyright 2018 HM Revenue & Customs
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.