API Docs / Schemas / UpdateMtdForeignPropertyRequest

UpdateMtdForeignPropertyRequest

Renames a registered foreign property, or records that it stopped producing income.

The country cannot be changed: a property registered against the wrong country is ended with
Sodium.HmrcMtd.Contracts.Enums.ForeignPropertyEndReason.AddedInError and registered again, because figures
already filed against it are keyed by its identifier.

Properties

Name Type Description
propertyName*string

The property's name. HMRC require it even when only the end date is changing.

The property's name. HMRC require it even when only the end date is changing.

endDatestring

When income stopped being received. Must be paired with SodiumHQ.DTOs.MtdSubmissions.UpdateMtdForeignPropertyRequest.EndReason, and cannot
fall after the end of the tax year being updated.

When income stopped being received. Must be paired with SodiumHQ.DTOs.MtdSubmissions.UpdateMtdForeignPropertyRequest.EndReason, and cannot
fall after the end of the tax year being updated.

endReasonenum

Unknown NoLongerRentingPropertyOut Disposal AddedInError Cessation

Unknown NoLongerRentingPropertyOut Disposal AddedInError Cessation

JSON Example

{
  "propertyName": "string",
  "endDate": "2024-01-01",
  "endReason": "Unknown"
}

Used By Operations