From 31ce27aeb8471106dcb45d2da44bd5a4fa803929 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CTaiwo-AB=E2=80=9D?= <63714619+Taiwo-AB@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:10:21 +0000 Subject: [PATCH] MTDSA-27789 Fix OAS to add note, schemas and examples to remove mentions of tax years after 2024-25 for Property Income & Expenses Period Summary endpoints --- .../foreign_property_period_summary_amend.yaml | 16 ++++++---------- .../foreign_property_period_summary_create.yaml | 16 ++++++---------- ...foreign_property_period_summary_retrieve.yaml | 16 ++++++---------- .../def2/request.json | 2 +- .../def2/request.json | 2 +- .../def2/response.json | 2 +- .../def2/request.json | 2 +- .../def2/request.json | 2 +- ...k_foreign_property_period_summaries_list.yaml | 3 ++- .../5.0/uk_property_period_summary_amend.yaml | 15 +++++++-------- .../5.0/uk_property_period_summary_create.yaml | 15 +++++++-------- .../5.0/uk_property_period_summary_retrieve.yaml | 15 +++++++-------- 12 files changed, 46 insertions(+), 60 deletions(-) diff --git a/resources/public/api/conf/5.0/foreign_property_period_summary_amend.yaml b/resources/public/api/conf/5.0/foreign_property_period_summary_amend.yaml index 42695d1d9..ff90c87ba 100644 --- a/resources/public/api/conf/5.0/foreign_property_period_summary_amend.yaml +++ b/resources/public/api/conf/5.0/foreign_property_period_summary_amend.yaml @@ -5,8 +5,8 @@ description: | 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, business ID, tax year and submission ID are required. - 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. + 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. ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. @@ -45,20 +45,16 @@ requestBody: - $ref: './schemas/foreign_property_period_summary_amend/def1/request.json' - $ref: './schemas/foreign_property_period_summary_amend/def2/request.json' examples: - full-expenses-request: - description: Full Expenses request for TY 2023-24 and before + Full Expenses request for TY 2023-24 and before: value: $ref: './examples/foreign_property_period_summary_amend/def1/request.json' - consolidated-expenses-request: - description: Consolidated Expenses request for TY 2023-24 and before + Consolidated Expenses request for TY 2023-24 and before: value: $ref: './examples/foreign_property_period_summary_amend/def1/consolidated_request.json' - full-expenses-request-for-TY-2024-25: - description: Full Expenses request for TY 2024-25 and after + Full Expenses request for TY 2024-25: value: $ref: './examples/foreign_property_period_summary_amend/def2/request.json' - consolidated-expenses-request-for-TY-2024-25: - description: Consolidated Expenses request for TY 2024-25 and after + Consolidated Expenses request for TY 2024-25: value: $ref: './examples/foreign_property_period_summary_amend/def2/consolidated_request.json' diff --git a/resources/public/api/conf/5.0/foreign_property_period_summary_create.yaml b/resources/public/api/conf/5.0/foreign_property_period_summary_create.yaml index 19d3a6ddc..dbfe0bcc6 100644 --- a/resources/public/api/conf/5.0/foreign_property_period_summary_create.yaml +++ b/resources/public/api/conf/5.0/foreign_property_period_summary_create.yaml @@ -6,8 +6,8 @@ post: 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. - 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. + 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. ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. @@ -49,20 +49,16 @@ post: - $ref: './schemas/foreign_property_period_summary_create/def1/request.json' - $ref: './schemas/foreign_property_period_summary_create/def2/request.json' examples: - full-expenditure-request-for-TY-2023-24: - description: Full Expenditure request for TY 2023-24 and before + Full Expenses request for TY 2023-24 and before: value: $ref: './examples/foreign_property_period_summary_create/def1/request.json' - consolidated-expenditure-request-for-TY-2023-24: - description: Consolidated Expenditure request for TY 2023-24 and before + Consolidated Expenses request for TY 2023-24 and before: value: $ref: './examples/foreign_property_period_summary_create/def1/consolidated_request.json' - full-expenditure-request-for-TY-2024-25: - description: Full Expenditure request for TY 2024-25 and after + Full Expenses request for TY 2024-25: value: $ref: './examples/foreign_property_period_summary_create/def2/request.json' - consolidated-expenditure-request-for-TY-2024-25: - description: Consolidated Expenditure request for TY 2024-25 and after + Consolidated Expenses request for TY 2024-25: value: $ref: './examples/foreign_property_period_summary_create/def2/consolidated_request.json' diff --git a/resources/public/api/conf/5.0/foreign_property_period_summary_retrieve.yaml b/resources/public/api/conf/5.0/foreign_property_period_summary_retrieve.yaml index b0fad1511..16343f046 100644 --- a/resources/public/api/conf/5.0/foreign_property_period_summary_retrieve.yaml +++ b/resources/public/api/conf/5.0/foreign_property_period_summary_retrieve.yaml @@ -3,8 +3,8 @@ description: | This endpoint allows a developer to retrieve the income and expenses for a Foreign Property business, using the submission ID for either or both of Furnished Holiday Lettings (FHL) in the European Economic Area (EEA) and all other Foreign Property submissions. A National Insurance number, business ID, and tax year are required. - 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. + 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. ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. @@ -56,20 +56,16 @@ responses: - $ref: './schemas/foreign_property_period_summary_retrieve/def1/response.json' - $ref: './schemas/foreign_property_period_summary_retrieve/def2/response.json' examples: - full-expenses-response-for-TY-2023-24: - description: Full Expenses Response for TY 2023-24 and before + Full Expenses response for TY 2023-24 and before: value: $ref: './examples/foreign_property_period_summary_retrieve/def1/response.json' - consolidated-expenses-response-for-TY-2023-24: - description: Full Consolidated Expenses Response for TY 2023-24 and before + Consolidated Expenses response for TY 2023-24 and before: value: $ref: './examples/foreign_property_period_summary_retrieve/def1/consolidated_response.json' - full-expenses-response-for-TY-2024-25: - description: Full Expenses Response for TY 2024-25 and after + Full Expenses response for TY 2024-25: value: $ref: './examples/foreign_property_period_summary_retrieve/def2/response.json' - consolidated-expenses-response-for-TY-2024-25: - description: Full Consolidated Expenses Response for TY 2024-25 and after + Consolidated Expenses response for TY 2024-25: value: $ref: './examples/foreign_property_period_summary_retrieve/def2/consolidated_response.json' diff --git a/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_amend/def2/request.json b/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_amend/def2/request.json index 4b5326e97..186acb9b2 100644 --- a/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_amend/def2/request.json +++ b/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_amend/def2/request.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "For TY 2024-25 and after", + "title": "For TY 2024-25", "description": "This endpoint allows a developer to amend the income and expenses for a foreign property business. This submission is for either or both of Furnished Holiday Letting (FHL) in the European Economic Area (EEA) and all other foreign property submissions. A National Insurance number, business ID, tax year and submission ID are required.", "type": "object", "properties": { diff --git a/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_create/def2/request.json b/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_create/def2/request.json index 0e4f5008f..fca66eea6 100644 --- a/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_create/def2/request.json +++ b/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_create/def2/request.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "For TY 2024-25 and after", + "title": "For TY 2024-25", "description": "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. A National Insurance number, tax year and business ID are required.", "type": "object", "properties": { diff --git a/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_retrieve/def2/response.json b/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_retrieve/def2/response.json index 785eef09d..595e4d35b 100644 --- a/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_retrieve/def2/response.json +++ b/resources/public/api/conf/5.0/schemas/foreign_property_period_summary_retrieve/def2/response.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "For TY 2024-25 and after", + "title": "For TY 2024-25", "description": "Retrieve a Foreign Property Income & Expenditure Period Summary", "type": "object", "properties": { diff --git a/resources/public/api/conf/5.0/schemas/uk_property_period_summary_amend/def2/request.json b/resources/public/api/conf/5.0/schemas/uk_property_period_summary_amend/def2/request.json index 67547a80b..a559ed443 100644 --- a/resources/public/api/conf/5.0/schemas/uk_property_period_summary_amend/def2/request.json +++ b/resources/public/api/conf/5.0/schemas/uk_property_period_summary_amend/def2/request.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "For TY 2024-25 and after", + "title": "For TY 2024-25", "description": "This endpoint allows a developer to re-submit the income and expenditure for a UK property business. This submission is for either or both of Furnished Holiday Letting (FHL) and Non FHL UK property submissions. A National Insurance number, business ID, tax year and submission ID are required.", "type": "object", diff --git a/resources/public/api/conf/5.0/schemas/uk_property_period_summary_create/def2/request.json b/resources/public/api/conf/5.0/schemas/uk_property_period_summary_create/def2/request.json index 5894727e8..92827058c 100644 --- a/resources/public/api/conf/5.0/schemas/uk_property_period_summary_create/def2/request.json +++ b/resources/public/api/conf/5.0/schemas/uk_property_period_summary_create/def2/request.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "For TY 2024-25 and after", + "title": "For TY 2024-25", "description": "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. A National Insurance number and business ID are required.", "type": "object", "properties": { diff --git a/resources/public/api/conf/5.0/uk_foreign_property_period_summaries_list.yaml b/resources/public/api/conf/5.0/uk_foreign_property_period_summaries_list.yaml index e36cb16fe..69ccc1c0a 100644 --- a/resources/public/api/conf/5.0/uk_foreign_property_period_summaries_list.yaml +++ b/resources/public/api/conf/5.0/uk_foreign_property_period_summaries_list.yaml @@ -3,7 +3,8 @@ get: description: | This endpoint enables you to list the period summaries associated with UK or foreign Properties. A National Insurance number, tax year and business ID are required. - 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. + 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. ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. diff --git a/resources/public/api/conf/5.0/uk_property_period_summary_amend.yaml b/resources/public/api/conf/5.0/uk_property_period_summary_amend.yaml index f05e4f95d..81fae519f 100644 --- a/resources/public/api/conf/5.0/uk_property_period_summary_amend.yaml +++ b/resources/public/api/conf/5.0/uk_property_period_summary_amend.yaml @@ -1,6 +1,9 @@ summary: Amend a UK Property Income & Expenses Period Summary description: | This endpoint allows a developer to re-submit the income and expenditure for a UK property business. This submission is for either or both of Furnished Holiday Letting (FHL) and Non FHL UK property submissions. A National Insurance number, business ID, tax year and submission ID are required. + + 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. ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. @@ -38,20 +41,16 @@ requestBody: - $ref: './schemas/uk_property_period_summary_amend/def1/request.json' - $ref: './schemas/uk_property_period_summary_amend/def2/request.json' examples: - full-expenses-request: - description: Full Expenses request for TY 2023-24 and before + Full Expenses request for TY 2023-24 and before: value: $ref: './examples/uk_property_period_summary_amend/def1/request.json' - consolidated-expenses-request: - description: Consolidated Expenses request for TY 2023-24 and before + Consolidated Expenses request for TY 2023-24 and before: value: $ref: './examples/uk_property_period_summary_amend/def1/consolidated_request.json' - full-expenses-request-for-TY-2024-25: - description: Full Expenses request for TY 2024-25 and after + Full Expenses request for TY 2024-25: value: $ref: './examples/uk_property_period_summary_amend/def2/request.json' - consolidated-expenses-request-for-TY-2024-25: - description: Consolidated Expenses request for TY 2024-25 and after + Consolidated Expenses request for TY 2024-25: value: $ref: './examples/uk_property_period_summary_amend/def2/consolidated_request.json' diff --git a/resources/public/api/conf/5.0/uk_property_period_summary_create.yaml b/resources/public/api/conf/5.0/uk_property_period_summary_create.yaml index 2f9d40206..19ea3cae9 100644 --- a/resources/public/api/conf/5.0/uk_property_period_summary_create.yaml +++ b/resources/public/api/conf/5.0/uk_property_period_summary_create.yaml @@ -4,6 +4,9 @@ post: This endpoint allows a developer to submit the income and expenses for a UK property business. This submission is for either or both of Furnished Holiday Letting (FHL) and Non FHL UK property submissions. A National Insurance number, business ID and tax year are required. + + 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. ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. @@ -44,20 +47,16 @@ post: - $ref: './schemas/uk_property_period_summary_create/def1/request.json' - $ref: './schemas/uk_property_period_summary_create/def2/request.json' examples: - full-expense-request-for-TY-2021-22: - description: Full Expenses request for TY 2023-24 and before + Full Expenses request for TY 2023-24 and before: value: $ref: './examples/uk_property_period_summary_create/def1/request.json' - consolidated-expense-request-for-TY-2021-22: - description: Consolidated Expenses request for TY 2023-24 and before + Consolidated Expenses request for TY 2023-24 and before: value: $ref: './examples/uk_property_period_summary_create/def1/consolidated_request.json' - full-expense-request-for-TY-2024-25: - description: Full Expenses request for TY 2024-25 and after + Full Expenses request for TY 2024-25: value: $ref: './examples/uk_property_period_summary_create/def2/request.json' - consolidated-expense-request-for-TY-2024-25: - description: Consolidated Expenses request for TY 2024-25 and after + Consolidated Expenses request for TY 2024-25: value: $ref: './examples/uk_property_period_summary_create/def2/consolidated_request.json' diff --git a/resources/public/api/conf/5.0/uk_property_period_summary_retrieve.yaml b/resources/public/api/conf/5.0/uk_property_period_summary_retrieve.yaml index c7352ef41..d33e10b5a 100644 --- a/resources/public/api/conf/5.0/uk_property_period_summary_retrieve.yaml +++ b/resources/public/api/conf/5.0/uk_property_period_summary_retrieve.yaml @@ -2,6 +2,9 @@ summary: Retrieve a UK Property Income & Expenses Period Summary description: | This endpoint allows a developer to retrieve the income and expenses for a UK property business, that occurred between tax year. A National Insurance number, business ID, tax year and submission ID are required. + 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. + ### Test data Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment. @@ -53,20 +56,16 @@ responses: - $ref: './schemas/uk_property_period_summary_retrieve/def1/response.json' - $ref: './schemas/uk_property_period_summary_retrieve/def2/response.json' examples: - full-expense-response-for-TY-2022-23: - description: Full Expenditure response for TY 2023-24 and before + Full Expenses response for TY 2023-24 and before: value: $ref: './examples/uk_property_period_summary_retrieve/def1/response.json' - consolidated-expense-response-for-TY-2022-23: - description: Consolidated Expenditure response for TY 2023-24 and before + Consolidated Expenses response for TY 2023-24 and before: value: $ref: './examples/uk_property_period_summary_retrieve/def1/consolidated_response.json' - full-expense-response-for-TY-2024-25: - description: Full Expenditure response for TY 2024-25 and after + Full Expenses response for TY 2024-25: value: $ref: './examples/uk_property_period_summary_retrieve/def2/response.json' - consolidated-expense-response-for-TY-2024-25: - description: Consolidated Expenses request for TY 2024-25 and after + Consolidated Expenses response for TY 2024-25: value: $ref: './examples/uk_property_period_summary_retrieve/def2/consolidated_response.json'