v1
latestOpenAPI 3.0.32026-07-13833259.3 KBorganisations
Retrieve VAT payments
Retrieve VAT payments
Test data
<p>Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.</p> <table> <thead> <tr> <th>Header Value (Gov-Test-Scenario)</th> <th>Scenario</th> </tr> </thead> <tbody> <tr> <td><p>Default (no header value)</p></td> <td><p>Simulates the scenario where the endpoint has indicated that no associated data could be found.</p></td> </tr> <tr> <td><p>SINGLE_PAYMENT</p></td> <td><p>Returns a single valid payment when used with dates from 2017-01-02 and to 2017-02-02.</p></td> </tr> <tr> <td><p>MULTIPLE_PAYMENTS</p></td> <td><p>Returns multiple valid payments when used with dates from 2017-02-27 and to 2017-12-21.</p></td> </tr> <tr> <td><p>SINGLE_PAYMENT_2018_19</p></td> <td><p>Returns a single valid payment when used with dates from 2018-01-02 and to 2018-02-02.</p></td> </tr> <tr> <td><p>MULTIPLE_PAYMENTS_2018_19</p></td> <td><p>Returns multiple valid payments when used with dates from 2018-02-27 and to 2018-12-21.</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> <p>The 'to' date of the payment must fall within the date range provided.</p>get/organisations/vat/{vrn}/payments
Path parameters
vrnstring required
Example:123456789
VAT registration number. <br> A nine-digit number.
Query parameters
fromstring required
Example:2018-01-25
Payments to return from date, the minimum 'from' date is 2017-12-01
tostring required
Example:2018-12-31
Payments to return up to date, the maximum 'to' date is the current date
Headers
Gov-Test-Scenariostring
Example:-
Only in sandbox environment. See Test Data table for all header values.
Response
Example response
{
"payments": [
{
"received": "2017-01-25"
}
]
}