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

Ruby Example

require 'chilkat'

rest = Chilkat::CkRest.new()

#  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/liabilities?from=2018-06-25&to=2019-02-17
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

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

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/liabilities?from=2018-06-25&to=2019-02-17",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
if (respStatusCode >= 400)
    print "Response Status Code = " + respStatusCode.to_s() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)

#  See the Online Tool for Generating JSON Parse Code

i = 0
count_i = jsonResponse.SizeOfArray("liabilities")
while i < count_i
    jsonResponse.put_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"
    }
  ]
}