From 372c8f8a321604418886b3c71592ac9e664b8afb Mon Sep 17 00:00:00 2001 From: Andrew Butters <23127331+abutters@users.noreply.github.com> Date: Thu, 14 Dec 2023 10:28:46 +0000 Subject: [PATCH] [DL-12523] Added new Production Approvals, Terms of Use and Software Choices sections. (#87) --- source/documentation/customer-support.html.md | 8 +- source/documentation/index.md | 82 ++++++++++++++++++- source/documentation/set-up.html.md | 17 +--- 3 files changed, 84 insertions(+), 23 deletions(-) diff --git a/source/documentation/customer-support.html.md b/source/documentation/customer-support.html.md index b10c5a8..aabc3f5 100644 --- a/source/documentation/customer-support.html.md +++ b/source/documentation/customer-support.html.md @@ -6,10 +6,8 @@ weight: 6 # Customer support model -We are developing a customer support model which will help guide businesses and agents to the most appropriate support. This may be provided by us at HMRC or you as a software vendor depending on the issue. Our HMRC support will be provided through a variety of channels and options for seeking advice and support. +The customer support model guides HMRC customers to the most appropriate support. This may be provided by HMRC or the software vendor depending on the issue. -We wish to work with you as software vendors to provide a comprehensive support package that covers software usage, online access and technical issues, as well as straightforward tax queries. +The support offering for VAT (MTD) customers includes guidance on [GOV.UK](https://www.gov.uk/government/organisations/hm-revenue-customs/contact/vat-online-services-helpdesk), webchat, support links on all HMRC online pages, and support over the phone. -Businesses and agents will be signposted to self-help through a suite of guidance products such as videos, webinars and e-learning, which are aimed at specific stages of the MTD journey. We will develop the content as we add new functionality. - -We have created a new dedicated team of advisers to offer telephone and webchat support for MTD. The team can currently be contacted via the [Get help using VAT online services](https://www.gov.uk/government/organisations/hm-revenue-customs/contact/vat-online-services-helpdesk) page. We will be developing new signposting on GOV.UK which will focus on digital and webchat support channels. This guidance will be updated as the model develops. +We will provide additional support material here as we continue to develop the service. diff --git a/source/documentation/index.md b/source/documentation/index.md index fb0c36a..4ba5844 100644 --- a/source/documentation/index.md +++ b/source/documentation/index.md @@ -6,7 +6,7 @@ description: Software developers, designers, product owners or business analysts # VAT (MTD) end-to-end service guide -Version 7.0 issued 10 October 2022 +**Version 7.1** issued 12 December 2023 *** This guide explains how you can integrate your software with our APIs to submit VAT returns under Making Tax Digital for VAT. It shows how the APIs fit into various end-to-end user journeys. It is intended to help software developers, designers, product owners or business analysts understand how your software needs to interact with HMRC systems. @@ -23,6 +23,77 @@ The frequency of submitting a VAT Return (annually, quarterly or monthly) does n For more details see [VAT Notice 700/22](https://www.gov.uk/government/publications/vat-notice-70022-making-tax-digital-for-vat). In particular, [section 7](https://www.gov.uk/government/publications/vat-notice-70022-making-tax-digital-for-vat/vat-notice-70022-making-tax-digital-for-vat#examples-of-where-a-digital-link-is-required) shows the various options for software integration. +## Production approvals process for VAT (MTD) + +Our key objectives for VAT (MTD) are to: + +* ensure customers have a streamlined end-to-end journey and software that supports everything a business customer needs to do to meet their VAT obligations +* safeguard customer data and protect HMRC systems against fraud and criminal attack + +This section of the guide explains the features your product must include before production credentials are sought, together with features you should consider building into your products. + +### Minimum functionality standards + +The minimum required functionality is as follows: + +* A software product must submit the fraud prevention header data required by law. +* A VAT (MTD) product must allow the customer to: + * Retrieve VAT obligations using the VAT (MTD) API [Retrieve VAT obligations](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/RetrieveVATobligations) endpoint. + * Submit a VAT return using the VAT (MTD) API [Submit VAT return for period](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/SubmitVATreturnforperiod) endpoint. + +The following endpoints are also available. These are optional. However, we do recommend that you include them to support your customers’ needs. + +* Retrieve VAT obligations again using the VAT (MTD) API [Retrieve VAT obligations](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/RetrieveVATobligations) endpoint to check if the VAT Return has met the current obligation - or to see the next obligation. +* Retrieve returns submitted up to four years previously by using the VAT (MTD) [View VAT return](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/ViewVATReturn) endpoint. +* Retrieve VAT liabilities by calling the VAT (MTD) API [Retrieve VAT liabilities](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/RetrieveVATliabilities) endpoint. +* Retrieve VAT payments by calling the VAT (MTD) API [Retrieve VAT payments](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/RetrieveVATpayments) endpoint. +* Retrieve details of the penalties that have been applied to a VAT account by using the VAT (MTD) [Retrieve VAT penalties](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/RetrieveVATpenalties) endpoint. +* Retrieve the financial details relating to a penalty by using the VAT (MTD) [Retrieve financial details](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/Retrievefinancialdetails) endpoint. + +### Fraud Prevention Headers + +You must supply fraud prevention header information for all our APIs, before approval can be granted and production credentials issued. + +HMRC must see evidence of fraud prevention headers being sent and be satisfied as to their level of accuracy. + +Please use the [Test Fraud Prevention Headers API](/api-documentation/docs/api/service/txm-fph-validator-api/) to check headers submitted by your application meet the latest version of the [Fraud Prevention Headers specification](/guides/fraud-prevention/). + +### Testing requirements + +The following endpoints are required to be tested to cover the VAT reporting: + +1. Use the [Create Test User API](/api-documentation/docs/api/service/api-platform-test-user/1.0) to create a test user who is an ‘organisation’ to generate test credentials (you will be provided with a test VAT Registration Number (VRN) and User ID and Password details). +2. Use the VAT (MTD) API [Retrieve VAT obligations](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/RetrieveVATobligations) endpoint to return obligation periods (this will return a canned response in the sandbox environment). +3. Use the VAT (MTD) API [Submit VAT return for period](/api-documentation/docs/api/service/vat-api/1.0/oas/page#tag/organisations/operation/SubmitVATreturnforperiod) endopint to submit the return for the open obligation period. +4. We would also need to see testing to any of the other optional endpoints, if these are to be utilised by the software. + +Developers need to: + +* consider developing guidelines within the software for relevant users, including a reference to HMRC user interface journeys for customers and agents (you can find examples of the flow for both Agents and Businesses, in the ‘[Set up](/guides/vat-mtd-end-to-end-service-guide/documentation/set-up.html)’ section of this guide) +* use APIs as efficiently as possible to prevent hitting the [rate limit](/api-documentation/docs/reference-guide#rate-limiting) +* build relevant error responses, so that the software can deal with exceptions +* when authorising software, please make it clear to your users, that the correct VAT (MTD) gateway organisation account credentials, or Agent Services Account credentials, need to be used when logging into the system. + +
+ + + Warning +Once all the above steps have been completed, please contact SDSTeam@hmrc.gov.uk within 2 weeks of completing your API testing, to enable us to view the data within our logs. It takes 10 working days to advise of the outcome. When you contact us, we will then ask you to complete 2 questionnaires, before checking your Fraud Prevention Header and VAT (MTD) API testing. + +
+ +## Terms of use + +You must comply with our [terms of use](/api-documentation/docs/terms-of-use). You must accept the terms of use before we can issue you with production credentials. + +## Software choices + +HMRC publishes a [list of compatible software](https://www.gov.uk/guidance/find-software-thats-compatible-with-making-tax-digital-for-vat) for VAT (MTD) on GOV.UK. Software providers may request to be added to this list when they have completed the necessary steps in the [Production approvals process for VAT (MTD)](#production-approvals-process-for-vat-mtd) section. + +Your software can be added to this page if you provide a product for retail/commercial use. + +Once production access has been granted, we also request that you make a live submission (and provide us with the VAT Registration Number to allow us to check this), before you can be added to the software choices page. + ## End-to-end user journeys @@ -42,11 +113,16 @@ These journeys show examples of use. Journeys for businesses and agents are brok ## Changelog +### Version 7.1 + +12 December 2023 + +* Added new [Production approvals process for VAT (MTD)](#production-approvals-process-for-vat-mtd), [Terms of use](#terms-of-use) and [Software choices](#software-choices) sections. +* Updated the [Customer support model](documentation/customer-support.html) section. + ### Version 7.0 10 October 2022 -What changed: - * Updated [Penalties and appeals](documentation/penalties.html) section to reflect forthcoming penalty reform * Added [Hints for using the VAT API](documentation/hints.html) diff --git a/source/documentation/set-up.html.md b/source/documentation/set-up.html.md index a83b0e8..5e76c4c 100644 --- a/source/documentation/set-up.html.md +++ b/source/documentation/set-up.html.md @@ -20,7 +20,7 @@ Before agents can represent clients they must set up their relationships and sof 4. [Agent links a new VAT client](#link-a-new-vat-client) 5. [Agent registers a client for VAT](#register-for-vat) 6. [Agent signs up clients for Making Tax Digital (MTD) for VAT](#agent-signs-up-client-for-vat-mtd) -7. [Agent chooses software](#choose-software) +7. [Agent chooses software](/#software-choices) 8. [Agent links software to HMRC](#link-software-to-hmrc) ## Business journey overview @@ -35,7 +35,7 @@ Before businesses can submit VAT Returns, they must sign up for VAT (MTD) and se 1. [Business reads guidance](#read-guidance) 2. [Business registers for VAT](#register-for-vat) 3. [Business signs up for Making Tax Digital (MTD) for VAT (MTD)](#business-signs-up-for-vat-mtd) -4. [Business chooses software](#choose-software) +4. [Business chooses software](/#software-choices) 5. [Business links software to HMRC](#link-software-to-hmrc) ## Read guidance @@ -191,19 +191,6 @@ They need to sign up before first use, even if they have already signed up for M 6. Wait up to 3 days to see if the sign up has been approved. 7. Receive confirmation that the business can now start submitting VAT Returns using compatible accounting software. -## Choose software - - -We provide a list of [software applications that are VAT (MTD) compatible](https://www.gov.uk/guidance/software-for-sending-income-tax-updates#VAT) so businesses and agents can choose the right software for their needs. - -This video is about the compatible software that businesses and agents must use as part of VAT (MTD). -
-
-
-
- -Your application must comply with our [terms of use](https://developer.service.hmrc.gov.uk/api-documentation/docs/terms-of-use). You must accept the terms of use before we issue your application's production credentials. - ## Link software to HMRC