API Docs / Schemas / SubmitMtdTaxReturnRequest

SubmitMtdTaxReturnRequest

Sends a client's tax return to HMRC.

⚠ The highest-stakes call in the product, and the one filing that is not idempotent.
HMRC create something that cannot be re-stated, so a second send for a year is the worst
outcome there is. A submission whose outcome is unknown is settled by reconciling it against
HMRC's own record, never by sending again.

Properties

Name Type Description
calculationId*string

The calculation being declared — the one the review names. HMRC must have produced it for
this tax year as an intent to finalise, or as an intent to amend when
SodiumHQ.DTOs.MtdSubmissions.SubmitMtdTaxReturnRequest.DeclarationType is a confirmed amendment; crossing the two files against the
wrong figures and is refused before HMRC is called.

The calculation being declared — the one the review names. HMRC must have produced it for
this tax year as an intent to finalise, or as an intent to amend when
SodiumHQ.DTOs.MtdSubmissions.SubmitMtdTaxReturnRequest.DeclarationType is a confirmed amendment; crossing the two files against the
wrong figures and is refused before HMRC is called.

declarationTypeenum

Unknown FinalDeclaration ConfirmAmendment

Unknown FinalDeclaration ConfirmAmendment

isDeclarationAgreedboolean

Whether the filer has read and agreed HMRC's declaration statement.

⚠ A gate, not a record. HMRC require the software itself to withhold
submission until the declaration has been read and agreed — it is the one readiness rule that
is enforced rather than advised, and a submission without it is refused before HMRC is
called.

Whether the filer has read and agreed HMRC's declaration statement.

⚠ A gate, not a record. HMRC require the software itself to withhold
submission until the declaration has been read and agreed — it is the one readiness rule that
is enforced rather than advised, and a submission without it is refused before HMRC is
called.

declarationVersionstring

The version of the declaration wording that was displayed and agreed to, from the review's
declaration.statementVersion.

Checked, not just recorded: a form left open across a change of HMRC's wording is refused, so
a client's return can never be filed on a declaration nobody read.

The version of the declaration wording that was displayed and agreed to, from the review's
declaration.statementVersion.

Checked, not just recorded: a form left open across a change of HMRC's wording is refused, so
a client's return can never be filed on a declaration nobody read.

JSON Example

{
  "calculationId": "string",
  "declarationType": "Unknown",
  "isDeclarationAgreed": false,
  "declarationVersion": "string"
}

Used By Operations