Property Business (MTD) API
| Available in Sandbox | Yes |
|---|---|
| Sandbox base URL | https://test-api.service.hmrc.gov.uk |
| Available in Production | No |
Overview
This API allows developers to:
- list, retrieve, create or amend an individual’s UK Property Income & Expenses Period Summaries
- retrieve, create, amend or delete an individual’s UK Property Annual Submissions
- list, retrieve, create or amend an individual’s Foreign Property Income & Expenses Period Summaries
- retrieve, create, amend or delete an individual’s Foreign Property Annual Submissions
- retrieve, create, amend or delete an individual’s Historic FHL and Non-FHL UK Property Business Annual Submissions
- list, retrieve, create or amend an individual’s Historic FHL and Non-FHL UK Property Business Income & Expenses Period Summaries
The “historic” endpoints are for data relating to tax years from 2017-18 to 2021-22. For later years, use the standard endpoints.
For information on how to connect to this API see the Income Tax MTD end-to-end service guide.
Mapping APIs to Self Assessment tax return forms
Some parameters in this API map to box numbers in one or more Self Assessment tax return forms. To learn more and to download this mapping information as a CSV file, go to income-tax-mtd-changelog/mapping on GitHub.
Errors
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.
Single errors will be returned in the following format:
{
"code": "FORMAT_FIELD_NAME",
"message": "The provided FieldName is invalid"
}
Where possible, multiple errors will be returned with INVALID_REQUEST in the following format:
{
"code": "INVALID_REQUEST",
"message": "Invalid request",
"errors": [
{
"code": "RULE_FIELD_NAME",
"message": "The provided FieldName is not allowed"
},
{
"code": "FORMAT_FIELD_NAME",
"message": "The provided FieldName is invalid"
}
]
}
Testing
You can use the sandbox environment to test this API. You can use the Create Test User API or it's frontend service to create test users.
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.
For versions 2.0 and later, Gov-Test-Scenario values that are not supported by the sandbox will result in a status code 400 response with an error code of RULE_INCORRECT_GOV_TEST_SCENARIO.
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.
Stateful
Some endpoints support STATEFUL gov test scenarios. Stateful scenarios work with groups of endpoints that represent particular types of submissions. For each type you can POST (or PUT) to submit or amend data, GET to retrieve or list data and DELETE to delete data. For example, with a STATEFUL gov test scenario a retrieval will return data based on what you submitted.
The following groups are stateful in the sandbox:
- UK Property Business Annual Submission
- Foreign Property Annual Submission
- UK Property Income and Expenses Period Summary
- Foreign Property Income and Expenses Period Summary
- Historic FHL UK Property Business Annual Submission
- Historic FHL UK Property Income and Expenses Period Summary
- Historic non-FHL UK Property Business Annual Submission
- Historic non-FHL UK Property Income and Expenses Period Summary
Versioning
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.
Endpoints
View API endpointsWhy do these endpoints look different?
The endpoints for this API now use the Open API Specification (OAS).
The API has not changed. You do not need to make any updates to your application if you already use this API.