Employment Related Securities (ERS) is a microservice that allows employers to register their employee share (and other security) schemes with HMRC. The service allows customers to upload their ERS annual return files and check for formatting errors.
This project is a Scala web application using code scaffolds
This service uses upscan
Service Manager: sm2 --start ERS_RETURNS_ALL
Start local tests: ./run_all_tests.sh
For the accessibility tests Node v12 or above is needed. Details can be found here.
Run the tests with command:
sbt clean A11y/test
| Repositories | Link |
|---|---|
| Backend | https://github.com/hmrc/ers-returns |
| Stub | https://github.com/hmrc/ers-eoy-return-stub |
| Performance tests | https://github.com/hmrc/ers-returns-perf-tests |
| Acceptance tests | https://github.com/hmrc/ers-returns-acceptance-tests |
sbt run -Dplay.http.router=testOnlyDoNotUseInAppConf.RoutesNote that ers-returns must also be running its test router to retrieve submission data.
Relevant URL parameters can be found in the Mongo ers-stub/ers.files collection.
By taking the first two components of an entry's filename, we can use them as query parameters for schemeRef and confTime:
filename: EMI100000000124-2024-10-25T08:08:21-2024-10-25T09:08:21.240851+01:00[Europe/London]
Becomes:
http://localhost:9290/submit-your-ers-annual-return/test-only/retrieve-submission-data?schemeRef=EMI100000000124&confTime=2024
Start the service locally by going to http://localhost:9949/auth-login-stub/gg-sign-in
Fill in the correct credentials:
-
Credential Strength: Strong
-
Confidence Level: 50
-
Affinity Group: Organisation
-
EPAYE: 1234/GA4567
Select Submit
Due to the nature of the connection to DES in QA, only a collection of Scheme References can be used for a successful submission. Using an invalid Scheme Reference will result in a global error page when submitting the return. The current supported Scheme References are as follows:
This code is open source software licensed under the Apache 2.0 License.