MtdAdjustableSummaryDetailDto

One retrieved adjustable summary in full: the figures as submitted, the adjustments made to
them, and the adjusted result. Only one of the two payloads is populated, matching the income
source type.

Properties

Name Type Description
clientCodestring

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

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

calculationIdstring

HMRC's identifier for the summary.

HMRC's identifier for the summary.

incomeSourceTypeenum

Unknown SelfEmployment UkProperty ForeignProperty

Unknown SelfEmployment UkProperty ForeignProperty

isHeldboolean

Whether HMRC hold a summary under this id at all.

Whether HMRC hold a summary under this id at all.

isAdjustableboolean

Whether HMRC will accept adjustments against this summary: it is valid and has not been
adjusted, because HMRC accept adjustments once per summary. Decides whether the adjustment
form is offered, so a screen never works it out from the summary's own fields.

⚠ On a sandbox connection a valid summary is always adjustable. HMRC's sandbox answers every
retrieve with a canned summary marked as already adjusted, while its adjust endpoint accepts
the call, so the flag there says nothing about the summary in hand.

Whether HMRC will accept adjustments against this summary: it is valid and has not been
adjusted, because HMRC accept adjustments once per summary. Decides whether the adjustment
form is offered, so a screen never works it out from the summary's own fields.

⚠ On a sandbox connection a valid summary is always adjustable. HMRC's sandbox answers every
retrieve with a canned summary marked as already adjusted, while its adjust endpoint accepts
the call, so the flag there says nothing about the summary in hand.

selfEmploymentSelfEmploymentBsas
ukPropertyUkPropertyBsas
foreignPropertyForeignPropertyBsas
lastActionMtdSubmissionStampDto

JSON Example

{
  "clientCode": "string",
  "calculationId": "string",
  "incomeSourceType": "Unknown",
  "isHeld": false,
  "isAdjustable": false
}

Used By Operations