Delphi ActiveX 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'

Delphi ActiveX Example

var
rest: TChilkatRest;
success: Integer;
bTls: Integer;
port: Integer;
bAutoReconnect: Integer;
sbResponseBody: TChilkatStringBuilder;
respStatusCode: Integer;
jsonResponse: TChilkatJsonObject;
periodKey: WideString;
vatDueSales: WideString;
vatDueAcquisitions: WideString;
totalVatDue: WideString;
vatReclaimedCurrPeriod: WideString;
netVatDue: WideString;
totalValueSalesExVAT: Integer;
totalValuePurchasesExVAT: Integer;
totalValueGoodsSuppliedExVAT: Integer;
totalAcquisitionsExVAT: Integer;

begin
rest := TChilkatRest.Create(Self);

//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001
bTls := 1;
port := 443;
bAutoReconnect := 1;
success := rest.Connect('test-api.service.hmrc.gov.uk',port,bTls,bAutoReconnect);
if (success <> 1) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(rest.ConnectFailReason));
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

rest.AddHeader('Authorization','Bearer HMRC_ACCESS_TOKEN');
rest.AddHeader('Accept','application/vnd.hmrc.1.0+json');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestNoBodySb('GET','/organisations/vat/MY_HMRC_VRN/returns/A001',sbResponseBody.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;
respStatusCode := rest.ResponseStatusCode;
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(rest.ResponseHeader);
    Memo1.Lines.Add('Response Body:');
    Memo1.Lines.Add(sbResponseBody.GetAsString());
    Exit;
  end;

jsonResponse := TChilkatJsonObject.Create(Self);
jsonResponse.LoadSb(sbResponseBody.ControlInterface);

//  See the Online Tool for Generating JSON Parse Code

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
}