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

Chilkat.Rest rest = new Chilkat.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) {
    Debug.WriteLine("ConnectFailReason: " + Convert.ToString(rest.ConnectFailReason));
    Debug.WriteLine(rest.LastErrorText);
    return;
}

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = rest.FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/returns/A001",sbResponseBody);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

int respStatusCode = rest.ResponseStatusCode;
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(rest.ResponseHeader);
    Debug.WriteLine("Response Body:");
    Debug.WriteLine(sbResponseBody.GetAsString());
    return;
}

Chilkat.JsonObject jsonResponse = new Chilkat.JsonObject();
jsonResponse.LoadSb(sbResponseBody);

//  See the Online Tool for Generating JSON Parse Code
string periodKey;
string vatDueSales;
string vatDueAcquisitions;
string totalVatDue;
string vatReclaimedCurrPeriod;
string netVatDue;
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
}