v1
latestOpenAPI 3.0.32026-07-13833259.3 KBorganisations
View VAT Return
Retrieve a submitted VAT return
Test data
<p>Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.</p> <p>Using this endpoint in the sandbox environment will return the previously submitted data. A 404 (Not Found) response will be returned for a periodKey that has not been submitted.</p> <table> <thead> <tr> <th>Header Value (Gov-Test-Scenario)</th> <th>Scenario</th> </tr> </thead> <tbody> <tr> <td><p>DATE_RANGE_TOO_LARGE</p></td> <td><p>The date of the requested return cannot be further than four years from the current date.</p></td> </tr> <tr> <td><p>INSOLVENT_TRADER</p></td> <td><p>Simulates the scenario where the client is an insolvent trader.</p></td> </tr> </tbody> </table>get/organisations/vat/{vrn}/returns/{periodKey}
Path parameters
vrnstring required
Example:123456789
VAT registration number. <br> A nine-digit number.
periodKeystring required
Example:18AD, 18A1, #001
The ID code for the period that this obligation belongs to. The format is a string of four alphanumeric characters. Occasionally the format includes the "#" symbol, which must be URL-encoded.
Headers
Gov-Test-Scenariostring
Example:-
Only in sandbox environment. See Test Data table for all header values.