v2

latestOpenAPI 3.0.32026-08-018322.1 MB

List Business Source Adjustable Summaries

This endpoint allows the user to generate a list of Business Source Adjustable Summaries for a given tax year. A filter can be set to return the summaries for a single business or business type. The National Insurance number must be provided.

Test data

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

Tax Years	Header Value (Gov-Test-Scenario)	Scenario
ALL	N/A - DEFAULT	Simulate a successful response containing multiple business types.
ALL	SELF_EMPLOYMENT	Simulate a successful response containing a self-employment business.
ALL	UK_PROPERTY	Simulate a successful response containing a UK property business.
Before 2025-26	UK_PROPERTY_FHL	Simulate a successful response containing UK FHL property businesses.
ALL	FOREIGN_PROPERTY	Simulate a successful response containing a foreign property business.
Before 2025-26	FOREIGN_PROPERTY_FHL	Simulate a successful response containing EEA FHL foreign property businesses.
ALL	NOT_FOUND	Simulates the scenario where no data is found.
ALL	REQUEST_CANNOT_BE_FULFILLED	Simulates the scenario where the request cannot be fulfilled for various reasons other than the ones triggering other errors.
ALL	DYNAMIC	The following response values will change to correspond to the values submitted in the request:<br> • businessID<br> • typeOfBusiness<br> • accountingPeriod.startdate<br> • accountingPeriod.enddate<br> • taxYear<br> • requestedDatetime<br> • adjustedDatetime<br><br> Use one of the following businessIDs for the appropriate scenario:<br> • XBIS12345678901 for a response with a self-employment business<br> • XBIS12345678902 for a response with a uk-property business<br> • XBIS12345678915 for a response with a foreign-property business<br> • XBIS12345678903 for a response with a foreign-property-fhl-eea business (2024-25 or before only)<br> • XBIS12345678904 for a response with a uk-property-fhl business (2024-25 or before only)<br>
ALL	STATEFUL	Performs a stateful list.

get/individuals/self-assessment/adjustable-summary/{nino}/{taxYear}

Path parameters

ninostring required

Example:TC663795B

National Insurance number, in the format AA999999A

taxYearstring required

Example:2023-24

The tax year to which the data applies in the format YYYY-YY. The range must not be greater than a single year. For example, 2023-25 is not valid.

Query parameters

typeOfBusiness'self-employment' | 'uk-property-fhl' | 'uk-property' | 'foreign-property-fhl-eea' | 'foreign-property'

Example:foreign-property

The type of business the summary calculation is for.

Limited to the following possible values for tax years 2024-25 and before:

foreign-property-fhl-eea
foreign-property
uk-property
uk-property-fhl
self-employment

Limited to the following possible values for tax year 2025-26 onwards:

foreign-property
uk-property
self-employment

businessIdstring

Example:XBIS12345678901

An identifier for the business, unique to the customer.

Headers

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

{
  "businessSources": [
    {
      "businessId": "XAIS12345678910",
      "accountingPeriod": {
        "startDate": "2018-05-01",
        "endDate": "2019-04-30"
      },
      "taxYear": "2020-21",
      "summaries": [
        {
          "calculationId": "717f3a7a-db8e-11e9-8a34-2a2ae2dbcce4",
          "requestedDateTime": "2019-04-04T01:01:01Z",
          "adjustedDateTime": "2019-04-04T01:01:01Z"
        }
      ]
    }
  ]
}

All 8 operations