PowerBuilder 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'

PowerBuilder Example

integer li_rc
oleobject loo_Rest
integer li_Success
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_SbResponseBody
integer li_RespStatusCode
oleobject loo_JsonResponse
string ls_PeriodKey
string ls_VatDueSales
string ls_VatDueAcquisitions
string ls_TotalVatDue
string ls_VatReclaimedCurrPeriod
string ls_NetVatDue
integer li_TotalValueSalesExVAT
integer li_TotalValuePurchasesExVAT
integer li_TotalValueGoodsSuppliedExVAT
integer li_TotalAcquisitionsExVAT

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat_9_5_0.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("test-api.service.hmrc.gov.uk",li_Port,li_BTls,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug "ConnectFailReason: " + string(loo_Rest.ConnectFailReason)
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

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

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Rest.FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/returns/A001",loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_SbResponseBody
    return
end if

li_RespStatusCode = loo_Rest.ResponseStatusCode
if li_RespStatusCode >= 400 then
    Write-Debug "Response Status Code = " + string(li_RespStatusCode)
    Write-Debug "Response Header:"
    Write-Debug loo_Rest.ResponseHeader
    Write-Debug "Response Body:"
    Write-Debug loo_SbResponseBody.GetAsString()
    destroy loo_Rest
    destroy loo_SbResponseBody
    return
end if

loo_JsonResponse = create oleobject
li_rc = loo_JsonResponse.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JsonResponse.LoadSb(loo_SbResponseBody)

//  See the Online Tool for Generating JSON Parse Code

ls_PeriodKey = loo_JsonResponse.StringOf("periodKey")
ls_VatDueSales = loo_JsonResponse.StringOf("vatDueSales")
ls_VatDueAcquisitions = loo_JsonResponse.StringOf("vatDueAcquisitions")
ls_TotalVatDue = loo_JsonResponse.StringOf("totalVatDue")
ls_VatReclaimedCurrPeriod = loo_JsonResponse.StringOf("vatReclaimedCurrPeriod")
ls_NetVatDue = loo_JsonResponse.StringOf("netVatDue")
li_TotalValueSalesExVAT = loo_JsonResponse.IntOf("totalValueSalesExVAT")
li_TotalValuePurchasesExVAT = loo_JsonResponse.IntOf("totalValuePurchasesExVAT")
li_TotalValueGoodsSuppliedExVAT = loo_JsonResponse.IntOf("totalValueGoodsSuppliedExVAT")
li_TotalAcquisitionsExVAT = loo_JsonResponse.IntOf("totalAcquisitionsExVAT")


destroy loo_Rest
destroy loo_SbResponseBody
destroy loo_JsonResponse

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
}