C++ 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'

C++ Example

#include <CkRest.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    //  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001
    bool bTls = true;
    int port = 443;
    bool bAutoReconnect = true;
    success = rest.Connect("test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect);
    if (success != true) {
        std::cout << "ConnectFailReason: " << rest.get_ConnectFailReason() << "\r\n";
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

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

    CkStringBuilder sbResponseBody;
    success = rest.FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/returns/A001",sbResponseBody);
    if (success != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    int respStatusCode = rest.get_ResponseStatusCode();
    if (respStatusCode >= 400) {
        std::cout << "Response Status Code = " << respStatusCode << "\r\n";
        std::cout << "Response Header:" << "\r\n";
        std::cout << rest.responseHeader() << "\r\n";
        std::cout << "Response Body:" << "\r\n";
        std::cout << sbResponseBody.getAsString() << "\r\n";
        return;
    }

    CkJsonObject jsonResponse;
    jsonResponse.LoadSb(sbResponseBody);

    //  See the Online Tool for Generating JSON Parse Code
    const char *periodKey = 0;
    const char *vatDueSales = 0;
    const char *vatDueAcquisitions = 0;
    const char *totalVatDue = 0;
    const char *vatReclaimedCurrPeriod = 0;
    const char *netVatDue = 0;
    int totalValueSalesExVAT;
    int totalValuePurchasesExVAT;
    int totalValueGoodsSuppliedExVAT;
    int totalAcquisitionsExVAT;

    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
}