(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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>

    var success: Bool
    let crypt = CkoCrypt2()!

    let dtNow = CkoDateTime()!
    dtNow.setFromCurrentSystemTime()
    print("\(dtNow.getAsTimestamp(false)!)")

    // The hash algorithm for the password is SHA512 (not SHA3-512).
    crypt.hashAlgorithm = "sha512"
    crypt.encodingMode = "hex"
    var myPassword: String? = "my-password"
    var passwordHash: String? = crypt.hashStringENC(myPassword)

    // Generate a random request ID like "RID215118906689"
    let prng = CkoPrng()!
    let sbRequestId = CkoStringBuilder()!
    sbRequestId.append("RID")
    sbRequestId.append(prng.randomString(12, bDigits: true, bLower: false, bUpper: false))
    print("generated requestId = \(sbRequestId.getAsString()!)")

    // Calculate the requestSignature
    crypt.hashAlgorithm = "sha3-512"
    var signatureKey: String? = "ce-8f5e-215119fa7dd621DLMRHRLH2S"

    let sbFinalHashBase = CkoStringBuilder()!

    // First append the timestamp because we are going to remove certain chars/parts.
    sbFinalHashBase.append(dtNow.getAsTimestamp(false))
    var numReplaced: Int = sbFinalHashBase.replace("Z", replacement: "").intValue
    numReplaced = sbFinalHashBase.replace("-", replacement: "").intValue
    numReplaced = sbFinalHashBase.replace(":", replacement: "").intValue
    numReplaced = sbFinalHashBase.replace("T", replacement: "").intValue

    // Prepend the requestId and append the signatureKey
    sbFinalHashBase.prepend(sbRequestId.getAsString())
    sbFinalHashBase.append(signatureKey)

    // Calculate first (and only) index hash.
    var invoiceOperation: String? = "ANNUL"
    var invoiceData: String? = "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pg0KPEludm9pY2VBbm51bG1lbnQgeG1sbnM9Imh0dHA6Ly9zY2hlbWFzLm5hdi5nb3YuaHUvT1NBLzIuMC9hbm51bCI+DQoJCTxhbm51bG1lbnRSZWZlcmVuY2U+MjIyMjIyMjI8L2FubnVsbWVudFJlZmVyZW5jZT4NCgkJPGFubnVsbWVudFRpbWVzdGFtcD4yMDE4LTA2LTE4VDA5OjEwOjQ1LjMwOVo8L2FubnVsbWVudFRpbWVzdGFtcD4NCgkJPGFubnVsbWVudENvZGU+RVJSQVRJQ19EQVRBPC9hbm51bG1lbnRDb2RlPg0KCQk8YW5udWxtZW50UmVhc29uPmNyZWF0ZSBzemFtbGEgYW5udWw8L2FubnVsbWVudFJlYXNvbj4NCjwvSW52b2ljZUFubnVsbWVudD4="

    let sbHashBase = CkoStringBuilder()!
    sbHashBase.append(invoiceOperation)
    sbHashBase.append(invoiceData)
    var firstHash: String? = crypt.hashStringENC(sbHashBase.getAsString())

    // Append the index hash to the final hash base.
    sbFinalHashBase.append(firstHash)

    // Get our request signature (using sha3-512 because our HashAlgorithm was set to "sha3-512" up above...)
    var requestSignature: String? = crypt.hashStringENC(sbFinalHashBase.getAsString())

    // Load our recently obtained exchange token.
    // See Hungary NAV Invoicing Token Exchange Sample Code
    let xmlExchangeToken = CkoXml()!
    success = xmlExchangeToken.loadFile("qa_data/tokens/nav_exchange_token.xml")
    if success == false {
        print("\(xmlExchangeToken.lastErrorText!)")
        return
    }

    // 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..
    var encodedEncryptedExchangeToken: String? = xmlExchangeToken.getChildContent("encodedExchangeToken")

    // Decode to binary.
    let bdExchangeToken = CkoBinData()!
    bdExchangeToken.appendEncoded(encodedEncryptedExchangeToken, encoding: "base64")

    // Decrypt using your 16-digit replacement key:
    crypt.cryptAlgorithm = "aes"
    crypt.cipherMode = "ecb"
    crypt.keyLength = 128
    crypt.encodingMode = "base64"
    // Pass your 16-digit replacement key here:
    crypt.setEncodedKey("99952BBAAAAA8XYZ", encoding: "ascii")
    crypt.decryptBd(bdExchangeToken)
    var exchangeToken: String? = bdExchangeToken.getString("utf-8")
    print("exchange token = \(exchangeToken!)")

    // Now build the XML..
    let xml = CkoXml()!
    xml.tag = "ManageAnnulmentRequest"
    xml.addAttribute("xmlns", value: "http://schemas.nav.gov.hu/OSA/2.0/api")
    xml.updateChildContent("header|requestId", value: sbRequestId.getAsString())
    xml.updateChildContent("header|timestamp", value: dtNow.getAsTimestamp(false))
    xml.updateChildContent("header|requestVersion", value: "2.0")
    xml.updateChildContent("header|headerVersion", value: "1.0")
    xml.updateChildContent("user|login", value: "lwilsmn0uqdxe6u")
    xml.updateChildContent("user|passwordHash", value: passwordHash)
    xml.updateChildContent("user|taxNumber", value: "11111111")
    xml.updateChildContent("user|requestSignature", value: requestSignature)
    xml.updateChildContent("software|softwareId", value: "123456789123456789")
    xml.updateChildContent("software|softwareName", value: "string")
    xml.updateChildContent("software|softwareOperation", value: "LOCAL_SOFTWARE")
    xml.updateChildContent("software|softwareMainVersion", value: "string")
    xml.updateChildContent("software|softwareDevName", value: "string")
    xml.updateChildContent("software|softwareDevContact", value: "string")
    xml.updateChildContent("software|softwareDevCountryCode", value: "HU")
    xml.updateChildContent("software|softwareDevTaxNumber", value: "string")
    xml.updateChildContent("exchangeToken", value: exchangeToken)
    xml.updateChildContent("annulmentOperations|annulmentOperation|index", value: "1")
    xml.updateChildContent("annulmentOperations|annulmentOperation|annulmentOperation", value: invoiceOperation)
    xml.updateChildContent("annulmentOperations|annulmentOperation|invoiceAnnulment", value: invoiceData)

    // POST the XML to https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment
    let http = CkoHttp()!
    http.accept = "application/xml"
    http.setRequestHeader("Content-Type", value: "application/xml")
    var endpoint: String? = "https://api-test.onlineszamla.nav.gov.hu/invoiceService/v2/manageAnnulment"
    var resp: CkoHttpResponse? = http.postXml(endpoint, xmlDoc: xml.getXml(), charset: "utf-8")
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Response status code = \(resp!.statusCode.intValue)")

    let respXml = CkoXml()!
    respXml.load(resp!.bodyStr)
    print("Response body:")
    print("\(respXml.getXml()!)")

    resp = nil

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

    var ManageAnnulmentResponse_xmlns: String? = respXml.getAttrValue("xmlns")
    var ManageAnnulmentResponse_xmlns_ns2: String? = respXml.getAttrValue("xmlns:ns2")
    var requestId: String? = respXml.getChildContent("header|requestId")
    var timestamp: String? = respXml.getChildContent("header|timestamp")
    var requestVersion: String? = respXml.getChildContent("header|requestVersion")
    var headerVersion: String? = respXml.getChildContent("header|headerVersion")
    var funcCode: String? = respXml.getChildContent("result|funcCode")
    var softwareId: String? = respXml.getChildContent("software|softwareId")
    var softwareName: String? = respXml.getChildContent("software|softwareName")
    var softwareOperation: String? = respXml.getChildContent("software|softwareOperation")
    var softwareMainVersion: String? = respXml.getChildContent("software|softwareMainVersion")
    var softwareDevName: String? = respXml.getChildContent("software|softwareDevName")
    var softwareDevContact: String? = respXml.getChildContent("software|softwareDevContact")
    var softwareDevCountryCode: String? = respXml.getChildContent("software|softwareDevCountryCode")
    var softwareDevTaxNumber: String? = respXml.getChildContent("software|softwareDevTaxNumber")
    var transactionId: String? = respXml.getChildContent("transactionId")

}