-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from hmrc/feature/YTA-2946/annual-statement
Feature/yta 2946/annual statement
- Loading branch information
Showing
26 changed files
with
1,361 additions
and
185 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
app/uk/gov/hmrc/epayeapi/controllers/GetAnnualStatementController.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright 2017 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. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.epayeapi.controllers | ||
|
|
||
| import javax.inject.{Inject, Singleton} | ||
|
|
||
| import akka.stream.Materializer | ||
| import play.api.Logger | ||
| import play.api.libs.json.Json | ||
| import play.api.mvc.{Action, EssentialAction} | ||
| import uk.gov.hmrc.auth.core.AuthConnector | ||
| import uk.gov.hmrc.domain.EmpRef | ||
| import uk.gov.hmrc.epayeapi.connectors.EpayeConnector | ||
| import uk.gov.hmrc.epayeapi.models.Formats._ | ||
| import uk.gov.hmrc.epayeapi.models.in._ | ||
| import uk.gov.hmrc.epayeapi.models.out.ApiError.EmpRefNotFound | ||
| import uk.gov.hmrc.epayeapi.models.out.{AnnualStatementJson, ApiError} | ||
|
|
||
| import scala.concurrent.ExecutionContext | ||
|
|
||
| @Singleton | ||
| case class GetAnnualStatementController @Inject()( | ||
| authConnector: AuthConnector, | ||
| epayeConnector: EpayeConnector, | ||
| implicit val ec: ExecutionContext, | ||
| implicit val mat: Materializer | ||
| ) | ||
| extends ApiController { | ||
|
|
||
| def getAnnualStatement(empRef: EmpRef, taxYear: TaxYear): EssentialAction = EmpRefAction(empRef) { | ||
| Action.async { request => | ||
| epayeConnector.getAnnualStatement(empRef, taxYear, hc(request)).map { | ||
| case ApiSuccess(epayeAnnualStatement) => | ||
| Ok(Json.toJson(AnnualStatementJson(empRef, taxYear, epayeAnnualStatement))) | ||
| case ApiJsonError(err) => | ||
| Logger.error(s"Upstream returned invalid json: $err") | ||
| InternalServerError(Json.toJson(ApiError.InternalServerError)) | ||
| case ApiNotFound() => | ||
| NotFound(Json.toJson(EmpRefNotFound)) | ||
| case error: ApiResponse[_] => | ||
| Logger.error(s"Error while fetching totals: $error") | ||
| InternalServerError(Json.toJson(ApiError.InternalServerError)) | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
160 changes: 160 additions & 0 deletions
160
app/uk/gov/hmrc/epayeapi/models/out/AnnualStatementJson.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| /* | ||
| * Copyright 2017 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. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.epayeapi.models.out | ||
|
|
||
| import org.joda.time.LocalDate | ||
| import uk.gov.hmrc.domain.EmpRef | ||
| import uk.gov.hmrc.epayeapi.models.in.{EpayeAnnualStatement, LineItem, TaxYear} | ||
|
|
||
| case class TaxYearJson(year: String, firstDay: LocalDate, lastDay: LocalDate) | ||
|
|
||
| case class PeriodJson(firstDay: LocalDate, lastDay: LocalDate) | ||
|
|
||
| case class NonRtiChargesJson( | ||
| code: String, | ||
| amount: BigDecimal, | ||
| clearedByCredits: BigDecimal, | ||
| clearedByPayments: BigDecimal, | ||
| balance: BigDecimal, | ||
| dueDate: LocalDate | ||
| ) | ||
|
|
||
| object NonRtiChargesJson { | ||
| def from(lineItem: LineItem, taxYear: TaxYear): Option[NonRtiChargesJson] = { | ||
| for { | ||
| code <- lineItem.codeText | ||
| } yield NonRtiChargesJson( | ||
| code = code, | ||
| amount = lineItem.charges.debit, | ||
| clearedByCredits = lineItem.cleared.credit, | ||
| clearedByPayments = lineItem.cleared.payment, | ||
| balance = lineItem.balance.debit, | ||
| dueDate = lineItem.dueDate) | ||
| } | ||
| } | ||
|
|
||
| case class PaymentsAndCreditsJson( | ||
| payments: BigDecimal, | ||
| credits: BigDecimal | ||
| ) | ||
|
|
||
| case class EarlierYearUpdateJson( | ||
| amount: BigDecimal, | ||
| clearedByCredits: BigDecimal, | ||
| clearedByPayments: BigDecimal, | ||
| balance: BigDecimal, | ||
| dueDate: LocalDate | ||
| ) | ||
|
|
||
| object EarlierYearUpdateJson { | ||
| def extractFrom(lineItems: Seq[LineItem]): Option[EarlierYearUpdateJson] = { | ||
| lineItems | ||
| .find(_.itemType.contains("eyu")) | ||
| .map { lineItem => | ||
| EarlierYearUpdateJson( | ||
| lineItem.charges.debit, | ||
| lineItem.cleared.credit, | ||
| lineItem.cleared.payment, | ||
| lineItem.balance.debit, | ||
| lineItem.dueDate | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| case class EmbeddedRtiChargesJson( | ||
| earlierYearUpdate: Option[EarlierYearUpdateJson], | ||
| rtiCharges: Seq[MonthlyChargesJson] | ||
| ) | ||
|
|
||
| case class MonthlyChargesJson( | ||
| taxMonth: TaxMonthJson, | ||
| amount: BigDecimal, | ||
| clearedByCredits: BigDecimal, | ||
| clearedByPayments: BigDecimal, | ||
| balance: BigDecimal, | ||
| dueDate: LocalDate, | ||
| isSpecified: Boolean, | ||
| _links: SelfLink | ||
| ) | ||
|
|
||
| object MonthlyChargesJson { | ||
|
|
||
| def from(lineItem: LineItem, empRef: EmpRef, taxYear: TaxYear): Option[MonthlyChargesJson] = { | ||
| for { | ||
| taxMonth <- lineItem.taxMonth | ||
| } yield MonthlyChargesJson( | ||
| taxMonth = TaxMonthJson(taxMonth.month, taxMonth.firstDay(taxYear), taxMonth.lastDay(taxYear)), | ||
| amount = lineItem.charges.debit, | ||
| clearedByCredits = lineItem.cleared.credit, | ||
| clearedByPayments = lineItem.cleared.payment, | ||
| balance = lineItem.balance.debit, | ||
| dueDate = lineItem.dueDate, | ||
| isSpecified = lineItem.isSpecified, | ||
| _links = SelfLink(Link(s"${AnnualStatementJson.baseUrlFor(empRef)}/statements/${taxYear.asString}/${taxMonth.month}")) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| case class TaxMonthJson( | ||
| number: Int, | ||
| firstDay: LocalDate, | ||
| lastDay: LocalDate | ||
| ) | ||
| case class SelfLink( | ||
| self: Link | ||
| ) | ||
|
|
||
| case class AnnualStatementLinksJson( | ||
| empRefs: Link, | ||
| statements: Link, | ||
| self: Link, | ||
| next: Link, | ||
| previous: Link | ||
| ) | ||
|
|
||
| case class AnnualStatementJson( | ||
| taxYear: TaxYearJson, | ||
| nonRtiCharges: Seq[NonRtiChargesJson], | ||
| _embedded: EmbeddedRtiChargesJson, | ||
| _links: AnnualStatementLinksJson | ||
| ) | ||
|
|
||
| object AnnualStatementJson { | ||
| val baseUrl = "/organisations/paye" | ||
|
|
||
| def baseUrlFor(empRef: EmpRef): String = | ||
| s"$baseUrl/${empRef.taxOfficeNumber}/${empRef.taxOfficeReference}" | ||
|
|
||
| def apply(empRef: EmpRef, taxYear: TaxYear, epayeAnnualStatement: EpayeAnnualStatement): AnnualStatementJson = | ||
| AnnualStatementJson( | ||
| taxYear = TaxYearJson(taxYear.asString, taxYear.firstDay, taxYear.lastDay), | ||
| _embedded = EmbeddedRtiChargesJson( | ||
| EarlierYearUpdateJson.extractFrom(epayeAnnualStatement.rti.lineItems), | ||
| epayeAnnualStatement.rti.lineItems.flatMap(MonthlyChargesJson.from(_, empRef, taxYear)) | ||
| ), | ||
| nonRtiCharges = epayeAnnualStatement.nonRti.lineItems.flatMap(NonRtiChargesJson.from(_, taxYear)), | ||
| _links = AnnualStatementLinksJson( | ||
| empRefs = Link(baseUrl), | ||
| statements = Link(s"${baseUrlFor(empRef)}/statements"), | ||
| self = Link(s"${baseUrlFor(empRef)}/statements/${taxYear.asString}"), | ||
| next = Link(s"${baseUrlFor(empRef)}/statements/${taxYear.next.asString}"), | ||
| previous = Link(s"${baseUrlFor(empRef)}/statements/${taxYear.previous.asString}") | ||
| ) | ||
| ) | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.