v1
latestOpenAPI 3.0.32026-07-13339240.9 KBDelete a Property Annual Submission
This endpoint allows the developer to delete the adjustments and allowances for a UK or Foreign property business in a tax year. A National Insurance number, business ID and tax year must be provided.
Test data
Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.
| Header Value (Gov-Test-Scenario) | Scenario |
|---|---|
| N/A - DEFAULT | Simulate success response. |
| NOT_FOUND | Simulates the scenario where no data is found. |
| STATEFUL | Performs a stateful delete. |
| OUTSIDE_AMENDMENT_WINDOW | Simulates the scenario where request cannot be completed as it is outside the amendment window. |
Path parameters
National Insurance number, in the format AA999999A.
An identifier for the business, unique to the customer.<p>Must conform to the regular expression ^X[A-Z0-9]{1}IS[0-9]{11}$
The tax year to which the data applies. For example: 2022-23. The start year and end year must not span two tax years. The minimum tax year is 2022-23. No gaps are allowed, for example, 2022-24 is not valid. (The minimum tax year in Sandbox is 2021-22.)
Headers
Specifies the response format and the version of the API to be used.
An OAuth 2.0 Bearer Token with the write:self-assessment scope.
Only in sandbox environment. See Test Data table for all header values.
Response
Success(No Content)