Save Other Employment Income
Sends the year's share schemes, lump sums and employment deductions to HMRC. A full replacement — every entry that should survive must be in the request, so editing one means sending them all back. Clearing the year is a delete rather than an empty save.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| client* | path string | |
| taxYear* | path string | |
Request Body*
{
"shareOption": [
{
"employerName": "...",
"employerRef": "...",
"schemePlanType": "...",
"dateOfOptionGrant": "...",
"dateOfEvent": "..."
}
],
"sharesAwardedOrReceived": [
{
"employerName": "...",
"employerRef": "...",
"schemePlanType": "...",
"dateSharesCeasedToBeSubjectToPlan": "...",
"noOfShareSecuritiesAwarded": "..."
}
],
"disability": {
"customerReference": "string",
"amountDeducted": 0
},
"foreignService": {
"customerReference": "string",
"amountDeducted": 0
},
"lumpSums": [
{
"employerName": "...",
"employerRef": "...",
"taxableLumpSumsAndCertainIncome": "...",
"benefitFromEmployerFinancedRetirementScheme": "...",
"redundancyCompensationPaymentsOverExemption": "..."
}
]
}
Responses
200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found