(Delphi DLL) Hungary NAV Manage Annulment Request

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

Note: This example requires Chilkat v9.5.0.83 or greater.

For more information, see https://onlineszamla.nav.gov.hu/api/files/container/download/Online%20Szamla_Interfesz%20specifik%C3%A1ci%C3%B3_EN_v2.0.pdf

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, CkDateTime, Prng, HttpResponse, StringBuilder, BinData, Xml, Crypt2;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
crypt: HCkCrypt2;
dtNow: HCkDateTime;
myPassword: PWideChar;
passwordHash: PWideChar;
prng: HCkPrng;
sbRequestId: HCkStringBuilder;
signatureKey: PWideChar;
sbFinalHashBase: HCkStringBuilder;
numReplaced: Integer;
invoiceOperation: PWideChar;
invoiceData: PWideChar;
sbHashBase: HCkStringBuilder;
firstHash: PWideChar;
requestSignature: PWideChar;
xmlExchangeToken: HCkXml;
encodedEncryptedExchangeToken: PWideChar;
bdExchangeToken: HCkBinData;
exchangeToken: PWideChar;
xml: HCkXml;
http: HCkHttp;
endpoint: PWideChar;
resp: HCkHttpResponse;
respXml: HCkXml;
ManageAnnulmentResponse_xmlns: PWideChar;
ManageAnnulmentResponse_xmlns_ns2: PWideChar;
requestId: PWideChar;
timestamp: PWideChar;
requestVersion: PWideChar;
headerVersion: PWideChar;
funcCode: PWideChar;
softwareId: PWideChar;
softwareName: PWideChar;
softwareOperation: PWideChar;
softwareMainVersion: PWideChar;
softwareDevName: PWideChar;
softwareDevContact: PWideChar;
softwareDevCountryCode: PWideChar;
softwareDevTaxNumber: PWideChar;
transactionId: PWideChar;

begin
// 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 := CkCrypt2_Create();

dtNow := CkDateTime_Create();
CkDateTime_SetFromCurrentSystemTime(dtNow);
Memo1.Lines.Add(CkDateTime__getAsTimestamp(dtNow,False));

// The hash algorithm for the password is SHA512 (not SHA3-512).
CkCrypt2_putHashAlgorithm(crypt,'sha512');
CkCrypt2_putEncodingMode(crypt,'hex');
myPassword := 'my-password';
passwordHash := CkCrypt2__hashStringENC(crypt,myPassword);

// Generate a random request ID like "RID215118906689"
prng := CkPrng_Create();
sbRequestId := CkStringBuilder_Create();
CkStringBuilder_Append(sbRequestId,'RID');
CkStringBuilder_Append(sbRequestId,CkPrng__randomString(prng,12,True,False,False));
Memo1.Lines.Add('generated requestId = ' + CkStringBuilder__getAsString(sbRequestId));

// Calculate the requestSignature
CkCrypt2_putHashAlgorithm(crypt,'sha3-512');
signatureKey := 'ce-8f5e-215119fa7dd621DLMRHRLH2S';

sbFinalHashBase := CkStringBuilder_Create();

// First append the timestamp because we are going to remove certain chars/parts.
CkStringBuilder_Append(sbFinalHashBase,CkDateTime__getAsTimestamp(dtNow,False));
numReplaced := CkStringBuilder_Replace(sbFinalHashBase,'Z','');
numReplaced := CkStringBuilder_Replace(sbFinalHashBase,'-','');
numReplaced := CkStringBuilder_Replace(sbFinalHashBase,':','');
numReplaced := CkStringBuilder_Replace(sbFinalHashBase,'T','');

// Prepend the requestId and append the signatureKey
CkStringBuilder_Prepend(sbFinalHashBase,CkStringBuilder__getAsString(sbRequestId));
CkStringBuilder_Append(sbFinalHashBase,signatureKey);

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

sbHashBase := CkStringBuilder_Create();
CkStringBuilder_Append(sbHashBase,invoiceOperation);
CkStringBuilder_Append(sbHashBase,invoiceData);
firstHash := CkCrypt2__hashStringENC(crypt,CkStringBuilder__getAsString(sbHashBase));

// Append the index hash to the final hash base.
CkStringBuilder_Append(sbFinalHashBase,firstHash);

// Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
requestSignature := CkCrypt2__hashStringENC(crypt,CkStringBuilder__getAsString(sbFinalHashBase));

// Load our recently obtained exchange token.
// See Hungary NAV Invoicing Token Exchange Sample Code
xmlExchangeToken := CkXml_Create();
success := CkXml_LoadXmlFile(xmlExchangeToken,'qa_data/tokens/nav_exchange_token.xml');
if (success = False) then
  begin
    Memo1.Lines.Add(CkXml__lastErrorText(xmlExchangeToken));
    Exit;
  end;
// 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 := CkXml__getChildContent(xmlExchangeToken,'encodedExchangeToken');

// Decode to binary.
bdExchangeToken := CkBinData_Create();
CkBinData_AppendEncoded(bdExchangeToken,encodedEncryptedExchangeToken,'base64');

