Obligations API

The Obligations API allows software packages to:

• retrieve obligations for a user's business income sources
• retrieve the crystallisation obligations for a user's Income Tax account
• retrieve the End of Period Statement obligations for a user's business income sources

Requirements

• Scala 3.5.x
• Java 21
• sbt 1.10.x
• Service manager V2

Development Setup

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

Start the service manager profile:

sm2 --start MTDFB_OBLIGATIONS

Run Tests

Run unit tests: sbt test

Run integration tests: sbt it/test

View OpenAPI Specification (OAS) documentation

To view the OpenAPI documentation locally, ensure the API is running.

Start the api-documentation-frontend and api-definition services using the Service Manager profile:

sm2 -start DEVHUB_PREVIEW_OPENAPI

Then navigate to the preview page:

http://localhost:9680/api-documentation/docs/openapi/preview

Enter the specification URL using the appropriate port and API version:

http://localhost:7793/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 HMRC Developer Hub

License

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