self-assessment-assist-api

The Self-Assessment-Assist API allows a developer to:

• retrieve a HMRC Assist report for a given customer with a list of messages for the customer
• securely generate a report that is sent to or displayed after it has been generated
• allow the client to acknowledge the report

Requirements

• Scala 2.13.8
• Java 11
• sbt 1.7.2
• Service Manager

Development Setup

Run the microservice from the console using: sbt run (starts on port 8342)

Start the service manager profile: sm2 --start SELF_ASSESSMENT_ASSIST_ALL

Run Tests

Run unit tests: sbt test

Run integration tests: sbt it:test

Local Dev and QA Test Instructions

The QA test instruction documentation for local, QA and dev journeys (individual and agent) can be seen here.

To view the OAS documentation

To view documentation locally, ensure the Self Assessment Assist API is running.

Then go to http://localhost:9680/api-documentation/docs/openapi/preview and enter the full URL path to the YAML file with the appropriate port and version:

http://localhost:8342/api/conf/1.0/application.yaml

Runbook

You can access the ITSA/HMRC Assist Runbook here.

Support and Reporting Issues

• You can raise non-technical or platform-related issues with the Software Development Support Team

API Reference / Documentation

Available on the HMRC Developer Hub

License

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