PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkBinData.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkPrng.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkCrypt2.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
success.i = 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>
crypt.i = CkCrypt2::ckCreate()
If crypt.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
dtNow.i = CkDateTime::ckCreate()
If dtNow.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkDateTime::ckSetFromCurrentSystemTime(dtNow)
Debug CkDateTime::ckGetAsTimestamp(dtNow,0)
; The hash algorithm for the password is SHA512 (not SHA3-512).
CkCrypt2::setCkHashAlgorithm(crypt, "sha512")
CkCrypt2::setCkEncodingMode(crypt, "hex")
myPassword.s = "my-password"
passwordHash.s = CkCrypt2::ckHashStringENC(crypt,myPassword)
; Generate a random request ID like "RID215118906689"
prng.i = CkPrng::ckCreate()
If prng.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
sbRequestId.i = CkStringBuilder::ckCreate()
If sbRequestId.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbRequestId,"RID")
CkStringBuilder::ckAppend(sbRequestId,CkPrng::ckRandomString(prng,12,1,0,0))
Debug "generated requestId = " + CkStringBuilder::ckGetAsString(sbRequestId)
; Calculate the requestSignature
CkCrypt2::setCkHashAlgorithm(crypt, "sha3-512")
signatureKey.s = "ce-8f5e-215119fa7dd621DLMRHRLH2S"
sbFinalHashBase.i = CkStringBuilder::ckCreate()
If sbFinalHashBase.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; First append the timestamp because we are going to remove certain chars/parts.
CkStringBuilder::ckAppend(sbFinalHashBase,CkDateTime::ckGetAsTimestamp(dtNow,0))
numReplaced.i = CkStringBuilder::ckReplace(sbFinalHashBase,"Z","")
numReplaced = CkStringBuilder::ckReplace(sbFinalHashBase,"-","")
numReplaced = CkStringBuilder::ckReplace(sbFinalHashBase,":","")
numReplaced = CkStringBuilder::ckReplace(sbFinalHashBase,"T","")
; Prepend the requestId and append the signatureKey
CkStringBuilder::ckPrepend(sbFinalHashBase,CkStringBuilder::ckGetAsString(sbRequestId))
CkStringBuilder::ckAppend(sbFinalHashBase,signatureKey)
; Calculate first (and only) index hash.
invoiceOperation.s = "ANNUL"
invoiceData.s = "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4="
sbHashBase.i = CkStringBuilder::ckCreate()
If sbHashBase.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbHashBase,invoiceOperation)
CkStringBuilder::ckAppend(sbHashBase,invoiceData)
firstHash.s = CkCrypt2::ckHashStringENC(crypt,CkStringBuilder::ckGetAsString(sbHashBase))
; Append the index hash to the final hash base.
CkStringBuilder::ckAppend(sbFinalHashBase,firstHash)
; Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
requestSignature.s = CkCrypt2::ckHashStringENC(crypt,CkStringBuilder::ckGetAsString(sbFinalHashBase))
; Load our recently obtained exchange token.
; See Hungary NAV Invoicing Token Exchange Sample Code
xmlExchangeToken.i = CkXml::ckCreate()
If xmlExchangeToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkXml::ckLoadXmlFile(xmlExchangeToken,"qa_data/tokens/nav_exchange_token.xml")
If success = 0
Debug CkXml::ckLastErrorText(xmlExchangeToken)
CkCrypt2::ckDispose(crypt)
CkDateTime::ckDispose(dtNow)
CkPrng::ckDispose(prng)
CkStringBuilder::ckDispose(sbRequestId)
CkStringBuilder::ckDispose(sbFinalHashBase)
CkStringBuilder::ckDispose(sbHashBase)
CkXml::ckDispose(xmlExchangeToken)
ProcedureReturn
EndIf
; 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.s = CkXml::ckGetChildContent(xmlExchangeToken,"encodedExchangeToken")
; Decode to binary.
bdExchangeToken.i = CkBinData::ckCreate()
If bdExchangeToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkBinData::ckAppendEncoded(bdExchangeToken,encodedEncryptedExchangeToken,"base64")
; Decrypt using your 16-digit replacement key:
CkCrypt2::setCkCryptAlgorithm(crypt, "aes")
CkCrypt2::setCkCipherMode(crypt, "ecb")
CkCrypt2::setCkKeyLength(crypt, 128)
CkCrypt2::setCkEncodingMode(crypt, "base64")
; Pass your 16-digit replacement key here:
CkCrypt2::ckSetEncodedKey(crypt,"99952BBAAAAA8XYZ","ascii")
CkCrypt2::ckDecryptBd(crypt,bdExchangeToken)
exchangeToken.s = CkBinData::ckGetString(bdExchangeToken,"utf-8")
Debug "exchange token = " + exchangeToken
; Now build the XML..
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "ManageAnnulmentRequest")
CkXml::ckAddAttribute(xml,"xmlns","http://schemas.nav.gov.hu/OSA/2.0/api")
CkXml::ckUpdateChildContent(xml,"header|requestId",CkStringBuilder::ckGetAsString(sbRequestId))
CkXml::ckUpdateChildContent(xml,"header|timestamp",CkDateTime::ckGetAsTimestamp(dtNow,0))
CkXml::ckUpdateChildContent(xml,"header|requestVersion","2.0")
CkXml::ckUpdateChildContent(xml,"header|headerVersion","1.0")
CkXml::ckUpdateChildContent(xml,"user|login","lwilsmn0uqdxe6u")
CkXml::ckUpdateChildContent(xml,"user|passwordHash",passwordHash)
CkXml::ckUpdateChildContent(xml,"user|taxNumber","11111111")
CkXml::ckUpdateChildContent(xml,"user|requestSignature",requestSignature)
CkXml::ckUpdateChildContent(xml,"software|softwareId","123456789123456789")
CkXml::ckUpdateChildContent(xml,"software|softwareName","string")
CkXml::ckUpdateChildContent(xml,"software|softwareOperation","LOCAL_SOFTWARE")
CkXml::ckUpdateChildContent(xml,"software|softwareMainVersion","string")
CkXml::ckUpdateChildContent(xml,"software|softwareDevName","string")
CkXml::ckUpdateChildContent(xml,"software|softwareDevContact","string")
CkXml::ckUpdateChildContent(xml,"software|softwareDevCountryCode","HU")
CkXml::ckUpdateChildContent(xml,"software|softwareDevTaxNumber","string")
CkXml::ckUpdateChildContent(xml,"exchangeToken",exchangeToken)
CkXml::ckUpdateChildContent(xml,"annulmentOperations|annulmentOperation|index","1")
CkXml::ckUpdateChildContent(xml,"annulmentOperations|annulmentOperation|annulmentOperation",invoiceOperation)
CkXml::ckUpdateChildContent(xml,"annulmentOperations|annulmentOperation|invoiceAnnulment",invoiceData)
; POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttp::setCkAccept(http, "application/xml")
endpoint.s = "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment"
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpStr(http,"POST",endpoint,CkXml::ckGetXml(xml),"utf-8","application/xml",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkCrypt2::ckDispose(crypt)
CkDateTime::ckDispose(dtNow)
CkPrng::ckDispose(prng)
CkStringBuilder::ckDispose(sbRequestId)
CkStringBuilder::ckDispose(sbFinalHashBase)
CkStringBuilder::ckDispose(sbHashBase)
CkXml::ckDispose(xmlExchangeToken)
CkBinData::ckDispose(bdExchangeToken)
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
respXml.i = CkXml::ckCreate()
If respXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckLoadXml(respXml,CkHttpResponse::ckBodyStr(resp))
Debug "Response body:"
Debug CkXml::ckGetXml(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
ManageAnnulmentResponse_xmlns.s = CkXml::ckGetAttrValue(respXml,"xmlns")
ManageAnnulmentResponse_xmlns_ns2.s = CkXml::ckGetAttrValue(respXml,"xmlns:ns2")
requestId.s = CkXml::ckGetChildContent(respXml,"header|requestId")
timestamp.s = CkXml::ckGetChildContent(respXml,"header|timestamp")
requestVersion.s = CkXml::ckGetChildContent(respXml,"header|requestVersion")
headerVersion.s = CkXml::ckGetChildContent(respXml,"header|headerVersion")
funcCode.s = CkXml::ckGetChildContent(respXml,"result|funcCode")
softwareId.s = CkXml::ckGetChildContent(respXml,"software|softwareId")
softwareName.s = CkXml::ckGetChildContent(respXml,"software|softwareName")
softwareOperation.s = CkXml::ckGetChildContent(respXml,"software|softwareOperation")
softwareMainVersion.s = CkXml::ckGetChildContent(respXml,"software|softwareMainVersion")
softwareDevName.s = CkXml::ckGetChildContent(respXml,"software|softwareDevName")
softwareDevContact.s = CkXml::ckGetChildContent(respXml,"software|softwareDevContact")
softwareDevCountryCode.s = CkXml::ckGetChildContent(respXml,"software|softwareDevCountryCode")
softwareDevTaxNumber.s = CkXml::ckGetChildContent(respXml,"software|softwareDevTaxNumber")
transactionId.s = CkXml::ckGetChildContent(respXml,"transactionId")
CkCrypt2::ckDispose(crypt)
CkDateTime::ckDispose(dtNow)
CkPrng::ckDispose(prng)
CkStringBuilder::ckDispose(sbRequestId)
CkStringBuilder::ckDispose(sbFinalHashBase)
CkStringBuilder::ckDispose(sbHashBase)
CkXml::ckDispose(xmlExchangeToken)
CkBinData::ckDispose(bdExchangeToken)
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
CkHttpResponse::ckDispose(resp)
CkXml::ckDispose(respXml)
ProcedureReturn
EndProcedure