(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loCrypt = createobject("CkCrypt2")

loDtNow = createobject("CkDateTime")
loDtNow.SetFromCurrentSystemTime()
? loDtNow.GetAsTimestamp(.F.)

// The hash algorithm for the password is SHA512 (not SHA3-512).
loCrypt.HashAlgorithm = "sha512"
loCrypt.EncodingMode = "hex"
lcMyPassword = "my-password"
lcPasswordHash = loCrypt.HashStringENC(lcMyPassword)

// Generate a random request ID like "RID215118906689"
loPrng = createobject("CkPrng")
loSbRequestId = createobject("CkStringBuilder")
loSbRequestId.Append("RID")
loSbRequestId.Append(loPrng.RandomString(12,.T.,.F.,.F.))
? "generated requestId = " + loSbRequestId.GetAsString()

// Calculate the requestSignature
loCrypt.HashAlgorithm = "sha3-512"
lcSignatureKey = "ce-8f5e-215119fa7dd621DLMRHRLH2S"

loSbFinalHashBase = createobject("CkStringBuilder")

// First append the timestamp because we are going to remove certain chars/parts.
loSbFinalHashBase.Append(loDtNow.GetAsTimestamp(.F.))
lnNumReplaced = loSbFinalHashBase.Replace("Z","")
lnNumReplaced = loSbFinalHashBase.Replace("-","")
lnNumReplaced = loSbFinalHashBase.Replace(":","")
lnNumReplaced = loSbFinalHashBase.Replace("T","")

// Prepend the requestId and append the signatureKey
loSbFinalHashBase.Prepend(loSbRequestId.GetAsString())
loSbFinalHashBase.Append(lcSignatureKey)

// Calculate first (and only) index hash.
lcInvoiceOperation = "ANNUL"
lcInvoiceData = "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4="

loSbHashBase = createobject("CkStringBuilder")
loSbHashBase.Append(lcInvoiceOperation)
loSbHashBase.Append(lcInvoiceData)
lcFirstHash = loCrypt.HashStringENC(loSbHashBase.GetAsString())

// Append the index hash to the final hash base.
loSbFinalHashBase.Append(lcFirstHash)

// Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
lcRequestSignature = loCrypt.HashStringENC(loSbFinalHashBase.GetAsString())

// Load our recently obtained exchange token.
// See Hungary NAV Invoicing Token Exchange Sample Code
loXmlExchangeToken = createobject("CkXml")
llSuccess = loXmlExchangeToken.LoadXmlFile("qa_data/tokens/nav_exchange_token.xml")
if (llSuccess = .F.) then
    ? loXmlExchangeToken.LastErrorText
    release loCrypt
    release loDtNow
    release loPrng
    release loSbRequestId
    release loSbFinalHashBase
    release loSbHashBase
    release loXmlExchangeToken
    return
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..
lcEncodedEncryptedExchangeToken = loXmlExchangeToken.GetChildContent("encodedExchangeToken")

// Decode to binary.
loBdExchangeToken = createobject("CkBinData")
loBdExchangeToken.AppendEncoded(lcEncodedEncryptedExchangeToken,"base64")

// Decrypt using your 16-digit replacement key:
loCrypt.CryptAlgorithm = "aes"
loCrypt.CipherMode = "ecb"
loCrypt.KeyLength = 128
loCrypt.EncodingMode = "base64"
// Pass your 16-digit replacement key here:
loCrypt.SetEncodedKey("99952BBAAAAA8XYZ","ascii")
loCrypt.DecryptBd(loBdExchangeToken)
lcExchangeToken = loBdExchangeToken.GetString("utf-8")
? "exchange token = " + lcExchangeToken

// Now build the XML..
loXml = createobject("CkXml")
loXml.Tag = "ManageAnnulmentRequest"
loXml.AddAttribute("xmlns","http://schemas.nav.gov.hu/OSA/2.0/api")
loXml.UpdateChildContent("header|requestId",loSbRequestId.GetAsString())
loXml.UpdateChildContent("header|timestamp",loDtNow.GetAsTimestamp(.F.))
loXml.UpdateChildContent("header|requestVersion","2.0")
loXml.UpdateChildContent("header|headerVersion","1.0")
loXml.UpdateChildContent("user|login","lwilsmn0uqdxe6u")
loXml.UpdateChildContent("user|passwordHash",lcPasswordHash)
loXml.UpdateChildContent("user|taxNumber","11111111")
loXml.UpdateChildContent("user|requestSignature",lcRequestSignature)
loXml.UpdateChildContent("software|softwareId","123456789123456789")
loXml.UpdateChildContent("software|softwareName","string")
loXml.UpdateChildContent("software|softwareOperation","LOCAL_SOFTWARE")
loXml.UpdateChildContent("software|softwareMainVersion","string")
loXml.UpdateChildContent("software|softwareDevName","string")
loXml.UpdateChildContent("software|softwareDevContact","string")
loXml.UpdateChildContent("software|softwareDevCountryCode","HU")
loXml.UpdateChildContent("software|softwareDevTaxNumber","string")
loXml.UpdateChildContent("exchangeToken",lcExchangeToken)
loXml.UpdateChildContent("annulmentOperations|annulmentOperation|index","1")
loXml.UpdateChildContent("annulmentOperations|annulmentOperation|annulmentOperation",lcInvoiceOperation)
loXml.UpdateChildContent("annulmentOperations|annulmentOperation|invoiceAnnulment",lcInvoiceData)

// POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
loHttp = createobject("CkHttp")
loHttp.Accept = "application/xml"
loHttp.SetRequestHeader("Content-Type","application/xml")
lcEndpoint = "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment"
loResp = loHttp.PostXml(lcEndpoint,loXml.GetXml(),"utf-8")
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loCrypt
    release loDtNow
    release loPrng
    release loSbRequestId
    release loSbFinalHashBase
    release loSbHashBase
    release loXmlExchangeToken
    release loBdExchangeToken
    release loXml
    release loHttp
    return
endif

? "Response status code = " + str(loResp.StatusCode)

loRespXml = createobject("CkXml")
loRespXml.LoadXml(loResp.BodyStr)
? "Response body:"
? loRespXml.GetXml()

release loResp

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

lcManageAnnulmentResponse_xmlns = loRespXml.GetAttrValue("xmlns")
lcManageAnnulmentResponse_xmlns_ns2 = loRespXml.GetAttrValue("xmlns:ns2")
lcRequestId = loRespXml.GetChildContent("header|requestId")
lcTimestamp = loRespXml.GetChildContent("header|timestamp")
lcRequestVersion = loRespXml.GetChildContent("header|requestVersion")
lcHeaderVersion = loRespXml.GetChildContent("header|headerVersion")
lcFuncCode = loRespXml.GetChildContent("result|funcCode")
lcSoftwareId = loRespXml.GetChildContent("software|softwareId")
lcSoftwareName = loRespXml.GetChildContent("software|softwareName")
lcSoftwareOperation = loRespXml.GetChildContent("software|softwareOperation")
lcSoftwareMainVersion = loRespXml.GetChildContent("software|softwareMainVersion")
lcSoftwareDevName = loRespXml.GetChildContent("software|softwareDevName")
lcSoftwareDevContact = loRespXml.GetChildContent("software|softwareDevContact")
lcSoftwareDevCountryCode = loRespXml.GetChildContent("software|softwareDevCountryCode")
lcSoftwareDevTaxNumber = loRespXml.GetChildContent("software|softwareDevTaxNumber")
lcTransactionId = loRespXml.GetChildContent("transactionId")


release loCrypt
release loDtNow
release loPrng
release loSbRequestId
release loSbFinalHashBase
release loSbHashBase
release loXmlExchangeToken
release loBdExchangeToken
release loXml
release loHttp
release loRespXml