(Android™) Sign ITIDA JSON and Send to ETA (Egypt Tax Authority) Portal

See more Egypt ITIDA Examples

Demonstrates how to ITIDA canonicalize JSON, create signature, and send to the ETA Portal.

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkCrypt2 crypt = new CkCrypt2();
    crypt.put_VerboseLogging(true);

    CkCert cert = new CkCert();
    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..
    boolean success = cert.LoadFromSmartcard("");
    if (success != true) {
        Log.i(TAG, cert.lastErrorText());
        return;
        }

    // Tell the crypt class to use this cert.
    success = crypt.SetSigningCert(cert);
    if (success != true) {
        Log.i(TAG, crypt.lastErrorText());
        return;
        }

    CkJsonObject cmsOptions = new CkJsonObject();
    // 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");

    CkJsonObject jsonSigningAttrs = new CkJsonObject();
    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.)
    // Note: The JSON should NOT begin with "{ "documents" : [ ..."

    //       {
    //          "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,
    //       }

    // 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");

    String jsonInvoice = "{ ... }";
    String sigBase64 = crypt.signStringENC(jsonInvoice);
    if (crypt.get_LastMethodSuccess() == false) {
        Log.i(TAG, crypt.lastErrorText());
        return;
        }

    Log.i(TAG, "Base64 signature:");
    Log.i(TAG, sigBase64);

    // Insert the base64 signature into the JSON to be sent
    CkJsonObject json = new CkJsonObject();
    json.Load(jsonInvoice);
    json.UpdateString("signatures[0].signatureType","I");
    json.UpdateString("signatures[0].value",sigBase64);
    json.put_EmitCompact(true);

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

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

    CkHttp http = new CkHttp();

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

    CkHttpRequest req = new CkHttpRequest();
    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");

    CkHttpResponse resp = http.PostUrlEncoded("https://id.preprod.eta.gov.eg/connect/token",req);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    http.CloseAllConnections();

    Log.i(TAG, "Response status code: " + String.valueOf(resp.get_StatusCode()));
    Log.i(TAG, "Response body:");
    Log.i(TAG, resp.bodyStr());

    if (resp.get_StatusCode() != 200) {
        Log.i(TAG, "Failed.");

        return;
        }

    CkJsonObject jsonToken = new CkJsonObject();
    success = jsonToken.Load(resp.bodyStr());

    String accessToken = jsonToken.stringOf("access_token");
    Log.i(TAG, "access_token = " + accessToken);

    // ------------------------------------------------------------------------
    // 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 = http.PostJson2("https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions","application/json; charset=utf-8",sbToSend.getAsString());
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    Log.i(TAG, "Response status code: " + String.valueOf(resp.get_StatusCode()));
    Log.i(TAG, "Response body:");
    Log.i(TAG, resp.bodyStr());

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}