Node.js 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'

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node10_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node10_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node10_linux32');
    } else {
        var chilkat = require('chilkat_node10_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node10_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/returns/A001",sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    if (respStatusCode >= 400) {
        console.log("Response Status Code = " + respStatusCode);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    //  See the Online Tool for Generating JSON Parse Code
    var periodKey;
    var vatDueSales;
    var vatDueAcquisitions;
    var totalVatDue;
    var vatReclaimedCurrPeriod;
    var netVatDue;
    var totalValueSalesExVAT;
    var totalValuePurchasesExVAT;
    var totalValueGoodsSuppliedExVAT;
    var 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");

}

chilkatExample();

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
}