Sign in

v1

latestOpenAPI 3.0.32026-07-13339240.9 KB
Income and Expenses Period Summaries

List Property Income and Expenses Period Summaries

This endpoint enables you to list the period summaries associated with UK or foreign Properties. A National Insurance number, tax year and business ID are required.

<strong>Note: This endpoint only supports submissions up to tax year 2024-25. New endpoints which support cumulative submission are provided for tax year 2025-26 onwards</strong>.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)Scenario
N/A - DEFAULTSimulates a success response.
NOT_FOUNDSimulates the scenario where no data is found.
STATEFULPerforms a stateful retrieve.
get/individuals/business/property/{nino}/{businessId}/period/{taxYear}

Path parameters

ninostring required
Example:TC663795B

National Insurance number, in the format AA999999A.

businessIdstring required
Example:XAIS12345678910

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}$

taxYearstring required
Example:2022-23

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.)
Maximum tax year supported is 2024-25.

Headers

Accept'application/vnd.hmrc.6.0+json' required

Specifies the response format and the version of the API to be used.

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the read:self-assessment scope.

Gov-Test-Scenariostring
Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Success

Example response

{
  "submissions": [
    {
      "submissionId": "f2fb30e5-4ab6-4a29-b3c1-c7264259ff1c",
      "fromDate": "2021-08-18",
      "toDate": "2021-09-18"
    }
  ]
}