Xojo Plugin HMRC VAT MTD: View VAT Return

Back to Index

Retrieve a previously submitted VAT return. This example retrieves the VAT return with period key "A001".

Documentation: https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_view-vat-return_get_accordion

CURL Command

curl -X GET  https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001 \
-H 'Authorization: Bearer HMRC_ACCESS_TOKEN' \
-H 'Accept: application/vnd.hmrc.1.0+json'

Xojo Plugin Example

Dim rest As New Chilkat.Rest
Dim success As Boolean

//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect)
If (success <> True) Then
    System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
    System.DebugLog(rest.LastErrorText)
    Return
End If

success = rest.AddHeader("Authorization","Bearer HMRC_ACCESS_TOKEN")
success = rest.AddHeader("Accept","application/vnd.hmrc.1.0+json")

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/returns/A001",sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
If (respStatusCode >= 400) Then
    System.DebugLog("Response Status Code = " + Str(respStatusCode))
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog("Response Body:")
    System.DebugLog(sbResponseBody.GetAsString())
    Return
End If

Dim jsonResponse As New Chilkat.JsonObject
success = jsonResponse.LoadSb(sbResponseBody)

//  See the Online Tool for Generating JSON Parse Code
Dim periodKey As String
Dim vatDueSales As String
Dim vatDueAcquisitions As String
Dim totalVatDue As String
Dim vatReclaimedCurrPeriod As String
Dim netVatDue As String
Dim totalValueSalesExVAT As Int32
Dim totalValuePurchasesExVAT As Int32
Dim totalValueGoodsSuppliedExVAT As Int32
Dim totalAcquisitionsExVAT As Int32

periodKey = jsonResponse.StringOf("periodKey")
vatDueSales = jsonResponse.StringOf("vatDueSales")
vatDueAcquisitions = jsonResponse.StringOf("vatDueAcquisitions")
totalVatDue = jsonResponse.StringOf("totalVatDue")
vatReclaimedCurrPeriod = jsonResponse.StringOf("vatReclaimedCurrPeriod")
netVatDue = jsonResponse.StringOf("netVatDue")
totalValueSalesExVAT = jsonResponse.IntOf("totalValueSalesExVAT")
totalValuePurchasesExVAT = jsonResponse.IntOf("totalValuePurchasesExVAT")
totalValueGoodsSuppliedExVAT = jsonResponse.IntOf("totalValueGoodsSuppliedExVAT")
totalAcquisitionsExVAT = jsonResponse.IntOf("totalAcquisitionsExVAT")

Sample JSON Response Body

{
  "periodKey": "A001",
  "vatDueSales": 105.5,
  "vatDueAcquisitions": -100.45,
  "totalVatDue": 5.05,
  "vatReclaimedCurrPeriod": 105.15,
  "netVatDue": 100.1,
  "totalValueSalesExVAT": 300,
  "totalValuePurchasesExVAT": 300,
  "totalValueGoodsSuppliedExVAT": 3000,
  "totalAcquisitionsExVAT": 3000
}