Lua
Lua
Create ITIDA Signed JSON and Send to ETA (Egypt Tax Authority) Portal
See more Egypt ITIDA Examples
Demonstrates how to create a .p7s signature that fits Egypt's ITIDA requirements where Chilkat automatically does the ITIDA JSON canonicalization. Also shows the code to send to the ETA Portal.Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local crypt = chilkat.Crypt2.new()
crypt.verbose_logging = true
local cert = chilkat.Cert.new()
cert.verbose_logging = true
-- Set the smart card PIN, which will be needed for signing.
cert.smart_card_pin = "12345678"
-- There are many ways to load the certificate.
-- This example was created for a customer using an ePass2003 USB token.
-- Assuming the USB token is the only source of a hardware-based private key..
local success = cert:load_from_smartcard("")
if not success then
print(cert.last_error_text)
return
end
-- Tell the crypt class to use this cert.
success = crypt:set_signing_cert(cert)
if not success then
print(crypt.last_error_text)
return
end
local cmsOptions = chilkat.JsonObject.new()
-- Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
cmsOptions:update_bool("DigestData", true)
cmsOptions:update_bool("OmitAlgorithmIdNull", true)
-- Indicate that we are passing normal JSON and we want Chilkat do automatically
-- do the ITIDA JSON canonicalization:
cmsOptions:update_bool("CanonicalizeITIDA", true)
crypt.cms_options = cmsOptions:emit()
-- The CadesEnabled property applies to all methods that create CMS/PKCS7 signatures.
-- To create a CAdES-BES signature, set this property equal to true.
crypt.cades_enabled = true
crypt.hash_algorithm = "sha256"
local jsonSigningAttrs = chilkat.JsonObject.new()
jsonSigningAttrs:update_int("contentType", 1)
jsonSigningAttrs:update_int("signingTime", 1)
jsonSigningAttrs:update_int("messageDigest", 1)
jsonSigningAttrs:update_int("signingCertificateV2", 1)
crypt.signing_attributes = jsonSigningAttrs:emit()
-- By default, all the certs in the chain of authentication are included in the signature.
-- If desired, we can choose to only include the signing certificate:
crypt.include_cert_chain = false
-- Pass a JSON document such as the following. Chilkat will do the ITIDA canonicalization.
-- (It is the canonicalized JSON that gets signed.)
-- {
-- "issuer":{
-- "address":{
-- "branchID":"0",
-- "country":"EG",
-- "regionCity":"Cairo",
-- "postalCode":"",
-- "buildingNumber":"0",
-- "street":"123rd Street",
-- "governate":"GOVERNATE"
-- },
-- "type":"B",
-- "id":"209999899",
-- "name":"Xyz SAE"
-- },
-- "receiver":{
-- "address":{
-- "country":"EG",
-- "regionCity":"CAIRO",
-- "postalCode":"11435",
-- "buildingNumber":"0",
-- "street":"Autostrad Road Abc",
-- "governate":"GOVERNATE"
-- },
-- "type":"B",
-- "id":"999999999",
-- "name":"XYZ EGYPT FOR TRADE"
-- },
-- "documentType":"I",
-- "documentTypeVersion":"1.0",
-- "dateTimeIssued":"2020-11-15T11:04:53Z",
-- "taxpayerActivityCode":"1073",
-- "internalID":"ZZZZ999",
-- "purchaseOrderReference":"2009199918",
-- "salesOrderReference":"",
-- "payment":{
-- "bankName":"",
-- "bankAddress":"",
-- "bankAccountNo":"",
-- "bankAccountIBAN":"",
-- "swiftCode":"",
-- "terms":""
-- },
-- "delivery":{
-- "approach":"",
-- "packaging":"",
-- "dateValidity":"",
-- "exportPort":"",
-- "countryOfOrigin":"EG",
-- "grossWeight":0,
-- "netWeight":0,
-- "terms":""
-- },
-- "invoiceLines":[
-- {
-- "description":"CDM Widget 48GX99X12BA",
-- "itemType":"GS1",
-- "itemCode":"7622213335056",
-- "unitType":"CS",
-- "quantity":1.00,
-- "unitValue":{
-- "currencySold":"EGP",
-- "amountEGP":588.67,
-- "amountSold":0,
-- "currencyExchangeRate":0
-- },
-- "salesTotal":588.67,
-- "total":603.97,
-- "valueDifference":0,
-- "totalTaxableFees":0,
-- "netTotal":529.8,
-- "itemsDiscount":0,
-- "discount":{
-- "rate":10.00,
-- "amount":58.87
-- },
-- "taxableItems":[
-- {
-- "taxType":"T1",
-- "amount":74.17,
-- "subType":"No sub",
-- "rate":14.00
-- }
-- ],
-- "internalCode":"9099994"
-- }
-- ],
-- "totalSales":588.67,
-- "totalSalesAmount":588.67,
-- "totalDiscountAmount":58.87,
-- "netAmount":529.80,
-- "taxTotals":[
-- {
-- "taxType":"T1",
-- "amount":74.17
-- }
-- ],
-- "extraDiscountAmount":0,
-- "totalItemsDiscountAmount":0,
-- "totalAmount":603.97,
-- }
-- Build the above JSON..
-- Use this online tool to generate code from sample JSON:
-- Generate Code to Create JSON
local json = chilkat.JsonObject.new()
json:update_string("issuer.address.branchID", "0")
json:update_string("issuer.address.country", "EG")
json:update_string("issuer.address.regionCity", "Cairo")
json:update_string("issuer.address.postalCode", "")
json:update_string("issuer.address.buildingNumber", "0")
json:update_string("issuer.address.street", "123rd Street")
json:update_string("issuer.address.governate", "GOVERNATE")
json:update_string("issuer.type", "B")
json:update_string("issuer.id", "209999899")
json:update_string("issuer.name", "Xyz SAE")
json:update_string("receiver.address.country", "EG")
json:update_string("receiver.address.regionCity", "CAIRO")
json:update_string("receiver.address.postalCode", "11435")
json:update_string("receiver.address.buildingNumber", "0")
json:update_string("receiver.address.street", "Autostrad Road Abc")
json:update_string("receiver.address.governate", "GOVERNATE")
json:update_string("receiver.type", "B")
json:update_string("receiver.id", "999999999")
json:update_string("receiver.name", "XYZ EGYPT FOR TRADE")
json:update_string("documentType", "I")
json:update_string("documentTypeVersion", "1.0")
json:update_string("dateTimeIssued", "2020-11-15T11:04:53Z")
json:update_string("taxpayerActivityCode", "1073")
json:update_string("internalID", "ZZZZ999")
json:update_string("purchaseOrderReference", "2009199918")
json:update_string("salesOrderReference", "")
json:update_string("payment.bankName", "")
json:update_string("payment.bankAddress", "")
json:update_string("payment.bankAccountNo", "")
json:update_string("payment.bankAccountIBAN", "")
json:update_string("payment.swiftCode", "")
json:update_string("payment.terms", "")
json:update_string("delivery.approach", "")
json:update_string("delivery.packaging", "")
json:update_string("delivery.dateValidity", "")
json:update_string("delivery.exportPort", "")
json:update_string("delivery.countryOfOrigin", "EG")
json:update_int("delivery.grossWeight", 0)
json:update_int("delivery.netWeight", 0)
json:update_string("delivery.terms", "")
json:update_string("invoiceLines[0].description", "CDM Widget 48GX99X12BA")
json:update_string("invoiceLines[0].itemType", "GS1")
json:update_string("invoiceLines[0].itemCode", "7622213335056")
json:update_string("invoiceLines[0].unitType", "CS")
json:update_number("invoiceLines[0].quantity", "1.00")
json:update_string("invoiceLines[0].unitValue.currencySold", "EGP")
json:update_number("invoiceLines[0].unitValue.amountEGP", "588.67")
json:update_int("invoiceLines[0].unitValue.amountSold", 0)
json:update_int("invoiceLines[0].unitValue.currencyExchangeRate", 0)
json:update_number("invoiceLines[0].salesTotal", "588.67")
json:update_number("invoiceLines[0].total", "603.97")
json:update_int("invoiceLines[0].valueDifference", 0)
json:update_int("invoiceLines[0].totalTaxableFees", 0)
json:update_number("invoiceLines[0].netTotal", "529.8")
json:update_int("invoiceLines[0].itemsDiscount", 0)
json:update_number("invoiceLines[0].discount.rate", "10.00")
json:update_number("invoiceLines[0].discount.amount", "58.87")
json:update_string("invoiceLines[0].taxableItems[0].taxType", "T1")
json:update_number("invoiceLines[0].taxableItems[0].amount", "74.17")
json:update_string("invoiceLines[0].taxableItems[0].subType", "No sub")
json:update_number("invoiceLines[0].taxableItems[0].rate", "14.00")
json:update_string("invoiceLines[0].internalCode", "9099994")
json:update_number("totalSales", "588.67")
json:update_number("totalSalesAmount", "588.67")
json:update_number("totalDiscountAmount", "58.87")
json:update_number("netAmount", "529.80")
json:update_string("taxTotals[0].taxType", "T1")
json:update_number("taxTotals[0].amount", "74.17")
json:update_int("extraDiscountAmount", 0)
json:update_int("totalItemsDiscountAmount", 0)
json:update_number("totalAmount", "603.97")
json.emit_compact = true
local jsonToSign = json:emit()
-- Create the CAdES-BES signature.
crypt.encoding_mode = "base64"
-- Make sure we sign the utf-8 byte representation of the JSON string
crypt.charset = "utf-8"
local sigBase64 = crypt:sign_string_enc(jsonToSign)
if not crypt.last_method_success then
print(crypt.last_error_text)
return
end
print("Base64 signature:")
print(sigBase64)
-- Insert the base64 signature into the JSON to be sent
json:update_string("signatures[0].signatureType", "I")
json:update_string("signatures[0].value", sigBase64)
-- Wrap the JSON in {"documents":[ ... ]}
local sbToSend = chilkat.StringBuilder.new()
sbToSend:append("{\"documents\":[")
sbToSend:append(json:emit())
sbToSend:append("]}")
-- ------------------------------------------------------------------------
-- Get an access token using our client ID and client secret key
local clientId = "abc999ff-1234"
local clientSecretKey = "123fff22-1234-abcd"
local http = chilkat.Http.new()
-- Causes the Authorization: Basic header to be added..
http.login = clientId
http.password = clientSecretKey
http.basic_auth = true
local req = chilkat.HttpRequest.new()
req.http_verb = "POST"
req.path = "/connect/token"
req.content_type = "application/x-www-form-urlencoded"
req:add_param("grant_type", "client_credentials")
req:add_header("Connection", "close")
http.accept = "application/json"
local resp = chilkat.HttpResponse.new()
success = http:http_req("https://id.preprod.eta.gov.eg/connect/token", req, resp)
if not success then
print(http.last_error_text)
return
end
http:close_all_connections()
print("Response status code: " .. resp.status_code)
print("Response body:")
print(resp.body_str)
if resp.status_code ~= 200 then
print("Failed.")
return
end
local jsonToken = chilkat.JsonObject.new()
success = jsonToken:load(resp.body_str)
local accessToken = jsonToken:string_of("access_token")
print("access_token = " .. accessToken)
-- ------------------------------------------------------------------------
-- Submit the signed JSON to the ETA (Egypt Tax Authority) Portal
-- No longer sending basic authentication...
http.login = ""
http.password = ""
http.basic_auth = false
-- Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
http.auth_token = accessToken
local jsonStr = sbToSend:get_as_string()
local url = "https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions"
success = http:http_str("POST", url, jsonStr, "utf-8", "application/json; charset=utf-8", resp)
if not success then
print(http.last_error_text)
return
end
print("Response status code: " .. resp.status_code)
print("Response body:")
print(resp.body_str)