individuals-state-benefits-api

The Individuals State Benefits API allows a developer to:

• list and retrieve state benefits
• create or amend customer added state benefits
• delete customer added state benefits
• create or amend benefits financial data
• mark a state benefit as ignored

For certain scenarios, a request may not be made for a tax year which has not yet ended. This includes:

• creating, or amending a customer added state benefit
• ignoring a HMRC held state benefit
• amending state benefit amounts for benefit types which are not Job Seekers Allowance (JSA) or Employment Support Allowance (ESA)

Requirements

• Scala 2.13.x
• Java 11
• sbt 1.9.x
• Service Manager V2

Development Setup

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

Start the service manager profile: sm2 --start MTDFB_INDIVIDUALS_STATE_BENEFITS

Run Tests

Run unit tests: sbt test

Run integration tests: sbt it:test

To view the OAS

To view documentation locally, ensure the Individuals State Benefits 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:7789/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