v1
latestOpenAPI 3.0.32026-07-1342625.4 MBList Self Assessment Tax Calculations
This endpoint enables you to list Self Assessment tax calculations for a given National Insurance number and tax year.
A National Insurance number must be provided.
Test data
Scenario simulations 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. |
| DYNAMIC | The following response parameters will be based on the data submitted in the request: <br><br/> • taxYear <br/> • calculationTimestamp <br/> • finalDeclarationTimestamp |
Path parameters
National Insurance number, in the format AA999999A
The tax year the data applies to, for example, 2021-22. 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, 2020-22 is not valid.
Query parameters
This field is used to filter API response based on given calculation type. Tax years 23-24 and 24-25 will accept the following values:
- in-year
- intent-to-finalise
- final-declaration
Tax years 25-26 onwards will accept the following values:
- in-year
- intent-to-finalise
- intent-to-amend
- final-declaration
- confirm-amendment
Headers
Specifies the response format and the version of the API to be used.
An OAuth 2.0 Bearer Token with the read:self-assessment scope.
Only in sandbox environment. See Test Data table for all header values.
Response
Success
Example response
{
"calculations": [
{
"calculationId": "f2fb30e5-4ab6-4a29-b3c1-c7264259ff1c",
"calculationTimestamp": "2019-07-13T07:51:43.112Z",
"taxYear": "2020-21",
"totalIncomeTaxAndNicsDue": 2000.58,
"finalDeclarationTimestamp": "2019-07-13T07:51:43.112Z"
}
]
}