API Docs / Schemas / MtdReliefsDto

MtdReliefsDto

Every relief HMRC hold for a client and tax year, in one read.

HMRC split reliefs across five independent resources and each is saved and cleared on its own.
They are fetched together here because a practice reviews the client's reliefs as one job — and
because five separate round trips from the browser would show the five halves of one answer
arriving out of step.

Properties

Name Type Description
clientCodestring

The Sodium client the reliefs belong to, stamped by the API on the way out.

The Sodium client the reliefs belong 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.

investmentMtdInvestmentReliefsDto
otherMtdOtherReliefsDto
foreignMtdForeignReliefsDto
pensionsMtdPensionsReliefsDto
charitableGivingMtdCharitableGivingDto

JSON Example

{
  "clientCode": "string",
  "taxYear": "string",
  "investment": {
    "clientCode": "string",
    "taxYear": "string",
    "isHeld": false,
    "lastAction": "...",
    "investment": "..."
  },
  "other": {
    "clientCode": "string",
    "taxYear": "string",
    "isHeld": false,
    "lastAction": "...",
    "other": "..."
  },
  "foreign": {
    "clientCode": "string",
    "taxYear": "string",
    "isHeld": false,
    "lastAction": "...",
    "foreign": "..."
  }
}

Contained in Schemas