v1

latestOpenAPI 3.0.32026-07-138322.1 MB

Trigger a Business Source Adjustable Summary

This endpoint allows a developer to generate an end of accounting period Business Source Adjustable Summary of the income and expenditure for a specified business for a given accounting period. A Business Source Adjustable Summary must be generated before accounting adjustments are to be entered. A National Insurance number must be provided.

<strong> Note: For tax years before 2025-26, data can be submitted for UK FHL or Non-FHL, Foreign EEA-FHL or Non-FHL property business types. From tax year 2025-26 onwards, the UK FHL, UK Non-FHL, Foreign EEA-FHL and Non-FHL property types are no longer valid and you must use the UK Property or Foreign Property type. </strong>

Test data

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

Tax year	Header Value (Gov-Test-Scenario)	Scenario
ALL	N/A - DEFAULT	Simulates success response.
ALL	NO_ACCOUNTING_PERIOD	Simulates the scenario where the supplied accounting period does not exist.
ALL	OBLIGATIONS_NOT_MET	Simulates the scenario where obligations for the business have not been met.
ALL	ACCOUNTING_PERIOD_NOT_ENDED	Simulates the scenario where the supplied accounting period has not ended.
2025-26 onwards	OUTSIDE_AMENDMENT_WINDOW	Simulates the scenario where request cannot be completed as it is outside the amendment window.
ALL	NOT_FOUND	Simulates the scenario where no data is found.
ALL	TAX_YEAR_NOT_SUPPORTED	Simulates the scenario where the tax year is not supported.
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	STATEFUL	Performs a stateful trigger.

post/individuals/self-assessment/adjustable-summary/{nino}/trigger

Path parameters

ninostring required

Example:TC663795B

National Insurance number, in the format AA999999A

Headers

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

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

Content-Type'application/json' required

Specifies the format of the request body, which must be JSON.

Authorizationstring required

Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

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

Gov-Test-Scenariostring

Example:-

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

Request body

Example request

{
  "accountingPeriod": {
    "startDate": "2021-04-06",
    "endDate": "2021-07-05"
  },
  "businessId": "XAIS12345678910"
}

Response

Success

calculationIdstring required

The unique identifier of the summary calculation.

Example response

{
  "calculationId": "f2fb30e5-4ab6-4a29-b3c1-c7264259ff1c"
}