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