This version is in beta - expect some breaking changes.
Bulk Data File List API
|Available in Sandbox||Yes|
|Sandbox base URL||https://test-api.service.hmrc.gov.uk|
|Available in Production||No|
The API lists the bulk data files available for download for a specific information type.
Available Information Type
- Daily Tariff Files (TARIFF-DAILY)
- Monthly Tariff Files (TARIFF-MONTHLY)
- Annual Tariff Files (TARIFF-ANNUAL)
When an API changes in a way that is backwards-incompatible, we increase the version number of the API. See our reference guide for more on versioning.
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
- 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response. See our reference guide for more on errors.
Testing the API
You can use the sandbox environment to test this API.