API Docs / Schemas / MtdTaxReturnSubmissionDto

MtdTaxReturnSubmissionDto

A tax return sent to HMRC from Sodium, for the filing history on a client's year.

⚠ A submission left Sodium.HmrcMtd.Contracts.Enums.TaxReturnStatus.Submitting is not a failure
and must never be offered a second send. HMRC create something that cannot be re-stated, so an
unknown outcome is settled by reconciling it against HMRC's own record — never by sending
again.

Properties

Name Type Description
codestring

The submission's code, issued by the MTD service.

The submission's code, issued by the MTD service.

taxYearstring

The tax year declared.

The tax year declared.

calculationIdstring

The calculation that was declared.

The calculation that was declared.

declarationTypeenum

Unknown FinalDeclaration ConfirmAmendment

Unknown FinalDeclaration ConfirmAmendment

statusenum

Unknown Submitting Submitted Failed

Unknown Submitting Submitted Failed

submittedBystring

The Sodium user who agreed the declaration and sent it.

The Sodium user who agreed the declaration and sent it.

submittedDatestring

When it was sent to HMRC.

When it was sent to HMRC.

declarationVersionstring

Which version of HMRC's declaration wording was agreed to.

Which version of HMRC's declaration wording was agreed to.

hmrcCorrelationIdstring

HMRC's correlation id for the exchange. MTD issues no filing receipt, so this — with the
audit row holding the raw exchange — is the whole of the evidence that a return was sent.

HMRC's correlation id for the exchange. MTD issues no filing receipt, so this — with the
audit row holding the raw exchange — is the whole of the evidence that a return was sent.

failureReasonstring

Why HMRC refused it, when the status is Failed.

Why HMRC refused it, when the status is Failed.

JSON Example

{
  "code": "string",
  "taxYear": "string",
  "calculationId": "string",
  "declarationType": "Unknown",
  "status": "Unknown"
}

Used By Operations