/cis-deductions-api

Primary LanguageScalaApache License 2.0Apache-2.0

CIS Deductions API

The CIS Deductions API allows a developer to create, retrieve, amend and delete CIS deductions for a subcontractor.

Requirements

Running the microservice

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

Start the service manager profile: sm --start CIS_DEDUCTIONS_ALL

Running tests

Run unit tests: sbt test

Run integration tests: sbt it:test

Vieweing OAS

To view documentation locally ensure the CIS Deductions 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:7781/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