Individuals Charges API

This API allows software packages to show and provide a taxpayers' financial data for their charges.

For pension charges a developer can:

• Retrieve Pension Charges
• Create and Amend Pension Charges
• Delete Pension Charges

For high income child benefit charges a developer can:

• Retrieve High Income Child Benefit Charge
• Create or Amend High Income Child Benefit Charge
• Delete High Income Child Benefit Charge

Requirements

• Scala 3.5.x
• Java 11
• sbt 1.10.10
• Service Manager V2

Development Setup

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

Start the service manager profile: sm2 --start MTDFB_CHARGES

Running tests

sbt test
sbt it/test

Viewing OAS

To view documentation locally ensure the Charges 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:9765/api/conf/3.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 Individuals Charges Documentation

License

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