Delphi ActiveX HMRC VAT MTD: Retrieve VAT Liabilities

Back to Index

Retrieve VAT liabilities

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

CURL Command

curl -X GET  https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/liabilities?from=2018-06-25&to=2019-02-17 \
-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;
i: Integer;
count_i: Integer;
taxPeriodFrom: WideString;
taxPeriodTo: WideString;
type: WideString;
originalAmount: WideString;
outstandingAmount: WideString;
due: WideString;

begin
rest := TChilkatRest.Create(Self);

//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/liabilities?from=2018-06-25&to=2019-02-17
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/liabilities?from=2018-06-25&to=2019-02-17',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

i := 0;
count_i := jsonResponse.SizeOfArray('liabilities');
while i < count_i do
  begin
    jsonResponse.I := i;
    taxPeriodFrom := jsonResponse.StringOf('liabilities[i].taxPeriod.from');
    taxPeriodTo := jsonResponse.StringOf('liabilities[i].taxPeriod.to');
    type := jsonResponse.StringOf('liabilities[i].type');
    originalAmount := jsonResponse.StringOf('liabilities[i].originalAmount');
    outstandingAmount := jsonResponse.StringOf('liabilities[i].outstandingAmount');
    due := jsonResponse.StringOf('liabilities[i].due');
    i := i + 1;
  end;

Sample JSON Response Body

{
  "liabilities": [
    {
      "taxPeriod": {
        "from": "2018-04-06",
        "to": "2018-07-06"
      },
      "type": "VAT ...",
      "originalAmount": 6000.3,
      "outstandingAmount": 100.51,
      "due": "2018-07-06"
    }
  ]
}