Skip to content

hmrc/individual-calculations-api

Repository files navigation

individual-calculations-api

Apache-2.0 license

The Individual Calculations API allows a developer to:

  • trigger a self-assessment tax calculation
  • list all their self-assessment tax calculations for a tax year
  • retrieve their self-assessment tax calculation result using multiple endpoints

Requirements

Development Setup

Run the microservice from the console using: sbt run (starts on port 9767 by default)

Start the service manager profile: sm2 --start MTDFB_CALC

Run Tests

Run unit tests: sbt test

Run integration tests: sbt it:test

Viewing OAS

To view documentation locally ensure the Individual Calculations API is running, and run api-documentation-frontend:

./run_local_with_dependencies.sh

Then go to http://localhost:9680/api-documentation/docs/openapi/preview and use the appropriate port and version:

http://localhost:9767/api/conf/6.0/application.yaml

Changelog

You can see our changelog here

Support and Reporting Issues

You can create a GitHub issue here

API Reference / Documentation

Available on the HMRC Developer Hub

License

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