PowerBuilder
PowerBuilder
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 PowerBuilder Downloads
integer li_rc
integer li_Success
oleobject loo_Crypt
oleobject loo_Cert
oleobject loo_CmsOptions
oleobject loo_JsonSigningAttrs
oleobject loo_Json
string ls_JsonToSign
string ls_SigBase64
oleobject loo_SbToSend
string ls_ClientId
string ls_ClientSecretKey
oleobject loo_Http
oleobject loo_Req
oleobject loo_Resp
oleobject loo_JsonToken
string ls_AccessToken
string ls_JsonStr
string ls_Url
li_Success = 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Crypt = create oleobject
li_rc = loo_Crypt.ConnectToNewObject("Chilkat.Crypt2")
if li_rc < 0 then
destroy loo_Crypt
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Crypt.VerboseLogging = 1
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")
loo_Cert.VerboseLogging = 1
// Set the smart card PIN, which will be needed for signing.
loo_Cert.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..
li_Success = loo_Cert.LoadFromSmartcard("")
if li_Success = 0 then
Write-Debug loo_Cert.LastErrorText
destroy loo_Crypt
destroy loo_Cert
return
end if
// Tell the crypt class to use this cert.
li_Success = loo_Crypt.SetSigningCert(loo_Cert)
if li_Success = 0 then
Write-Debug loo_Crypt.LastErrorText
destroy loo_Crypt
destroy loo_Cert
return
end if
loo_CmsOptions = create oleobject
li_rc = loo_CmsOptions.ConnectToNewObject("Chilkat.JsonObject")
// Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
loo_CmsOptions.UpdateBool("DigestData",1)
loo_CmsOptions.UpdateBool("OmitAlgorithmIdNull",1)
// Indicate that we are passing normal JSON and we want Chilkat do automatically
// do the ITIDA JSON canonicalization:
loo_CmsOptions.UpdateBool("CanonicalizeITIDA",1)
loo_Crypt.CmsOptions = loo_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.
loo_Crypt.CadesEnabled = 1
loo_Crypt.HashAlgorithm = "sha256"
loo_JsonSigningAttrs = create oleobject
li_rc = loo_JsonSigningAttrs.ConnectToNewObject("Chilkat.JsonObject")
loo_JsonSigningAttrs.UpdateInt("contentType",1)
loo_JsonSigningAttrs.UpdateInt("signingTime",1)
loo_JsonSigningAttrs.UpdateInt("messageDigest",1)
loo_JsonSigningAttrs.UpdateInt("signingCertificateV2",1)
loo_Crypt.SigningAttributes = loo_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:
loo_Crypt.IncludeCertChain = 0
// 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
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("issuer.address.branchID","0")
loo_Json.UpdateString("issuer.address.country","EG")
loo_Json.UpdateString("issuer.address.regionCity","Cairo")
loo_Json.UpdateString("issuer.address.postalCode","")
loo_Json.UpdateString("issuer.address.buildingNumber","0")
loo_Json.UpdateString("issuer.address.street","123rd Street")
loo_Json.UpdateString("issuer.address.governate","GOVERNATE")
loo_Json.UpdateString("issuer.type","B")
loo_Json.UpdateString("issuer.id","209999899")
loo_Json.UpdateString("issuer.name","Xyz SAE")
loo_Json.UpdateString("receiver.address.country","EG")
loo_Json.UpdateString("receiver.address.regionCity","CAIRO")
loo_Json.UpdateString("receiver.address.postalCode","11435")
loo_Json.UpdateString("receiver.address.buildingNumber","0")
loo_Json.UpdateString("receiver.address.street","Autostrad Road Abc")
loo_Json.UpdateString("receiver.address.governate","GOVERNATE")
loo_Json.UpdateString("receiver.type","B")
loo_Json.UpdateString("receiver.id","999999999")
loo_Json.UpdateString("receiver.name","XYZ EGYPT FOR TRADE")
loo_Json.UpdateString("documentType","I")
loo_Json.UpdateString("documentTypeVersion","1.0")
loo_Json.UpdateString("dateTimeIssued","2020-11-15T11:04:53Z")
loo_Json.UpdateString("taxpayerActivityCode","1073")
loo_Json.UpdateString("internalID","ZZZZ999")
loo_Json.UpdateString("purchaseOrderReference","2009199918")
loo_Json.UpdateString("salesOrderReference","")
loo_Json.UpdateString("payment.bankName","")
loo_Json.UpdateString("payment.bankAddress","")
loo_Json.UpdateString("payment.bankAccountNo","")
loo_Json.UpdateString("payment.bankAccountIBAN","")
loo_Json.UpdateString("payment.swiftCode","")
loo_Json.UpdateString("payment.terms","")
loo_Json.UpdateString("delivery.approach","")
loo_Json.UpdateString("delivery.packaging","")
loo_Json.UpdateString("delivery.dateValidity","")
loo_Json.UpdateString("delivery.exportPort","")
loo_Json.UpdateString("delivery.countryOfOrigin","EG")
loo_Json.UpdateInt("delivery.grossWeight",0)
loo_Json.UpdateInt("delivery.netWeight",0)
loo_Json.UpdateString("delivery.terms","")
loo_Json.UpdateString("invoiceLines[0].description","CDM Widget 48GX99X12BA")
loo_Json.UpdateString("invoiceLines[0].itemType","GS1")
loo_Json.UpdateString("invoiceLines[0].itemCode","7622213335056")
loo_Json.UpdateString("invoiceLines[0].unitType","CS")
loo_Json.UpdateNumber("invoiceLines[0].quantity","1.00")
loo_Json.UpdateString("invoiceLines[0].unitValue.currencySold","EGP")
loo_Json.UpdateNumber("invoiceLines[0].unitValue.amountEGP","588.67")
loo_Json.UpdateInt("invoiceLines[0].unitValue.amountSold",0)
loo_Json.UpdateInt("invoiceLines[0].unitValue.currencyExchangeRate",0)
loo_Json.UpdateNumber("invoiceLines[0].salesTotal","588.67")
loo_Json.UpdateNumber("invoiceLines[0].total","603.97")
loo_Json.UpdateInt("invoiceLines[0].valueDifference",0)
loo_Json.UpdateInt("invoiceLines[0].totalTaxableFees",0)
loo_Json.UpdateNumber("invoiceLines[0].netTotal","529.8")
loo_Json.UpdateInt("invoiceLines[0].itemsDiscount",0)
loo_Json.UpdateNumber("invoiceLines[0].discount.rate","10.00")
loo_Json.UpdateNumber("invoiceLines[0].discount.amount","58.87")
loo_Json.UpdateString("invoiceLines[0].taxableItems[0].taxType","T1")
loo_Json.UpdateNumber("invoiceLines[0].taxableItems[0].amount","74.17")
loo_Json.UpdateString("invoiceLines[0].taxableItems[0].subType","No sub")
loo_Json.UpdateNumber("invoiceLines[0].taxableItems[0].rate","14.00")
loo_Json.UpdateString("invoiceLines[0].internalCode","9099994")
loo_Json.UpdateNumber("totalSales","588.67")
loo_Json.UpdateNumber("totalSalesAmount","588.67")
loo_Json.UpdateNumber("totalDiscountAmount","58.87")
loo_Json.UpdateNumber("netAmount","529.80")
loo_Json.UpdateString("taxTotals[0].taxType","T1")
loo_Json.UpdateNumber("taxTotals[0].amount","74.17")
loo_Json.UpdateInt("extraDiscountAmount",0)
loo_Json.UpdateInt("totalItemsDiscountAmount",0)
loo_Json.UpdateNumber("totalAmount","603.97")
loo_Json.EmitCompact = 1
ls_JsonToSign = loo_Json.Emit()
// Create the CAdES-BES signature.
loo_Crypt.EncodingMode = "base64"
// Make sure we sign the utf-8 byte representation of the JSON string
loo_Crypt.Charset = "utf-8"
ls_SigBase64 = loo_Crypt.SignStringENC(ls_JsonToSign)
if loo_Crypt.LastMethodSuccess = 0 then
Write-Debug loo_Crypt.LastErrorText
destroy loo_Crypt
destroy loo_Cert
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
return
end if
Write-Debug "Base64 signature:"
Write-Debug ls_SigBase64
// Insert the base64 signature into the JSON to be sent
loo_Json.UpdateString("signatures[0].signatureType","I")
loo_Json.UpdateString("signatures[0].value",ls_SigBase64)
// Wrap the JSON in {"documents":[ ... ]}
loo_SbToSend = create oleobject
li_rc = loo_SbToSend.ConnectToNewObject("Chilkat.StringBuilder")
loo_SbToSend.Append("{~"documents~":[")
loo_SbToSend.Append(loo_Json.Emit())
loo_SbToSend.Append("]}")
// ------------------------------------------------------------------------
// Get an access token using our client ID and client secret key
ls_ClientId = "abc999ff-1234"
ls_ClientSecretKey = "123fff22-1234-abcd"
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
// Causes the Authorization: Basic header to be added..
loo_Http.Login = ls_ClientId
loo_Http.Password = ls_ClientSecretKey
loo_Http.BasicAuth = 1
loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")
loo_Req.HttpVerb = "POST"
loo_Req.Path = "/connect/token"
loo_Req.ContentType = "application/x-www-form-urlencoded"
loo_Req.AddParam("grant_type","client_credentials")
loo_Req.AddHeader("Connection","close")
loo_Http.Accept = "application/json"
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")
li_Success = loo_Http.HttpReq("https://id.preprod.eta.gov.eg/connect/token",loo_Req,loo_Resp)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Crypt
destroy loo_Cert
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
destroy loo_SbToSend
destroy loo_Http
destroy loo_Req
destroy loo_Resp
return
end if
loo_Http.CloseAllConnections()
Write-Debug "Response status code: " + string(loo_Resp.StatusCode)
Write-Debug "Response body:"
Write-Debug loo_Resp.BodyStr
if loo_Resp.StatusCode <> 200 then
Write-Debug "Failed."
destroy loo_Crypt
destroy loo_Cert
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
destroy loo_SbToSend
destroy loo_Http
destroy loo_Req
destroy loo_Resp
return
end if
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
li_Success = loo_JsonToken.Load(loo_Resp.BodyStr)
ls_AccessToken = loo_JsonToken.StringOf("access_token")
Write-Debug "access_token = " + ls_AccessToken
// ------------------------------------------------------------------------
// Submit the signed JSON to the ETA (Egypt Tax Authority) Portal
// No longer sending basic authentication...
loo_Http.Login = ""
loo_Http.Password = ""
loo_Http.BasicAuth = 0
// Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
loo_Http.AuthToken = ls_AccessToken
ls_JsonStr = loo_SbToSend.GetAsString()
ls_Url = "https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions"
li_Success = loo_Http.HttpStr("POST",ls_Url,ls_JsonStr,"utf-8","application/json; charset=utf-8",loo_Resp)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Crypt
destroy loo_Cert
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
destroy loo_SbToSend
destroy loo_Http
destroy loo_Req
destroy loo_Resp
destroy loo_JsonToken
return
end if
Write-Debug "Response status code: " + string(loo_Resp.StatusCode)
Write-Debug "Response body:"
Write-Debug loo_Resp.BodyStr
destroy loo_Crypt
destroy loo_Cert
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
destroy loo_SbToSend
destroy loo_Http
destroy loo_Req
destroy loo_Resp
destroy loo_JsonToken