MtdNominalMappingDto

A client's chart-of-accounts mapping for one MTD business — either the stored one or, before
anything has been confirmed, a suggestion built from the platform's catalogue crossed with the
client's live chart.

Properties

Name Type Description
codestring

Unique code for the stored mapping. Empty on a suggestion, which is not stored.

Unique code for the stored mapping. Empty on a suggestion, which is not stored.

businessIdstring

HMRC's income source id the mapping belongs to.

HMRC's income source id the mapping belongs to.

incomeSourceTypeenum

Unknown SelfEmployment UkProperty ForeignProperty

Unknown SelfEmployment UkProperty ForeignProperty

platformstring

The accounting platform the client's books are on.

The accounting platform the client's books are on.

externalOrgIdstring

The organisation the entries' account ids belong to.

The organisation the entries' account ids belong to.

isSuggestedboolean

True when nothing is stored yet and this is the catalogue's suggestion. Confirming it with a
PUT is what makes it the practice's own.

True when nothing is stored yet and this is the catalogue's suggestion. Confirming it with a
PUT is what makes it the practice's own.

isOrgStaleboolean

True when the client's books have moved to a different organisation or platform since the
mapping was confirmed. Codes still match; the stored account ids no longer mean anything, so
the mapping wants re-confirming against the new chart.

True when the client's books have moved to a different organisation or platform since the
mapping was confirmed. Codes still match; the stored account ids no longer mean anything, so
the mapping wants re-confirming against the new chart.

isConsolidatedboolean

Whether the mapping files everything into the single consolidated-expenses box.

Whether the mapping files everything into the single consolidated-expenses box.

confirmedByUserCodestring

Who last confirmed the mapping.

Who last confirmed the mapping.

confirmedDatestring

When the mapping was last confirmed.

When the mapping was last confirmed.

entriesarray of MtdNominalMappingEntryDto

One row per account, in the chart's own order. On a suggestion this is the whole live chart;
on a stored mapping it is what was confirmed, with each account's current type filled in
where the account is still in the chart.

One row per account, in the chart's own order. On a suggestion this is the whole live chart;
on a stored mapping it is what was confirmed, with each account's current type filled in
where the account is still in the chart.

JSON Example

{
  "code": "string",
  "businessId": "string",
  "incomeSourceType": "Unknown",
  "platform": "string",
  "externalOrgId": "string"
}

Used By Operations