(Visual FoxPro) 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.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

LOCAL lnSuccess
LOCAL loCrypt
LOCAL loCert
LOCAL loCmsOptions
LOCAL loJsonSigningAttrs
LOCAL loJson
LOCAL lcJsonToSign
LOCAL lcSigBase64
LOCAL loSbToSend
LOCAL lcClientId
LOCAL lcClientSecretKey
LOCAL loHttp
LOCAL loReq
LOCAL loResp
LOCAL loJsonToken
LOCAL lcAccessToken
LOCAL lcJsonStr
LOCAL lcUrl

lnSuccess = 0

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

loCrypt = CreateObject('Chilkat.Crypt2')
loCrypt.VerboseLogging = 1

loCert = CreateObject('Chilkat.Cert')
loCert.VerboseLogging = 1

* 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..
lnSuccess = loCert.LoadFromSmartcard("")
IF (lnSuccess = 0) THEN
    ? loCert.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    CANCEL
ENDIF

* Tell the crypt class to use this cert.
lnSuccess = loCrypt.SetSigningCert(loCert)
IF (lnSuccess = 0) THEN
    ? loCrypt.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    CANCEL
ENDIF

loCmsOptions = CreateObject('Chilkat.JsonObject')
* Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
loCmsOptions.UpdateBool("DigestData",1)
loCmsOptions.UpdateBool("OmitAlgorithmIdNull",1)

* Indicate that we are passing normal JSON and we want Chilkat do automatically
* do the ITIDA JSON canonicalization:
loCmsOptions.UpdateBool("CanonicalizeITIDA",1)

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 = 1

loCrypt.HashAlgorithm = "sha256"

loJsonSigningAttrs = CreateObject('Chilkat.JsonObject')
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 = 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

loJson = CreateObject('Chilkat.JsonObject')
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 = 1
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 = 0) THEN
    ? loCrypt.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    RELEASE loCmsOptions
    RELEASE loJsonSigningAttrs
    RELEASE loJson
    CANCEL
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('Chilkat.StringBuilder')
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('Chilkat.Http')

* Causes the Authorization: Basic header to be added..
loHttp.Login = lcClientId
loHttp.Password = lcClientSecretKey
loHttp.BasicAuth = 1

loReq = CreateObject('Chilkat.HttpRequest')
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('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpReq("https://id.preprod.eta.gov.eg/connect/token",loReq,loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    RELEASE loCmsOptions
    RELEASE loJsonSigningAttrs
    RELEASE loJson
    RELEASE loSbToSend
    RELEASE loHttp
    RELEASE loReq
    RELEASE loResp
    CANCEL
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
    CANCEL
ENDIF

loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = 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 = 0

* 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"
lnSuccess = loHttp.HttpStr("POST",lcUrl,lcJsonStr,"utf-8","application/json; charset=utf-8",loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    RELEASE loCmsOptions
    RELEASE loJsonSigningAttrs
    RELEASE loJson
    RELEASE loSbToSend
    RELEASE loHttp
    RELEASE loReq
    RELEASE loResp
    RELEASE loJsonToken
    CANCEL
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