Skip to content

hmrc/vat-api

Repository files navigation

vat-api

vat-api has five endpoints:

  • GET obligations
  • POST returns
  • GET returns
  • GET payments
  • GET liabilities

Prerequisites

Development Setup

Run from the console using: sbt "~run 9675"

Highlighted SBT Tasks

Task Description Command
test Runs the standard unit tests $ sbt test
func:test Runs the functional tests $ sbt func/test
dependencyCheck Runs dependency-check against the current project. It aggregates dependencies and generates a report $ sbt dependencyCheck
dependencyUpdates Shows a list of project dependencies that can be updated $ sbt dependencyUpdates
dependencyUpdatesReport Writes a list of project dependencies to a file $ sbt dependencyUpdatesReport

Reporting Issues

You can create a GitHub issue here.

License

This code is open source software licensed under the Apache 2.0 License

Postman setup

To execute these apis in postman the following repo needs to be started. mtd-vat-api-acceptance-tests
sm2 --start MTDFB_VAT

Generate tax payer access tokens for each environment

checkout mtd-vat-api-acceptance-tests ./generateTestUsers_local.sh ./generateTestUsers_qa.sh ./generateTestUsers_staging.sh ./generateTestUsers_externaltest.sh