(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# Indicate that utf-8 is desired for strings passed in and out of Chilkat.
glob = Chilkat::CkGlobal.new()
glob.put_DefaultUtf8(true)

crypt = Chilkat::CkCrypt2.new()
crypt.put_VerboseLogging(true)

cert = Chilkat::CkCert.new()
cert.put_VerboseLogging(true)

# Set the smart card PIN, which will be needed for signing.
cert.put_SmartCardPin("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..
success = cert.LoadFromSmartcard("")
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

# Tell the crypt class to use this cert.
success = crypt.SetSigningCert(cert)
if (success != true)
    print crypt.lastErrorText() + "\n";
    exit
end

cmsOptions = Chilkat::CkJsonObject.new()
# Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
cmsOptions.UpdateBool("DigestData",true)
cmsOptions.UpdateBool("OmitAlgorithmIdNull",true)

# Indicate that we are passing normal JSON and we want Chilkat do automatically
# do the ITIDA JSON canonicalization:
cmsOptions.UpdateBool("CanonicalizeITIDA",true)

crypt.put_CmsOptions(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.put_CadesEnabled(true)

crypt.put_HashAlgorithm("sha256")

jsonSigningAttrs = Chilkat::CkJsonObject.new()
jsonSigningAttrs.UpdateInt("contentType",1)
jsonSigningAttrs.UpdateInt("signingTime",1)
jsonSigningAttrs.UpdateInt("messageDigest",1)
jsonSigningAttrs.UpdateInt("signingCertificateV2",1)
crypt.put_SigningAttributes(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.put_IncludeCertChain(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

json = Chilkat::CkJsonObject.new()
json.UpdateString("issuer.address.branchID","0")
json.UpdateString("issuer.address.country","EG")
json.UpdateString("issuer.address.regionCity","Cairo")
json.UpdateString("issuer.address.postalCode","")
json.UpdateString("issuer.address.buildingNumber","0")
json.UpdateString("issuer.address.street","123rd Street")
json.UpdateString("issuer.address.governate","GOVERNATE")
json.UpdateString("issuer.type","B")
json.UpdateString("issuer.id","209999899")
json.UpdateString("issuer.name","Xyz SAE")
json.UpdateString("receiver.address.country","EG")
json.UpdateString("receiver.address.regionCity","CAIRO")
json.UpdateString("receiver.address.postalCode","11435")
json.UpdateString("receiver.address.buildingNumber","0")
json.UpdateString("receiver.address.street","Autostrad Road Abc")
json.UpdateString("receiver.address.governate","GOVERNATE")
json.UpdateString("receiver.type","B")
json.UpdateString("receiver.id","999999999")
json.UpdateString("receiver.name","XYZ EGYPT FOR TRADE")
json.UpdateString("documentType","I")
json.UpdateString("documentTypeVersion","1.0")
json.UpdateString("dateTimeIssued","2020-11-15T11:04:53Z")
json.UpdateString("taxpayerActivityCode","1073")
json.UpdateString("internalID","ZZZZ999")
json.UpdateString("purchaseOrderReference","2009199918")
json.UpdateString("salesOrderReference","")
json.UpdateString("payment.bankName","")
json.UpdateString("payment.bankAddress","")
json.UpdateString("payment.bankAccountNo","")
json.UpdateString("payment.bankAccountIBAN","")
json.UpdateString("payment.swiftCode","")
json.UpdateString("payment.terms","")
json.UpdateString("delivery.approach","")
json.UpdateString("delivery.packaging","")
json.UpdateString("delivery.dateValidity","")
json.UpdateString("delivery.exportPort","")
json.UpdateString("delivery.countryOfOrigin","EG")
json.UpdateInt("delivery.grossWeight",0)
json.UpdateInt("delivery.netWeight",0)
json.UpdateString("delivery.terms","")
json.UpdateString("invoiceLines[0].description","CDM Widget 48GX99X12BA")
json.UpdateString("invoiceLines[0].itemType","GS1")
json.UpdateString("invoiceLines[0].itemCode","7622213335056")
json.UpdateString("invoiceLines[0].unitType","CS")
json.UpdateNumber("invoiceLines[0].quantity","1.00")
json.UpdateString("invoiceLines[0].unitValue.currencySold","EGP")
json.UpdateNumber("invoiceLines[0].unitValue.amountEGP","588.67")
json.UpdateInt("invoiceLines[0].unitValue.amountSold",0)
json.UpdateInt("invoiceLines[0].unitValue.currencyExchangeRate",0)
json.UpdateNumber("invoiceLines[0].salesTotal","588.67")
json.UpdateNumber("invoiceLines[0].total","603.97")
json.UpdateInt("invoiceLines[0].valueDifference",0)
json.UpdateInt("invoiceLines[0].totalTaxableFees",0)
json.UpdateNumber("invoiceLines[0].netTotal","529.8")
json.UpdateInt("invoiceLines[0].itemsDiscount",0)
json.UpdateNumber("invoiceLines[0].discount.rate","10.00")
json.UpdateNumber("invoiceLines[0].discount.amount","58.87")
json.UpdateString("invoiceLines[0].taxableItems[0].taxType","T1")
json.UpdateNumber("invoiceLines[0].taxableItems[0].amount","74.17")
json.UpdateString("invoiceLines[0].taxableItems[0].subType","No sub")
json.UpdateNumber("invoiceLines[0].taxableItems[0].rate","14.00")
json.UpdateString("invoiceLines[0].internalCode","9099994")
json.UpdateNumber("totalSales","588.67")
json.UpdateNumber("totalSalesAmount","588.67")
json.UpdateNumber("totalDiscountAmount","58.87")
json.UpdateNumber("netAmount","529.80")
json.UpdateString("taxTotals[0].taxType","T1")
json.UpdateNumber("taxTotals[0].amount","74.17")
json.UpdateInt("extraDiscountAmount",0)
json.UpdateInt("totalItemsDiscountAmount",0)
json.UpdateNumber("totalAmount","603.97")

json.put_EmitCompact(true)
jsonToSign = json.emit()

# Create the CAdES-BES signature.
crypt.put_EncodingMode("base64")

# Make sure we sign the utf-8 byte representation of the JSON string
crypt.put_Charset("utf-8")

sigBase64 = crypt.signStringENC(jsonToSign)
if (crypt.get_LastMethodSuccess() == false)
    print crypt.lastErrorText() + "\n";
    exit
end

print "Base64 signature:" + "\n";
print sigBase64 + "\n";

# Insert the base64 signature into the JSON to be sent
json.UpdateString("signatures[0].signatureType","I")
json.UpdateString("signatures[0].value",sigBase64)

# Wrap the JSON in  {"documents":[ ... ]}
sbToSend = Chilkat::CkStringBuilder.new()
sbToSend.Append("{\"documents\":[")
sbToSend.Append(json.emit())
sbToSend.Append("]}")

# ------------------------------------------------------------------------
# Get an access token using our client ID and client secret key
clientId = "abc999ff-1234"
clientSecretKey = "123fff22-1234-abcd"

http = Chilkat::CkHttp.new()

# Causes the Authorization: Basic header to be added..
http.put_Login(clientId)
http.put_Password(clientSecretKey)
http.put_BasicAuth(true)

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/connect/token")
req.put_ContentType("application/x-www-form-urlencoded")
req.AddParam("grant_type","client_credentials")
req.AddHeader("Connection","close")

http.put_Accept("application/json")

# resp is a CkHttpResponse
resp = http.PostUrlEncoded("https://id.preprod.eta.gov.eg/connect/token",req)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

http.CloseAllConnections()

print "Response status code: " + resp.get_StatusCode().to_s() + "\n";
print "Response body:" + "\n";
print resp.bodyStr() + "\n";

if (resp.get_StatusCode() != 200)
    print "Failed." + "\n";

    exit
end

jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.Load(resp.bodyStr())

accessToken = jsonToken.stringOf("access_token")
print "access_token = " + accessToken + "\n";

# ------------------------------------------------------------------------
# Submit the signed JSON to the ETA (Egypt Tax Authority) Portal

# No longer sending basic authentication...
http.put_Login("")
http.put_Password("")
http.put_BasicAuth(false)

# Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
http.put_AuthToken(accessToken)

# resp is a CkHttpResponse
resp = http.PostJson2("https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions","application/json; charset=utf-8",sbToSend.getAsString())
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print "Response status code: " + resp.get_StatusCode().to_s() + "\n";
print "Response body:" + "\n";
print resp.bodyStr() + "\n";