Skip to content

Commit c0917de

Browse files
authored
DL-17364 Updated README. (#1059)
1 parent 3673dfa commit c0917de

1 file changed

Lines changed: 13 additions & 21 deletions

File tree

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# vat-api
22

3-
vat-api has five endpoints:
3+
vat-api has these endpoints:
44
- GET obligations
55
- POST returns
66
- GET returns
77
- GET payments
88
- GET liabilities
9+
- GET penalties
10+
- GET financial-details (retrieves the financial details relating to a late submission or late payment penalty)
11+
- GET information (retrieves information about a VAT customer)
912

10-
### Prerequisites
13+
## Prerequisites
1114
- Scala 2.13.x
1215
- Java 21
1316
- sbt > 1.9.7
14-
- [Service Manager](https://github.com/hmrc/service-manager)
17+
- [Service Manager](https://github.com/hmrc/sm2)
1518

16-
### Development Setup
19+
## Development Setup
1720

1821
Run from the console using: `sbt "~run 9675"`
1922

@@ -26,25 +29,14 @@ dependencyCheck | Runs dependency-check against the current project. It aggregat
2629
dependencyUpdates | Shows a list of project dependencies that can be updated | ```$ sbt dependencyUpdates```
2730
dependencyUpdatesReport | Writes a list of project dependencies to a file | ```$ sbt dependencyUpdatesReport```
2831

29-
### Reporting Issues
32+
## Testing
3033

31-
You can create a GitHub issue [here](https://github.com/hmrc/vat-api/issues).
32-
33-
### License
34-
35-
This code is open source software licensed under the [Apache 2.0 License]("http://www.apache.org/licenses/LICENSE-2.0.html")
34+
For information about testing the APIs, and generating tax payer access tokens for each environment, see [mtd-vat-api-acceptance-tests](https://github.com/hmrc/mtd-vat-api-acceptance-tests).
3635

37-
### Postman setup
36+
## Reporting Issues
3837

39-
To execute these apis in postman the following repo needs to be started.
40-
mtd-vat-api-acceptance-tests
41-
sm2 --start MTDFB_VAT
42-
43-
### Generate tax payer access tokens for each environment
38+
You can create a GitHub issue [here](https://github.com/hmrc/vat-api/issues).
4439

45-
checkout mtd-vat-api-acceptance-tests
46-
./generateTestUsers_local.sh
47-
./generateTestUsers_qa.sh
48-
./generateTestUsers_staging.sh
49-
./generateTestUsers_externaltest.sh
40+
## License
5041

42+
This code is open source software licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html).

0 commit comments

Comments
 (0)