Properties
| Name | Type | Description |
|---|---|---|
| businessId | string | HMRC's income source id the figures are for. |
HMRC's income source id the figures are for. | ||
| incomeSourceType | enum | Unknown SelfEmployment UkProperty ForeignProperty |
Unknown SelfEmployment UkProperty ForeignProperty | ||
| platform | string | The platform the figures came from. |
The platform the figures came from. | ||
| periodFrom | string | First day the books were asked about — the obligation period's own start. |
First day the books were asked about — the obligation period's own start. | ||
| periodTo | string | Last day the books were asked about — the quarter end being reported. |
Last day the books were asked about — the quarter end being reported. | ||
| electedBasis | enum | Cash Accrual |
Cash Accrual | ||
| isConsolidated | boolean | Whether the mapping files everything into the single consolidated-expenses box. |
Whether the mapping files everything into the single consolidated-expenses box. | ||
| selfEmploymentFigures | SelfEmploymentFigureInputs | |
| ukPropertyFigures | UkPropertyFigures | |
| mappedLines | array of MtdMappedLineDto | Every account that landed in a box — the pull's working, shown before it is applied. |
Every account that landed in a box — the pull's working, shown before it is applied. | ||
| unmapped | array of MtdUnmappedLineDto | Profit-and-loss accounts with figures that the mapping says nothing about. |
Profit-and-loss accounts with figures that the mapping says nothing about. | ||
| unmappable | array of MtdUnmappableLineDto | Figures the books report with no nominal code or account id at all. |
Figures the books report with no nominal code or account id at all. | ||
| ignoredNonProfitAndLossCount | integer | How many accounts with figures were skipped because the platform does not file them on the |
How many accounts with figures were skipped because the platform does not file them on the | ||
| idEntriesInvalidated | boolean | True when the books have moved organisation or platform since the mapping was confirmed, so |
True when the books have moved organisation or platform since the mapping was confirmed, so | ||
| warnings | array of string | Anything worth reading before submitting — negative income, a stale mapping, a missing basis. |
Anything worth reading before submitting — negative income, a stale mapping, a missing basis. | ||
JSON Example
{
"businessId": "string",
"incomeSourceType": "Unknown",
"platform": "string",
"periodFrom": "2024-01-01",
"periodTo": "2024-01-01"
}