Save Dividends Income

PUT /tenants/{tenant}/clients/{client}/mtd/dividends/{taxYear}

Sends the year's foreign and special dividends to HMRC. This is a full replacement of what HMRC hold — 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.

Parameters

Name	Type	Description
tenant*	path string	The Tenant.Code
The Tenant.Code
client*	path string
taxYear*	path string

Request Body*

SaveMtdDividendsIncomeRequest

{
  "foreignDividend": [
    {
      "countryCode": "...",
      "amountBeforeTax": "...",
      "taxTakenOff": "...",
      "specialWithholdingTax": "...",
      "foreignTaxCreditRelief": "..."
    }
  ],
  "dividendIncomeReceivedWhilstAbroad": [
    {
      "countryCode": "...",
      "amountBeforeTax": "...",
      "taxTakenOff": "...",
      "specialWithholdingTax": "...",
      "foreignTaxCreditRelief": "..."
    }
  ],
  "stockDividend": {
    "customerReference": "string",
    "grossAmount": 0
  },
  "redeemableShares": {
    "customerReference": "string",
    "grossAmount": 0
  },
  "bonusIssuesOfSecurities": {
    "customerReference": "string",
    "grossAmount": 0
  }
}

Responses

200 OK

MtdSubmissionReceiptDto

400 Bad Request

401 Unauthorized – Invalid or missing API key

404 Not Found