API Docs / Schemas / MtdEmploymentDetailDto

MtdEmploymentDetailDto

One employment in full: HMRC's record of it, the financial details held against it, and who
last changed either from Sodium.

Whether it is HMRC's own or was added here comes from the list, not from here — HMRC's record
does not say, so repeating it would cost an extra call for something the caller already has.

Properties

Name Type Description
clientCodestring

The Sodium client the employment belongs to, stamped by the API on the way out.

The Sodium client the employment belongs to, stamped by the API on the way out.

taxYearstring

The tax year, in HMRC's format, e.g. 2025-26.

The tax year, in HMRC's format, e.g. 2025-26.

employmentIdstring

HMRC's identifier for the employment.

HMRC's identifier for the employment.

employmentEmploymentDetails
financialDetailsEmploymentFinancialDetails
lastEmploymentActionMtdSubmissionStampDto
lastFinancialDetailsActionMtdSubmissionStampDto

JSON Example

{
  "clientCode": "string",
  "taxYear": "string",
  "employmentId": "string",
  "employment": {
    "employerRef": "string",
    "employerName": "string",
    "startDate": "2024-01-01",
    "cessationDate": "2024-01-01",
    "payrollId": "string"
  },
  "financialDetails": {
    "submittedOn": "2024-01-01T00:00:00Z",
    "source": "string",
    "customerAdded": "2024-01-01T00:00:00Z",
    "dateIgnored": "2024-01-01T00:00:00Z",
    "employment": "..."
  }
}

Used By Operations