The VAT Transactional Risking (TxR), publicly known as VAT Assist. It is a microservice designed to identify and flag potential risks or inaccuracies in VAT Returns before submission by showing users helpful messages.
The service acts as a pre-submission check within the normal VAT submission process. Since users submit VAT returns via accounting software (e.g. Sage, QuickBooks, Xero), software vendors are required to integrate VAT Assist into their products in order for users to see the relevant messages.
- Scala 3.3.6
- Java 21
- sbt 1.10.x
- MongoDB
Start MongoDB locally (replica set required):
docker run --restart unless-stopped --name mongodb -p 27017:27017 -d percona/percona-server-mongodb:7.0-multi --replSet rs0Then initialise the replica set (first time only):
docker exec -it mongo mongosh --eval "rs.initiate()"Run the service via sbt:
sbt runThe service starts on port 9000 by default.
# Unit tests
sbt test
# Integration tests
sbt it/test
# All tests with coverage
sbt clean compile coverage test it/test coverageReport| Method | Path | Description |
|---|---|---|
| GET | /ping/ping |
Health check |
This code is open source software licensed under the Apache 2.0 License.