API Docs / Schemas / MtdTaxCalculationDto

MtdTaxCalculationDto

HMRC's tax calculation for a client's year, run after a quarterly update was accepted — the
estimated position with the new figures in. HMRC calculates asynchronously, so an incomplete
result shortly after submission is normal: check again rather than treating it as a failure.

Properties

Name Type Description
calculationIdstring

HMRC's identifier for the calculation.

HMRC's identifier for the calculation.

taxYearstring

The tax year the calculation covers, e.g. 2025-26.

The tax year the calculation covers, e.g. 2025-26.

calculationTimestampstring

When HMRC finished calculating. Absent while the calculation is still running.

When HMRC finished calculating. Absent while the calculation is still running.

periodTostring

The latest date the calculation covers — how far HMRC's information about the client's income
and expenses runs. This is the date HMRC's mandated accuracy disclaimer quotes, and it is
notSodiumHQ.DTOs.MtdSubmissions.MtdTaxCalculationDto.CalculationTimestamp: that is when HMRC ran the
calculation, this is what the calculation is based on. Absent while the calculation is still
running, or where HMRC did not state a period.

The latest date the calculation covers — how far HMRC's information about the client's income
and expenses runs. This is the date HMRC's mandated accuracy disclaimer quotes, and it is
notSodiumHQ.DTOs.MtdSubmissions.MtdTaxCalculationDto.CalculationTimestamp: that is when HMRC ran the
calculation, this is what the calculation is based on. Absent while the calculation is still
running, or where HMRC did not state a period.

isCompleteboolean

True once HMRC has finished and produced totals.

True once HMRC has finished and produced totals.

hasErrorsboolean

True when the calculation ran but could not produce a usable result. A failed calculation is
an answer — the messages say why — not something to keep polling for.

True when the calculation ran but could not produce a usable result. A failed calculation is
an answer — the messages say why — not something to keep polling for.

estimatedIncomeTaxNicAmountnumber

HMRC's estimated income tax and NICs for the full year — the headline "HMRC now estimates"
figure shown after a quarterly update.

HMRC's estimated income tax and NICs for the full year — the headline "HMRC now estimates"
figure shown after a quarterly update.

estimatedTotalIncomenumber

HMRC's estimated total income for the full year.

HMRC's estimated total income for the full year.

estimatedTaxableIncomenumber

HMRC's estimated taxable income for the full year.

HMRC's estimated taxable income for the full year.

totalIncomeTaxAndNicsDuenumber

Total income tax and NICs due on the position calculated so far.

Total income tax and NICs due on the position calculated so far.

errorMessagesarray of string

Why the calculation failed, when it did.

Why the calculation failed, when it did.

JSON Example

{
  "calculationId": "string",
  "taxYear": "string",
  "calculationTimestamp": "2024-01-01T00:00:00Z",
  "periodTo": "2024-01-01",
  "isComplete": false
}

Used By Operations