(Tcl) Hungary NAV Query Taxpayer

Demonstrates the queryTaxpayer 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:

# <?xml version="1.0" encoding="UTF-8"?>
# <QueryTaxpayerRequest xmlns="http://schemas.nav.gov.hu/OSA/2.0/api">
# 	<header>
# 		<requestId>RID215118906689</requestId>
# 		<timestamp>2019-09-11T11:11:08.579Z</timestamp>
# 		<requestVersion>2.0</requestVersion>
# 		<headerVersion>1.0</headerVersion>
# 	</header>
# 	<user>
# 		<login>lwilsmn0uqdxe6u</login>
# 		<passwordHash>2F43840A882CFDB7DB0FEC07D419D030D864B47B6B541DC280EF81B937B7A176E33C052B0D26638CC18A7A2C08D8D311733078A774BF43F6CA57FE8CD74DC28E</passwordHash>
# 		<taxNumber>11111111</taxNumber>
# 		<requestSignature>C5ADE8A2231C509D2887E6C2C4406CC5F72CA25B070AD3E94FADFA3F91A8A3667AF882DEDC7D67E9086E3D34A95886E929ACD8C924CD1E8357C89BEF43BA9126</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>
# 	<taxNumber>22222222</taxNumber>
# </QueryTaxpayerRequest>

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
# IMPORTANT: This example requires Chilkat v9.5.0.83 or greater.  The SHA3 hash algorithm is implemented in Chilkat v9.5.0.83, but not in earlier versions.
# IMPORTANT: This example requires Chilkat v9.5.0.83 or greater.  The SHA3 hash algorithm is implemented in Chilkat v9.5.0.83, but not in earlier versions.
# IMPORTANT: This example requires Chilkat v9.5.0.83 or greater.  The SHA3 hash algorithm is implemented in Chilkat v9.5.0.83, but not in earlier versions.
# IMPORTANT: This example requires Chilkat v9.5.0.83 or greater.  The SHA3 hash algorithm is implemented in Chilkat v9.5.0.83, but not in earlier versions.
# IMPORTANT: This example requires Chilkat v9.5.0.83 or greater.  The SHA3 hash algorithm is implemented in Chilkat v9.5.0.83, but not in earlier versions.
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

set requestSignature [CkCrypt2_hashStringENC $crypt [CkStringBuilder_getAsString $sbFinalHashBase]]

set xml [new_CkXml]

CkXml_put_Tag $xml "QueryTaxpayerRequest"
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 "taxNumber" "22222222"

# POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/queryTaxpayer
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/queryTaxpayer"
# 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_CkCrypt2 $crypt
    delete_CkDateTime $dtNow
    delete_CkPrng $prng
    delete_CkStringBuilder $sbRequestId
    delete_CkStringBuilder $sbFinalHashBase
    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"?>
# <QueryTaxpayerResponse xmlns="http://schemas.nav.gov.hu/OSA/2.0/api" xmlns:ns2="http://schemas.nav.gov.hu/OSA/2.0/data">
#     <header>
#         <requestId>RID847153193061</requestId>
#         <timestamp>2020-03-24T16:00:34Z</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>
#     <infoDate>1993-01-01T00:00:00.000+01:00</infoDate>
#     <taxpayerValidity>true</taxpayerValidity>
#     <taxpayerData>
#         <taxpayerName>some taxpayer name</taxpayerName>
#         <taxNumberDetail>
#             <ns2:taxpayerId>22222222</ns2:taxpayerId>
#             <ns2:vatCode>2</ns2:vatCode>
#         </taxNumberDetail>
#         <taxpayerAddressList>
#             <taxpayerAddressItem>
#                 <taxpayerAddressType>HQ</taxpayerAddressType>
#                 <taxpayerAddress>
#                     <ns2:countryCode>HU</ns2:countryCode>
#                     <ns2:postalCode>1121</ns2:postalCode>
#                     <ns2:city>BUDAPEST 12</ns2:city>
#                     <ns2:streetName>ABCD</ns2:streetName>
#                     <ns2:publicPlaceCategory>UTCA</ns2:publicPlaceCategory>
#                     <ns2:number>20</ns2:number>
#                 </taxpayerAddress>
#             </taxpayerAddressItem>
#         </taxpayerAddressList>
#     </taxpayerData>
# </QueryTaxpayerResponse>

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

set QueryTaxpayerResponse_xmlns [CkXml_getAttrValue $respXml "xmlns"]
set QueryTaxpayerResponse_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 infoDate [CkXml_getChildContent $respXml "infoDate"]
set taxpayerValidity [CkXml_getChildContent $respXml "taxpayerValidity"]
set taxpayerName [CkXml_getChildContent $respXml "taxpayerData|taxpayerName"]
set ns2_taxpayerId [CkXml_GetChildIntValue $respXml "taxpayerData|taxNumberDetail|ns2:taxpayerId"]
set ns2_vatCode [CkXml_GetChildIntValue $respXml "taxpayerData|taxNumberDetail|ns2:vatCode"]
set taxpayerAddressType [CkXml_getChildContent $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddressType"]
set ns2_countryCode [CkXml_getChildContent $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddress|ns2:countryCode"]
set ns2_postalCode [CkXml_GetChildIntValue $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddress|ns2:postalCode"]
set ns2_city [CkXml_getChildContent $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddress|ns2:city"]
set ns2_streetName [CkXml_getChildContent $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddress|ns2:streetName"]
set ns2_publicPlaceCategory [CkXml_getChildContent $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddress|ns2:publicPlaceCategory"]
set ns2_number [CkXml_GetChildIntValue $respXml "taxpayerData|taxpayerAddressList|taxpayerAddressItem|taxpayerAddress|ns2:number"]

delete_CkCrypt2 $crypt
delete_CkDateTime $dtNow
delete_CkPrng $prng
delete_CkStringBuilder $sbRequestId
delete_CkStringBuilder $sbFinalHashBase
delete_CkXml $xml
delete_CkHttp $http
delete_CkXml $respXml