FAQ

VAT-API FAQ

Testing in Sandbox

Q. How can I test different scenarios in Sandbox for an endpoint that returns canned data?

A. If the endpoint is stateless, multiple Gov-Test-Scenarios will be provided. These testing scenarios section can be found at the bottom of the endpoints specific documentation.

Q. Can I have a test user in Production?

A. It is not possible to have any test users in production.

Q. Can I create a test user in Production?

A. It is not possible to have any test users in production.

Q. I feel a key testing scenario has been missed, can I request that one is added to Sandbox?

A. Yes! Raise an issue with the team, detailing the scenario / expected outcome and the team will look into it.

VAT Obligations

Q. Are the to and from dates inclusive or exclusive when matching an obligation period?

A. The To and From dates are Inclusive

Q. Will partially matched periods be returned?

A. As long as the period From or period To date falls within selection range, then it would get returned.

Submit VAT Return

Q. On a successful VAT submission we would like to share a confirmation reference to our users which they can persist for any future communication with HMRC if needed. Which field would be ideal for us to share with our users ?

A. formBundleNumber

Q. Should we surface the Period Key?

A. The period key is an identifier for the obligation, and the obligation data (dates, status etc) provides some information about that obligation for consumption by whoever needs it.

The advice from HMRC - the period key shouldn't be surfaced to customers as the software should manage it, but as always it's not our place as an API delivery team to influence vendor software.

View Vat Return

Payments and Liabilities