Self Employment Business API

The Self-Employment Business API allows software packages to:

• to create or amend a self-employment annual summary for a tax year.
• to delete the self-employment annual summary for a tax year.
• to retrieve a self-employment annual summary for a tax year.
• to create a self-employment periodic update for submission of periodic data
• to amend a self-employment periodic update.
• to retrieve a list of all self-employment update periods.
• to retrieve a single self-employment periodic update for a given identifier.

Requirements

• Scala 3.x.x
• Java 21
• sbt 1.10.x
• Service Manager V2

Development Setup

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

Start the service manager profile:

sm2 -start MTDFB_SELF_EMPLOYMENT_BUSINESS

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:7801/api/conf/5.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