v1
latestOpenAPI 3.0.32026-07-13339240.9 KBCreate a Foreign Property Income & Expenses Period Summary
This endpoint allows the developer to submit the income and expenses for a foreign property business that occurred between two dates. This submission is for either or both of Furnished Holiday Lettings (FHL) in the European Economic Area (EEA) and all other foreign Property submissions. In the case of Non-FHL Foreign Property, if there are multiple properties per country, the income and expenses should be the total across all properties. A National Insurance number, tax year and business ID are required.
<strong>Note: This endpoint only supports submissions up to tax year 2024-25. New endpoints which support cumulative submission are provided for tax year 2025-26 onwards</strong>.
Test data
Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.
| Header Value (Gov-Test-Scenario) | Scenario |
|---|---|
| N/A - DEFAULT | Simulate success response. |
| NOT_FOUND | Simulates the scenario where the given resource could not be found. |
| OVERLAPPING | Simulates the scenario where the period summary overlaps with an existing period summary. |
| MISALIGNED | Simulates the scenario where the period summary isn't within the accounting period. |
| NOT_CONTIGUOUS | Simulates the scenario where the period summaries are not contiguous. |
| DUPLICATE_SUBMISSION | Simulates the scenario where a summary has already been submitted for the specified period. |
| TYPE_OF_BUSINESS_INCORRECT | Simulates the scenario where the supplied Business ID does not represent a foreign property business. |
| STATEFUL | Performs a stateful create. |
Path parameters
National Insurance number, in the format AA999999A.
An identifier for the business, unique to the customer.<p>Must conform to the regular expression ^X[A-Z0-9]{1}IS[0-9]{11}$
The tax year to which the data applies. For example: 2022-23. The start year and end year must not span two tax years.
The minimum tax year is 2022-23. No gaps are allowed, for example, 2022-24 is not valid.
(The minimum tax year in Sandbox is 2021-22.)
Maximum tax year supported is 2024-25.
Headers
Specifies the response format and the version of the API to be used.
Specifies the format of the request body, which must be JSON.
An OAuth 2.0 Bearer Token with the write:self-assessment scope.
Only in sandbox environment. See Test Data table for all header values.
Request body
Example request
{
"fromDate": "2020-01-01",
"toDate": "2020-01-31",
"foreignFhlEea": {
"income": {
"rentAmount": 5000.99
},
"expenses": {
"premisesRunningCosts": 5000.99,
"repairsAndMaintenance": 5000.99,
"financialCosts": 5000.99,
"professionalFees": 5000.99,
"costOfServices": 5000.99,
"travelCosts": 5000.99,
"other": 5000.99,
"consolidatedExpenses": 5000.99
}
},
"foreignNonFhlProperty": [
{
"countryCode": "FRA",
"income": {
"rentIncome": {
"rentAmount": 5000.99
},
"foreignTaxCreditRelief": true,
"premiumsOfLeaseGrant": 5000.99,
"otherPropertyIncome": 5000.99,
"foreignTaxPaidOrDeducted": 5000.99,
"specialWithholdingTaxOrUkTaxPaid": 5000.99
},
"expenses": {
"premisesRunningCosts": 5000.99,
"repairsAndMaintenance": 5000.99,
"financialCosts": 5000.99,
"professionalFees": 5000.99,
"travelCosts": 5000.99,
"costOfServices": 5000.99,
"residentialFinancialCost": 5000.99,
"broughtFwdResidentialFinancialCost": 5000.99,
"other": 5000.99,
"consolidatedExpenses": 5000.99
}
}
]
}Response
Success
Example response
{
"submissionId": "4557ecb5-fd32-48cc-81f5-e6acd1099f3c"
}