v1

latestOpenAPI 3.0.32026-07-1319133.4 KB

Employments

Ignore Employment

This endpoint enables you to ignore an HMRC-provided employment from a list of employments. <strong>This endpoint can only be used after the tax year has ended.</strong> A National Insurance number, tax year and Employment ID must be provided.

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.
CUSTOM_EMPLOYMENT	Simulates the scenario where a custom employment is submitted.
NOT_FOUND	Simulates the scenario where no data is found.
TAX_YEAR_NOT_ENDED	Simulates the scenario where the tax year provided has not ended.
REQUEST_CANNOT_BE_FULFILLED	Simulates the scenario where the request cannot be fulfilled for various reasons other than the ones triggering other errors.
OUTSIDE_AMENDMENT_WINDOW	Simulates the scenario where request cannot be completed as it is outside the amendment window.

post/individuals/employments-income/{nino}/{taxYear}/{employmentId}/ignore

Path parameters

ninostring required

Example:TC663795B

National Insurance number, in the format AA999999A

taxYearstring required

Example:2021-22

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 2021-22. No gaps are allowed, for example, 2020-22 is not valid. (The minimum tax year in Sandbox is 2019-20.)

employmentIdstring required

Example:4557ecb5-fd32-48cc-81f5-e6acd1099f3c

The unique identifier for the employment.

Headers

Accept'application/vnd.hmrc.2.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 write:self-assessment scope.

Gov-Test-Scenariostring

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

Response

Success