v1

latestOpenAPI 3.0.32026-07-13912149.6 KB

Self-Employment Period Summaries

List Self-Employment Period Summaries

This endpoint enables you to retrieve a list of all self-employment update period summaries. A National Insurance number and business ID must be provided.

<strong>Note: This endpoint can only be used for submissions for tax year 2024-25 or earlier. New endpoints which support cumulative submission will be 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 - DEFAULT	Simulates success response.
NOT_FOUND	Simulates the scenario where no data is found.
TAX_YEAR_NOT_SUPPORTED	Simulates the scenario where the tax year is not supported.
STATEFUL	Performs a stateful list.

get/individuals/business/self-employment/{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 in the format YYYY-YY. The start year and end year must not span two tax years. The minimum tax year is 2017-18. No gaps are allowed, for example, 2022-24 is not valid.'

Headers

Accept'application/vnd.hmrc.5.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

{
  "periods": [
    {
      "periodId": "2017-04-06_2017-07-04",
      "periodStartDate": "2020-01-01",
      "periodEndDate": "2020-01-01"
    }
  ]
}