Unicode C++ HMRC VAT MTD: Retrieve VAT obligations

Back to Index

Retrieve VAT obligations

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

CURL Command

curl -X GET  https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/obligations?from=2018-06-25&to=2019-01-01 \
-H 'Authorization: Bearer HMRC_ACCESS_TOKEN' \
-H 'Accept: application/vnd.hmrc.1.0+json'

Unicode C++ Example

#include <CkRestW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    CkRestW rest;
    bool success;

    //  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/obligations?from=2018-06-25&to=2019-01-01
    bool bTls = true;
    int port = 443;
    bool bAutoReconnect = true;
    success = rest.Connect(L"test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect);
    if (success != true) {
        wprintf(L"ConnectFailReason: %d\n",rest.get_ConnectFailReason());
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

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

    CkStringBuilderW sbResponseBody;
    success = rest.FullRequestNoBodySb(L"GET",L"/organisations/vat/MY_HMRC_VRN/obligations?from=2018-06-25&to=2019-01-01",sbResponseBody);
    if (success != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    int respStatusCode = rest.get_ResponseStatusCode();
    if (respStatusCode >= 400) {
        wprintf(L"Response Status Code = %d\n",respStatusCode);
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",rest.responseHeader());
        wprintf(L"Response Body:\n");
        wprintf(L"%s\n",sbResponseBody.getAsString());
        return;
    }

    CkJsonObjectW jsonResponse;
    jsonResponse.LoadSb(sbResponseBody);

    //  See the Online Tool for Generating JSON Parse Code
    int i;
    int count_i;
    const wchar_t *start = 0;
    const wchar_t *end = 0;
    const wchar_t *due = 0;
    const wchar_t *status = 0;
    const wchar_t *periodKey = 0;
    const wchar_t *received = 0;

    i = 0;
    count_i = jsonResponse.SizeOfArray(L"obligations");
    while (i < count_i) {
        jsonResponse.put_I(i);
        start = jsonResponse.stringOf(L"obligations[i].start");
        end = jsonResponse.stringOf(L"obligations[i].end");
        due = jsonResponse.stringOf(L"obligations[i].due");
        status = jsonResponse.stringOf(L"obligations[i].status");
        periodKey = jsonResponse.stringOf(L"obligations[i].periodKey");
        received = jsonResponse.stringOf(L"obligations[i].received");
        i = i + 1;
    }
    }

Sample JSON Response Body

{
  "obligations": [
    {
      "start": "2017-01-01",
      "end": "2017-03-31",
      "due": "2017-05-07",
      "status": "F",
      "periodKey": "18A1",
      "received": "2017-05-06"
    },
    {
      "start": "2017-04-01",
      "end": "2017-06-30",
      "due": "2017-08-07",
      "status": "O",
      "periodKey": "18A2"
    }
  ]
}