This version is in alpha - expect extensive breaking changes.
Individual Losses (MTD) API
|Available in Sandbox||Yes|
|Sandbox base URL||https://test-api.service.hmrc.gov.uk|
|Available in Production||No|
These resources allow software packages to provide a taxpayer's financial data for their brought forward losses and loss claims.
You can find the changelog in the individual-losses-api GitHub wiki.
It may not be possible to test all scenarios in the sandbox. You can test some scenarios by passing the Gov-Test-Scenario header. Documentation for each endpoint includes a Test data section, which explains the scenarios that you can simulate using the Gov-Test-Scenario header.
If you have a specific testing need that is not supported in the sandbox, contact our support team.
Some APIs may be marked [test only]. This means that they are not available for use in production and may change.
When an API changes in a way that is backwards-incompatible, we increase the version number of the API. See our reference guide for more on versioning.
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
- 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response. See our reference guide for more on errors.
Brought Forward Losses
These resources allow software packages to provide a taxpayer's financial data for their brought forward losses. Here the developer can:
- Provide a list of brought forward losses
- Create a new brought forward loss to submit against Self-employment, Self-employment class 4, UK FHL property and UK other (Non-FHL) property
- Show a single brought forward loss
- Delete an existing brought forward loss
- Update an existing brought forward loss
Brought Forward Losses resources
These resources allow software packages to provide a taxpayer's financial data for their loss claims. Here the developer can:
- Provide a list of loss claims
- Create a Loss Claim against an income source for a specific tax year
- Show the detail of an existing loss claim
- Delete a previously entered loss claim
- Update a previously entered loss claim