Sample code for 30+ languages & platforms
PHP Extension

Hungary NAV Manage Annulment Request

See more Hungary NAV Invoicing Examples

Demonstrates the manageAnnulment request for the Hungarian NAV Online Invoicing System REST API v2.0.

Chilkat PHP Extension Downloads

PHP Extension
<?php

include("chilkat.php");

$success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Build the following XML:

// Use this online tool to generate code from sample XML: 
// Generate Code to Create XML

// <?xml version="1.0" encoding="UTF-8"?>
// <ManageAnnulmentRequest xmlns="http://schemas.nav.gov.hu/OSA/2.0/api">
// 	<header>
// 		<requestId>RID338592103413</requestId>
// 		<timestamp>2019-09-11T13:37:09.385Z</timestamp>
// 		<requestVersion>2.0</requestVersion>
// 		<headerVersion>1.0</headerVersion>
// 	</header>
// 	<user>
// 		<login>lwilsmn0uqdxe6u</login>
// 		<passwordHash>2F43840A882CFDB7DB0 ... F6CA57FE8CD74DC28E</passwordHash>
// 		<taxNumber>11111111</taxNumber>
// 		<requestSignature>A297E3BD9 ... 1959ADFAF5</requestSignature>
// 	</user>
// 	<software>
// 		<softwareId>123456789123456789</softwareId>
// 		<softwareName>string</softwareName>
// 		<softwareOperation>LOCAL_SOFTWARE</softwareOperation>
// 		<softwareMainVersion>string</softwareMainVersion>
// 		<softwareDevName>string</softwareDevName>
// 		<softwareDevContact>string</softwareDevContact>
// 		<softwareDevCountryCode>HU</softwareDevCountryCode>
// 		<softwareDevTaxNumber>string</softwareDevTaxNumber>
// 	</software>
// 	<exchangeToken>dbd03076-3a9b-4312-bbbb-0cee3a6472572P11CS49ASIL</exchangeToken>
// 	<annulmentOperations>
// 		<annulmentOperation>
// 			<index>1</index>
// 			<annulmentOperation>ANNUL</annulmentOperation>
// 			<invoiceAnnulment>PD94bWwgdm ... ubnVsbWVudD4=</invoiceAnnulment>
// 		</annulmentOperation>
// 	</annulmentOperations>
// </ManageAnnulmentRequest>

$crypt = new CkCrypt2();

$dtNow = new CkDateTime();
$dtNow->SetFromCurrentSystemTime();
print $dtNow->getAsTimestamp(false) . "\n";

// The hash algorithm for the password is SHA512 (not SHA3-512).
$crypt->put_HashAlgorithm('sha512');
$crypt->put_EncodingMode('hex');
$myPassword = 'my-password';
$passwordHash = $crypt->hashStringENC($myPassword);

// Generate a random request ID like "RID215118906689"
$prng = new CkPrng();
$sbRequestId = new CkStringBuilder();
$sbRequestId->Append('RID');
$sbRequestId->Append($prng->randomString(12,true,false,false));
print 'generated requestId = ' . $sbRequestId->getAsString() . "\n";

// Calculate the requestSignature
$crypt->put_HashAlgorithm('sha3-512');
$signatureKey = 'ce-8f5e-215119fa7dd621DLMRHRLH2S';

$sbFinalHashBase = new CkStringBuilder();

// First append the timestamp because we are going to remove certain chars/parts.
$sbFinalHashBase->Append($dtNow->getAsTimestamp(false));
$numReplaced = $sbFinalHashBase->Replace('Z','');
$numReplaced = $sbFinalHashBase->Replace('-','');
$numReplaced = $sbFinalHashBase->Replace(':','');
$numReplaced = $sbFinalHashBase->Replace('T','');

// Prepend the requestId and append the signatureKey
$sbFinalHashBase->Prepend($sbRequestId->getAsString());
$sbFinalHashBase->Append($signatureKey);

// Calculate first (and only) index hash.
$invoiceOperation = 'ANNUL';
$invoiceData = 'PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4=';

$sbHashBase = new CkStringBuilder();
$sbHashBase->Append($invoiceOperation);
$sbHashBase->Append($invoiceData);
$firstHash = $crypt->hashStringENC($sbHashBase->getAsString());

// Append the index hash to the final hash base.
$sbFinalHashBase->Append($firstHash);

// Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
$requestSignature = $crypt->hashStringENC($sbFinalHashBase->getAsString());

// Load our recently obtained exchange token.
// See Hungary NAV Invoicing Token Exchange Sample Code
$xmlExchangeToken = new CkXml();
$success = $xmlExchangeToken->LoadXmlFile('qa_data/tokens/nav_exchange_token.xml');
if ($success == false) {
    print $xmlExchangeToken->lastErrorText() . "\n";
    exit;
}

// Get the base64 encoded/encrypted exchange token.
// IMPORTANT:  Make sure to use the exchange token before it expires.
// If it expired, then get a new one..
$encodedEncryptedExchangeToken = $xmlExchangeToken->getChildContent('encodedExchangeToken');

// Decode to binary.
$bdExchangeToken = new CkBinData();
$bdExchangeToken->AppendEncoded($encodedEncryptedExchangeToken,'base64');

