API Docs / Schemas / AddMtdCustomEmploymentRequest

AddMtdCustomEmploymentRequest

Adds a custom employment for a tax year — an employment HMRC do not already hold from the
employer's own submissions. HMRC issue the identifier every later call uses.

This is only for employments HMRC are missing. Adding one that duplicates an HMRC-held
employment double-counts the income; the way to remove an HMRC-held employment from the
calculation is to ignore it, not to add a replacement.

Properties

Name Type Description
employerRefstring

The employer's PAYE reference, in HMRC's format (e.g. 123/AB456).

The employer's PAYE reference, in HMRC's format (e.g. 123/AB456).

employerName*string

The employer's name. Required by HMRC.

The employer's name. Required by HMRC.

startDate*string

The employment's start date. Required by HMRC.

The employment's start date. Required by HMRC.

cessationDatestring

The employment's cessation date, when it ended in the year.

The employment's cessation date, when it ended in the year.

payrollIdstring

The payroll identifier.

The payroll identifier.

occupationalPension*boolean

Whether the employment is an occupational pension. Required by HMRC and not defaulted — it
changes how the income is taxed, so it is an answer rather than a blank.

Whether the employment is an occupational pension. Required by HMRC and not defaulted — it
changes how the income is taxed, so it is an answer rather than a blank.

JSON Example

{
  "employerRef": "string",
  "employerName": "string",
  "startDate": "2024-01-01",
  "cessationDate": "2024-01-01",
  "payrollId": "string",
  "occupationalPension": false
}

Used By Operations