This service provides the frontend endpoint for the TAI microservice. This service allows users to view and edit their paye tax information.

This service covers the current tax year. Use the service to:

• check your tax code and Personal Allowance
• tell HM Revenue and Customs (HMRC) about changes that affect your tax code
• update your employer or pension provider details
• see an estimate of how much tax you’ll pay over the whole tax year
• check and change the estimates of how much income you’ll get from your jobs, pensions or bank and building society savings interest

This service is written in Scala 2.13 and Play 3.0, so needs at least a JRE 21 to run.

• Unit test the entire test suite: sbt test

• Unit test a single spec file: sbt "test:testOnly *fileName" (for e.g : sbt "test:testOnly *AddEmploymentControllerSpec")

• sbt it/test

To verify the acceptance tests locally, follow the steps:

• start the sm2 container for TAI profile: sm2 --start TAI_ALL
• stop TAI_FRONTEND process running in sm2: sm2 --stop TAI_FRONTEND
• launch tai-frontend in terminal and execute the following command in the tai-frontend project directory:
  sbt "run -Dapplication.router=testOnlyDoNotUseInAppConf.Routes"
• open tai-acceptance-test-suite repository in the terminal and execute the script: ./run_tests_local.sh

These are authenticated so you must login via auth login stub before calling these GETs.

• http://localhost:9230/check-income-tax/test-only/v1/api/employment/employee/tax-year/:taxYear/employment-details
• http://localhost:9230/check-income-tax/test-only/v1/api/person/tax-account/:taxYear
• http://localhost:9230/check-income-tax/test-only/v1/api/iabd/taxpayer/tax-year/:taxYear

In the context of this service we use the following acronyms:

• SCA: Single Customer Account

• JRS: Job Retention Scheme

• NPS: National Insurance and PAYE Service

• API: Application Programming Interface

• HoD: Head of Duty

• JRE: Java Runtime Environment

• JSON: JavaScript Object Notation

• URL: Uniform Resource Locator

This code is open source software licensed under the Apache 2.0 License.