iotoms Docs

Get a UK VAT return

GET
/api/v1/reports/tax/europe/uk-vat-return

Returns the UK VAT return between from and to in the 9-box format used for HMRC Making Tax Digital submissions. Only sales figures are filled today (purchase and EU boxes are 0), and the return is not submitted. Requires the merchant's VAT and MTD numbers.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from*string

Period start (yyyy-MM-dd)

Formatdate
to*string

Period end (yyyy-MM-dd)

Formatdate

Header Parameters

X-TenantID*string

Tenant identifier

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?

The UK 9-box VAT return for the requested period.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/europe/uk-vat-return?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "tenantId": "string",    "currency": "string",    "from": "2019-08-24",    "to": "2019-08-24",    "vatRegistrationNumber": "string",    "mtdVrn": "string",    "periodKey": "string",    "box1VatDueOnSales": 0,    "box2VatDueOnAcquisitions": 0,    "box3TotalVatDue": 0,    "box4VatReclaimedOnPurchases": 0,    "box5NetVatPayable": 0,    "box6TotalValueSalesExVat": 0,    "box7TotalValuePurchasesExVat": 0,    "box8TotalValueGoodsSuppliedExVat": 0,    "box9TotalAcquisitionsExVat": 0,    "finalised": true,    "transactionCount": 0  }}