Perl HMRC VAT MTD: Retrieve VAT Payments

Back to Index

Retrieve VAT payments

Documentation: https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-payments_get_accordion

CURL Command

curl -X GET  https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/payments?from=2018-06-25&to=2019-02-17 \
-H 'Authorization: Bearer HMRC_ACCESS_TOKEN' \
-H 'Accept: application/vnd.hmrc.1.0+json'

Perl Example

use chilkat();

$rest = chilkat::CkRest->new();

#  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/payments?from=2018-06-25&to=2019-02-17
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect("test-api.service.hmrc.gov.uk",$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

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

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/organisations/vat/MY_HMRC_VRN/payments?from=2018-06-25&to=2019-02-17",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

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

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

#  See the Online Tool for Generating JSON Parse Code

$i = 0;
$count_i = $jsonResponse->SizeOfArray("payments");
while ($i < $count_i) {
    $jsonResponse->put_I($i);
    $amount = $jsonResponse->stringOf("payments[i].amount");
    $received = $jsonResponse->stringOf("payments[i].received");
    $i = $i + 1;
}

Sample JSON Response Body

{
  "payments": [
    {
      "amount": 100.05,
      "received": "2018-04-06"
    }
  ]
}