(Tcl) Hungary NAV Manage Invoice Request

Demonstrates the manageInvoice 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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"?>
# <ManageInvoiceRequest xmlns="http://schemas.nav.gov.hu/OSA/2.0/api">
# 	<header>
# 		<requestId>RID181837288942</requestId>
# 		<timestamp>2019-09-11T12:44:55.442Z</timestamp>
# 		<requestVersion>2.0</requestVersion>
# 		<headerVersion>1.0</headerVersion>
# 	</header>
# 	<user>
# 		<login>lwilsmn0uqdxe6u</login>
# 		<passwordHash>2F43840A882CFDB7DB0FEC07D419D030D864B47B6B541DC280EF81B937B7A176E33C052B0D26638CC18A7A2C08D8D311733078A774BF43F6CA57FE8CD74DC28E</passwordHash>
# 		<taxNumber>11111111</taxNumber>
# 		<requestSignature>E4D191A48EE8828A1E84C1F841A2B4E1699ECB49C4CDA1DC7A057765FD935872219644CC2B5A93B8A344404E4FD8ECA4902B5DBCF993E768DC558B0F0281E775</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>b1aca173-d9e8-4561-9237-0511eed99eaa2P0ZHLXBRI2U</exchangeToken>
# 	<invoiceOperations>
# 		<compressedContent>false</compressedContent>
# 		<invoiceOperation>
# 			<index>1</index>
# 			<invoiceOperation>CREATE</invoiceOperation>
# 			<invoiceData>base64 contents of invoiceData1 XML file</invoiceData>
# 		</invoiceOperation>
# 		<invoiceOperation>
# 			<index>2</index>
# 			<invoiceOperation>CREATE</invoiceOperation>
# 			<invoiceData>base64 contents of invoiceData2 XML file</invoiceData>
# 		</invoiceOperation>
# 		<invoiceOperation>
# 			<index>3</index>
# 			<invoiceOperation>CREATE</invoiceOperation>
# 			<invoiceData>base64 contents of invoiceData3 XML file</invoiceData>
# 		</invoiceOperation>
# 	</invoiceOperations>
# </ManageInvoiceRequest>
# 

# First load the invoiceData for the 3 XML invoice files we'll be sending.
set bdInvoiceData1 [new_CkBinData]

set bdInvoiceData2 [new_CkBinData]

set bdInvoiceData3 [new_CkBinData]

set success [CkBinData_LoadFile $bdInvoiceData1 "qa_data/nav_invoicing/invoiceData1.xml"]
set success [CkBinData_LoadFile $bdInvoiceData2 "qa_data/nav_invoicing/invoiceData2.xml"]
set success [CkBinData_LoadFile $bdInvoiceData3 "qa_data/nav_invoicing/invoiceData3.xml"]
if {$success == 0} then {
    puts "Failed to load invoice data."
    delete_CkBinData $bdInvoiceData1
    delete_CkBinData $bdInvoiceData2
    delete_CkBinData $bdInvoiceData3
    exit
}

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 each index hash and add it to the sbFinalHashBase
set sbHashBase [new_CkStringBuilder]

CkStringBuilder_Append $sbHashBase "CREATE"
CkStringBuilder_Append $sbHashBase [CkBinData_getEncoded $bdInvoiceData1 "base64"]
set indexHash [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbHashBase]]
CkStringBuilder_Append $sbFinalHashBase $indexHash

CkStringBuilder_Clear $sbHashBase
CkStringBuilder_Append $sbHashBase "CREATE"
CkStringBuilder_Append $sbHashBase [CkBinData_getEncoded $bdInvoiceData2 "base64"]
set indexHash [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbHashBase]]
CkStringBuilder_Append $sbFinalHashBase $indexHash

CkStringBuilder_Clear $sbHashBase
CkStringBuilder_Append $sbHashBase "CREATE"
CkStringBuilder_Append $sbHashBase [CkBinData_getEncoded $bdInvoiceData3 "base64"]
set indexHash [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbHashBase]]
CkStringBuilder_Append $sbFinalHashBase $indexHash

# 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_CkBinData $bdInvoiceData1
    delete_CkBinData $bdInvoiceData2
    delete_CkBinData $bdInvoiceData3
    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 "ManageInvoiceRequest"
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 "invoiceOperations|compressedContent" "false"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation|index" "1"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation|invoiceOperation" "CREATE"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation|invoiceData" [CkBinData_getEncoded $bdInvoiceData1 "base64"]
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation[1]|index" "2"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation[1]|invoiceOperation" "CREATE"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation[1]|invoiceData" [CkBinData_getEncoded $bdInvoiceData2 "base64"]
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation[2]|index" "3"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation[2]|invoiceOperation" "CREATE"
CkXml_UpdateChildContent $xml "invoiceOperations|invoiceOperation[2]|invoiceData" [CkBinData_getEncoded $bdInvoiceData3 "base64"]

# POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageInvoice
set http [new_CkHttp]

CkHttp_put_Accept $http "application/xml"
CkHttp_SetRequestHeader $http "Content-Type" "application/xml"
set endpoint "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageInvoice"
# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $endpoint [CkXml_getXml $xml] "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkBinData $bdInvoiceData1
    delete_CkBinData $bdInvoiceData2
    delete_CkBinData $bdInvoiceData3
    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
    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]

delete_CkHttpResponse $resp

# The result looks like this:

# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# <ManageInvoiceResponse xmlns="http://schemas.nav.gov.hu/OSA/2.0/api" xmlns:ns2="http://schemas.nav.gov.hu/OSA/2.0/data">
#     <header>
#         <requestId>RID871830318143</requestId>
#         <timestamp>2020-03-25T15:51:25Z</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>2WT9GFSKFUU1V4XP</transactionId>
# </ManageInvoiceResponse>

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

set ManageInvoiceResponse_xmlns [CkXml_getAttrValue $respXml "xmlns"]
set ManageInvoiceResponse_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_CkBinData $bdInvoiceData1
delete_CkBinData $bdInvoiceData2
delete_CkBinData $bdInvoiceData3
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_CkXml $respXml