Node.js HMRC VAT MTD: Submit VAT return for period

Back to Index

Submit VAT return for period

Documentation: https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_submit-vat-return-for-period_post_accordion

CURL Command

curl -X POST  https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns \
-H 'Authorization: Bearer HMRC_ACCESS_TOKEN' \
-H 'Accept: application/vnd.hmrc.1.0+json' \
-H 'Content-Type: application/json' \
-d '{
  "periodKey": "A001",
  "vatDueSales": 105.50,
  "vatDueAcquisitions": -100.45,
  "totalVatDue": 5.05,
  "vatReclaimedCurrPeriod": 105.15,
  "netVatDue": 100.10,
  "totalValueSalesExVAT": 300,
  "totalValuePurchasesExVAT": 300,
  "totalValueGoodsSuppliedExVAT": 3000,
  "totalAcquisitionsExVAT": 3000,
  "finalised": true
}'

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
    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;
    }

    //  See the Online Tool for Generating JSON Creation Code
    var json = new chilkat.JsonObject();
    json.UpdateString("periodKey","A001");
    json.UpdateNumber("vatDueSales","105.50");
    json.UpdateNumber("vatDueAcquisitions","-100.45");
    json.UpdateNumber("totalVatDue","5.05");
    json.UpdateNumber("vatReclaimedCurrPeriod","105.15");
    json.UpdateNumber("netVatDue","100.10");
    json.UpdateNumber("totalValueSalesExVAT","300");
    json.UpdateNumber("totalValuePurchasesExVAT","300");
    json.UpdateNumber("totalValueGoodsSuppliedExVAT","3000");
    json.UpdateNumber("totalAcquisitionsExVAT","3000");
    json.UpdateBool("finalised",true);

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

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);
    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/organisations/vat/MY_HMRC_VRN/returns",sbRequestBody,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 processingDate;
    var paymentIndicator;
    var formBundleNumber;

    processingDate = jsonResponse.StringOf("processingDate");
    paymentIndicator = jsonResponse.StringOf("paymentIndicator");
    formBundleNumber = jsonResponse.StringOf("formBundleNumber");

}

chilkatExample();

Sample JSON Response Body

{
  "processingDate": "2019-02-18T14:37:56.561Z",
  "paymentIndicator": "BANK",
  "formBundleNumber": "948551092841"
}