Ignore Employment Expenses
Changed onThis endpoint enables you to ignore HMRC-provided employment expenses for this user. A National Insurance number and tax year must be provided. This endpoint can only be used after the tax year has ended.
Ignoring an expense will remove any amended expenses and add the "dateIgnored" flag to HMRC-provided expenses.
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 | Scenario to simulate not found error. |
| OUTSIDE_AMENDMENT_WINDOW | Simulates the scenario where request cannot be completed as it is outside the amendment window. |
Request
- Base URLhttps://test-api.service.hmrc.gov.uk
- AuthOAuth 2Authorization codehttps://api.service.hmrc.gov.uk/oauth/authorizeToken URLhttps://api.service.hmrc.gov.uk/oauth/tokenScopeswrite:self-assessment
Path parameters
National Insurance number, in the format AA999999A
The tax year to which the data applies. For example: 2022-23. The start year and end year must not span two tax years. The minimum tax year is 2022-23. No gaps are allowed, for example, 2022-24 is not valid. (The minimum tax year in Sandbox is 2021-22.)
Headers
Specifies the response format and the version of the API to be used.
An OAuth 2.0 Bearer Token with the write:self-assessment scope.
Only in sandbox environment. See Test Data table for all header values.
Only in the sandbox environment. When supplied and set to true, this header relaxes tax year validation rule to allow in-year submissions for endpoints configured for end-of-year submissions. Not supplying the header or setting it to false results in a RULE_TAX_YEAR_NOT_ENDED error for in-year submissions. In Production, the header is ignored and normal validations apply.
Response
Success(No Content)
Changes
- info
added the new optional
headerrequest parametersuspend-temporal-validations
- info