Save Annual Submission
Sends the year-end values for one income source and tax year to HMRC. This is a full replacement of what HMRC holds — anything omitted is cleared — so the request must carry every value that should survive, not only what changed. Clearing the year is a delete rather than an empty save: an all-empty request is refused.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| client* | path string | |
| businessId* | path string | |
| taxYear* | path string | |
Request Body*
{
"incomeSourceType": "Unknown",
"selfEmployment": {
"adjustments": "...",
"allowances": "...",
"nonFinancials": "..."
},
"ukProperty": {
"submittedOn": "2024-01-01T00:00:00Z",
"adjustments": "...",
"allowances": "..."
},
"foreignProperty": [
{
"countryCode": "...",
"propertyId": "...",
"adjustments": "...",
"allowances": "..."
}
]
}
Responses
200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found