Sample code for 30+ languages & platforms
Tcl

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 Tcl Downloads

Download Chilkat for Tcl
Tcl 

load ./chilkat.dll

set success 0

# 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>

set crypt [new_CkCrypt2]

set dtNow [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dtNow
puts [CkDateTime_getAsTimestamp $dtNow 0]

# The hash algorithm for the password is SHA512 (not SHA3-512).
CkCrypt2_put_HashAlgorithm $crypt "sha512"
CkCrypt2_put_EncodingMode $crypt "hex"
set myPassword "my-password"
set passwordHash [CkCrypt2_hashStringENC $crypt $myPassword]

# Generate a random request ID like "RID215118906689"
set prng [new_CkPrng]

set sbRequestId [new_CkStringBuilder]

CkStringBuilder_Append $sbRequestId "RID"
CkStringBuilder_Append $sbRequestId [CkPrng_randomString $prng 12 1 0 0]
puts "generated requestId = [CkStringBuilder_getAsString $sbRequestId]"

# Calculate the requestSignature
CkCrypt2_put_HashAlgorithm $crypt "sha3-512"
set signatureKey "ce-8f5e-215119fa7dd621DLMRHRLH2S"

set sbFinalHashBase [new_CkStringBuilder]

# First append the timestamp because we are going to remove certain chars/parts.
CkStringBuilder_Append $sbFinalHashBase [CkDateTime_getAsTimestamp $dtNow 0]
set numReplaced [CkStringBuilder_Replace $sbFinalHashBase "Z" ""]
set numReplaced [CkStringBuilder_Replace $sbFinalHashBase "-" ""]
set numReplaced [CkStringBuilder_Replace $sbFinalHashBase ":" ""]
set 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.
set invoiceOperation "ANNUL"
set invoiceData "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4="

set sbHashBase [new_CkStringBuilder]

CkStringBuilder_Append $sbHashBase $invoiceOperation
CkStringBuilder_Append $sbHashBase $invoiceData
set 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...)
set requestSignature [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbFinalHashBase]]

# Load our recently obtained exchange token.
# See Hungary NAV Invoicing Token Exchange Sample Code
set xmlExchangeToken [new_CkXml]

set success [CkXml_LoadXmlFile $xmlExchangeToken "qa_data/tokens/nav_exchange_token.xml"]
if {$success == 0} then {
    puts [CkXml_lastErrorText $xmlExchangeToken]
    delete_CkCrypt2 $crypt
    delete_CkDateTime $dtNow
    delete_CkPrng $prng
    delete_CkStringBuilder $sbRequestId
    delete_CkStringBuilder $sbFinalHashBase
    delete_CkStringBuilder $sbHashBase
    delete_CkXml $xmlExchangeToken
    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..
set encodedEncryptedExchangeToken [CkXml_getChildContent $xmlExchangeToken "encodedExchangeToken"]

# Decode to binary.
set bdExchangeToken [new_CkBinData]

CkBinData_AppendEncoded $bdExchangeToken $encodedEncryptedExchangeToken "base64"

# Decrypt using your 16-digit replacement key:
CkCrypt2_put_CryptAlgorithm $crypt "aes"
CkCrypt2_put_CipherMode $crypt "ecb"
CkCrypt2_put_KeyLength $crypt 128
CkCrypt2_put_EncodingMode $crypt "base64"
# Pass your 16-digit replacement key here:
CkCrypt2_SetEncodedKey $crypt "99952BBAAAAA8XYZ" "ascii"
CkCrypt2_DecryptBd $crypt $bdExchangeToken
set exchangeToken [CkBinData_getString $bdExchangeToken "utf-8"]
puts "exchange token = $exchangeToken"

# Now build the XML..
set xml [new_CkXml]

CkXml_put_Tag $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 0]
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
set http [new_CkHttp]

CkHttp_put_Accept $http "application/xml"
set endpoint "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment"
set resp [new_CkHttpResponse]

set success [CkHttp_HttpStr $http "POST" $endpoint [CkXml_getXml $xml] "utf-8" "application/xml" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkCrypt2 $crypt
    delete_CkDateTime $dtNow
    delete_CkPrng $prng
    delete_CkStringBuilder $sbRequestId
    delete_CkStringBuilder $sbFinalHashBase
    delete_CkStringBuilder $sbHashBase
    delete_CkXml $xmlExchangeToken
    delete_CkBinData $bdExchangeToken
    delete_CkXml $xml
    delete_CkHttp $http
    delete_CkHttpResponse $resp
    exit
}

puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"

set respXml [new_CkXml]

CkXml_LoadXml $respXml [CkHttpResponse_bodyStr $resp]
puts "Response body:"
puts [CkXml_getXml $respXml]

# 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

set ManageAnnulmentResponse_xmlns [CkXml_getAttrValue $respXml "xmlns"]
set ManageAnnulmentResponse_xmlns_ns2 [CkXml_getAttrValue $respXml "xmlns:ns2"]
set requestId [CkXml_getChildContent $respXml "header|requestId"]
set timestamp [CkXml_getChildContent $respXml "header|timestamp"]
set requestVersion [CkXml_getChildContent $respXml "header|requestVersion"]
set headerVersion [CkXml_getChildContent $respXml "header|headerVersion"]
set funcCode [CkXml_getChildContent $respXml "result|funcCode"]
set softwareId [CkXml_getChildContent $respXml "software|softwareId"]
set softwareName [CkXml_getChildContent $respXml "software|softwareName"]
set softwareOperation [CkXml_getChildContent $respXml "software|softwareOperation"]
set softwareMainVersion [CkXml_getChildContent $respXml "software|softwareMainVersion"]
set softwareDevName [CkXml_getChildContent $respXml "software|softwareDevName"]
set softwareDevContact [CkXml_getChildContent $respXml "software|softwareDevContact"]
set softwareDevCountryCode [CkXml_getChildContent $respXml "software|softwareDevCountryCode"]
set softwareDevTaxNumber [CkXml_getChildContent $respXml "software|softwareDevTaxNumber"]
set transactionId [CkXml_getChildContent $respXml "transactionId"]

delete_CkCrypt2 $crypt
delete_CkDateTime $dtNow
delete_CkPrng $prng
delete_CkStringBuilder $sbRequestId
delete_CkStringBuilder $sbFinalHashBase
delete_CkStringBuilder $sbHashBase
delete_CkXml $xmlExchangeToken
delete_CkBinData $bdExchangeToken
delete_CkXml $xml
delete_CkHttp $http
delete_CkHttpResponse $resp
delete_CkXml $respXml