// Decrypt using your 16-digit replacement key:
$crypt->put_CryptAlgorithm('aes');
$crypt->put_CipherMode('ecb');
$crypt->put_KeyLength(128);
$crypt->put_EncodingMode('base64');
// Pass your 16-digit replacement key here:
$crypt->SetEncodedKey('99952BBAAAAA8XYZ','ascii');
$crypt->DecryptBd($bdExchangeToken);
$exchangeToken = $bdExchangeToken->getString('utf-8');
print 'exchange token = ' . $exchangeToken . "\n";

// Now build the XML..
$xml = new CkXml();
$xml->put_Tag('ManageAnnulmentRequest');
$xml->AddAttribute('xmlns','http://schemas.nav.gov.hu/OSA/2.0/api');
$xml->UpdateChildContent('header|requestId',$sbRequestId->getAsString());
$xml->UpdateChildContent('header|timestamp',$dtNow->getAsTimestamp(false));
$xml->UpdateChildContent('header|requestVersion','2.0');
$xml->UpdateChildContent('header|headerVersion','1.0');
$xml->UpdateChildContent('user|login','lwilsmn0uqdxe6u');
$xml->UpdateChildContent('user|passwordHash',$passwordHash);
$xml->UpdateChildContent('user|taxNumber','11111111');
$xml->UpdateChildContent('user|requestSignature',$requestSignature);
$xml->UpdateChildContent('software|softwareId','123456789123456789');
$xml->UpdateChildContent('software|softwareName','string');
$xml->UpdateChildContent('software|softwareOperation','LOCAL_SOFTWARE');
$xml->UpdateChildContent('software|softwareMainVersion','string');
$xml->UpdateChildContent('software|softwareDevName','string');
$xml->UpdateChildContent('software|softwareDevContact','string');
$xml->UpdateChildContent('software|softwareDevCountryCode','HU');
$xml->UpdateChildContent('software|softwareDevTaxNumber','string');
$xml->UpdateChildContent('exchangeToken',$exchangeToken);
$xml->UpdateChildContent('annulmentOperations|annulmentOperation|index','1');
$xml->UpdateChildContent('annulmentOperations|annulmentOperation|annulmentOperation',$invoiceOperation);
$xml->UpdateChildContent('annulmentOperations|annulmentOperation|invoiceAnnulment',$invoiceData);

// POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
$http = new CkHttp();
$http->put_Accept('application/xml');
$endpoint = 'https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment';
$resp = new CkHttpResponse();
$success = $http->HttpStr('POST',$endpoint,$xml->getXml(),'utf-8','application/xml',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $resp->get_StatusCode() . "\n";

$respXml = new CkXml();
$respXml->LoadXml($resp->bodyStr());
print 'Response body:' . "\n";
print $respXml->getXml() . "\n";

// The result looks like this:

// <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
// <ManageAnnulmentResponse xmlns="http://schemas.nav.gov.hu/OSA/2.0/api" xmlns:ns2="http://schemas.nav.gov.hu/OSA/2.0/data">
//     <header>
//         <requestId>RID465317110495</requestId>
//         <timestamp>2020-03-25T15:08:40Z</timestamp>
//         <requestVersion>2.0</requestVersion>
//         <headerVersion>1.0</headerVersion>
//     </header>
//     <result>
//         <funcCode>OK</funcCode>
//     </result>
//     <software>
//         <softwareId>123456789123456789</softwareId>
//         <softwareName>string</softwareName>
//         <softwareOperation>LOCAL_SOFTWARE</softwareOperation>
//         <softwareMainVersion>string</softwareMainVersion>
//         <softwareDevName>string</softwareDevName>
//         <softwareDevContact>string</softwareDevContact>
//         <softwareDevCountryCode>HU</softwareDevCountryCode>
//         <softwareDevTaxNumber>string</softwareDevTaxNumber>
//     </software>
//     <transactionId>2WT6XG9LQ0U9VQNA</transactionId>
// </ManageAnnulmentResponse>

// Use this online tool to generate parsing code from sample XML: 
// Generate Parsing Code from XML

$ManageAnnulmentResponse_xmlns = $respXml->getAttrValue('xmlns');
$ManageAnnulmentResponse_xmlns_ns2 = $respXml->getAttrValue('xmlns:ns2');
$requestId = $respXml->getChildContent('header|requestId');
$timestamp = $respXml->getChildContent('header|timestamp');
$requestVersion = $respXml->getChildContent('header|requestVersion');
$headerVersion = $respXml->getChildContent('header|headerVersion');
$funcCode = $respXml->getChildContent('result|funcCode');
$softwareId = $respXml->getChildContent('software|softwareId');
$softwareName = $respXml->getChildContent('software|softwareName');
$softwareOperation = $respXml->getChildContent('software|softwareOperation');
$softwareMainVersion = $respXml->getChildContent('software|softwareMainVersion');
$softwareDevName = $respXml->getChildContent('software|softwareDevName');
$softwareDevContact = $respXml->getChildContent('software|softwareDevContact');
$softwareDevCountryCode = $respXml->getChildContent('software|softwareDevCountryCode');
$softwareDevTaxNumber = $respXml->getChildContent('software|softwareDevTaxNumber');
$transactionId = $respXml->getChildContent('transactionId');

?>