individuals-other-income-api

The Individuals Other Income API allows a developer to create, amend, retrieve and delete data relating to Other Income.

Requirements

• Scala 2.13.x
• Java 11
• sbt 1.7.x
• Service Manager

Development Setup

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

Start the service manager profile: sm --start MTDFB_INDIVIDUALS_OTHER_INCOME

Run Tests

Run unit tests: sbt test

Run integration tests: sbt it:test

Viewing Open API Spec (OAS) docs

To view documentation locally, ensure the 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 this port and version: http://localhost:7761/api/conf/1.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