// Decrypt using your 16-digit replacement key:
CkCrypt2_putCryptAlgorithm(crypt,'aes');
CkCrypt2_putCipherMode(crypt,'ecb');
CkCrypt2_putKeyLength(crypt,128);
CkCrypt2_putEncodingMode(crypt,'base64');
// Pass your 16-digit replacement key here:
CkCrypt2_SetEncodedKey(crypt,'99952BBAAAAA8XYZ','ascii');
CkCrypt2_DecryptBd(crypt,bdExchangeToken);
exchangeToken := CkBinData__getString(bdExchangeToken,'utf-8');
Memo1.Lines.Add('exchange token = ' + exchangeToken);

// Now build the XML..
xml := CkXml_Create();
CkXml_putTag(xml,'ManageAnnulmentRequest');
CkXml_AddAttribute(xml,'xmlns','http://schemas.nav.gov.hu/OSA/2.0/api');
CkXml_UpdateChildContent(xml,'header|requestId',CkStringBuilder__getAsString(sbRequestId));
CkXml_UpdateChildContent(xml,'header|timestamp',CkDateTime__getAsTimestamp(dtNow,False));
CkXml_UpdateChildContent(xml,'header|requestVersion','2.0');
CkXml_UpdateChildContent(xml,'header|headerVersion','1.0');
CkXml_UpdateChildContent(xml,'user|login','lwilsmn0uqdxe6u');
CkXml_UpdateChildContent(xml,'user|passwordHash',passwordHash);
CkXml_UpdateChildContent(xml,'user|taxNumber','11111111');
CkXml_UpdateChildContent(xml,'user|requestSignature',requestSignature);
CkXml_UpdateChildContent(xml,'software|softwareId','123456789123456789');
CkXml_UpdateChildContent(xml,'software|softwareName','string');
CkXml_UpdateChildContent(xml,'software|softwareOperation','LOCAL_SOFTWARE');
CkXml_UpdateChildContent(xml,'software|softwareMainVersion','string');
CkXml_UpdateChildContent(xml,'software|softwareDevName','string');
CkXml_UpdateChildContent(xml,'software|softwareDevContact','string');
CkXml_UpdateChildContent(xml,'software|softwareDevCountryCode','HU');
CkXml_UpdateChildContent(xml,'software|softwareDevTaxNumber','string');
CkXml_UpdateChildContent(xml,'exchangeToken',exchangeToken);
CkXml_UpdateChildContent(xml,'annulmentOperations|annulmentOperation|index','1');
CkXml_UpdateChildContent(xml,'annulmentOperations|annulmentOperation|annulmentOperation',invoiceOperation);
CkXml_UpdateChildContent(xml,'annulmentOperations|annulmentOperation|invoiceAnnulment',invoiceData);

// POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
http := CkHttp_Create();
CkHttp_putAccept(http,'application/xml');
CkHttp_SetRequestHeader(http,'Content-Type','application/xml');
endpoint := 'https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment';
resp := CkHttp_PostXml(http,endpoint,CkXml__getXml(xml),'utf-8');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add('Response status code = ' + IntToStr(CkHttpResponse_getStatusCode(resp)));

respXml := CkXml_Create();
CkXml_LoadXml(respXml,CkHttpResponse__bodyStr(resp));
Memo1.Lines.Add('Response body:');
Memo1.Lines.Add(CkXml__getXml(respXml));

CkHttpResponse_Dispose(resp);

// 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 := CkXml__getAttrValue(respXml,'xmlns');
ManageAnnulmentResponse_xmlns_ns2 := CkXml__getAttrValue(respXml,'xmlns:ns2');
requestId := CkXml__getChildContent(respXml,'header|requestId');
timestamp := CkXml__getChildContent(respXml,'header|timestamp');
requestVersion := CkXml__getChildContent(respXml,'header|requestVersion');
headerVersion := CkXml__getChildContent(respXml,'header|headerVersion');
funcCode := CkXml__getChildContent(respXml,'result|funcCode');
softwareId := CkXml__getChildContent(respXml,'software|softwareId');
softwareName := CkXml__getChildContent(respXml,'software|softwareName');
softwareOperation := CkXml__getChildContent(respXml,'software|softwareOperation');
softwareMainVersion := CkXml__getChildContent(respXml,'software|softwareMainVersion');
softwareDevName := CkXml__getChildContent(respXml,'software|softwareDevName');
softwareDevContact := CkXml__getChildContent(respXml,'software|softwareDevContact');
softwareDevCountryCode := CkXml__getChildContent(respXml,'software|softwareDevCountryCode');
softwareDevTaxNumber := CkXml__getChildContent(respXml,'software|softwareDevTaxNumber');
transactionId := CkXml__getChildContent(respXml,'transactionId');

CkCrypt2_Dispose(crypt);
CkDateTime_Dispose(dtNow);
CkPrng_Dispose(prng);
CkStringBuilder_Dispose(sbRequestId);
CkStringBuilder_Dispose(sbFinalHashBase);
CkStringBuilder_Dispose(sbHashBase);
CkXml_Dispose(xmlExchangeToken);
CkBinData_Dispose(bdExchangeToken);
CkXml_Dispose(xml);
CkHttp_Dispose(http);
CkXml_Dispose(respXml);

end;