PHP Extension 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'

PHP Extension Example

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

$rest = new CkRest();

//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns/A001
$bTls = true;
$port = 443;
$bAutoReconnect = true;
$success = $rest->Connect('test-api.service.hmrc.gov.uk',$port,$bTls,$bAutoReconnect);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    exit;
}

$rest->AddHeader('Authorization','Bearer HMRC_ACCESS_TOKEN');
$rest->AddHeader('Accept','application/vnd.hmrc.1.0+json');

$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestNoBodySb('GET','/organisations/vat/MY_HMRC_VRN/returns/A001',$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
if ($respStatusCode >= 400) {
    print 'Response Status Code = ' . $respStatusCode . "\n";
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

$jsonResponse = new CkJsonObject();
$jsonResponse->LoadSb($sbResponseBody);

//  See the Online Tool for Generating JSON Parse Code

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