Java
Chilkat2 Java
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 Java Downloads
import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Crypt2;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpRequest;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Crypt2 crypt = new Crypt2();
crypt.setVerboseLogging(true);
Cert cert = new Cert();
cert.setVerboseLogging(true);
// Set the smart card PIN, which will be needed for signing.
cert.setSmartCardPin("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..
try {
cert.loadFromSmartcard("");
// Tell the crypt class to use this cert.
crypt.setSigningCert(cert);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
JsonObject cmsOptions = new JsonObject();
// 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.setCmsOptions(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.setCadesEnabled(true);
crypt.setHashAlgorithm("sha256");
JsonObject jsonSigningAttrs = new JsonObject();
jsonSigningAttrs.updateInt("contentType", 1);
jsonSigningAttrs.updateInt("signingTime", 1);
jsonSigningAttrs.updateInt("messageDigest", 1);
jsonSigningAttrs.updateInt("signingCertificateV2", 1);
crypt.setSigningAttributes(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.setIncludeCertChain(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
JsonObject json = new JsonObject();
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.setEmitCompact(true);
String jsonToSign = json.emit();
// Create the CAdES-BES signature.
crypt.setEncodingMode("base64");
// Make sure we sign the utf-8 byte representation of the JSON string
crypt.setCharset("utf-8");
String sigBase64;
try {
sigBase64 = crypt.signStringENC(jsonToSign);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
System.out.println("Base64 signature:");
System.out.println(sigBase64);
// 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":[ ... ]}
StringBuilder sbToSend = new StringBuilder();
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";
Http http = new Http();
// Causes the Authorization: Basic header to be added..
http.setLogin(clientId);
http.setPassword(clientSecretKey);
http.setBasicAuth(true);
HttpRequest req = new HttpRequest();
req.setHttpVerb("POST");
req.setPath("/connect/token");
req.setContentType("application/x-www-form-urlencoded");
req.addParam("grant_type", "client_credentials");
req.addHeader("Connection", "close");
http.setAccept("application/json");
HttpResponse resp = new HttpResponse();
try {
http.httpReq("https://id.preprod.eta.gov.eg/connect/token", req, resp);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
http.closeAllConnections();
System.out.println("Response status code: " + resp.getStatusCode());
System.out.println("Response body:");
System.out.println(resp.getBodyStr());
if (resp.getStatusCode() != 200) {
System.out.println("Failed.");
return;
}
JsonObject jsonToken = new JsonObject();
jsonToken.load(resp.getBodyStr());
String accessToken = jsonToken.stringOf("access_token");
System.out.println("access_token = " + accessToken);
// ------------------------------------------------------------------------
// Submit the signed JSON to the ETA (Egypt Tax Authority) Portal
// No longer sending basic authentication...
http.setLogin("");
http.setPassword("");
http.setBasicAuth(false);
// Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
http.setAuthToken(accessToken);
String jsonStr = sbToSend.getAsString();
String url = "https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions";
try {
http.httpStr("POST", url, jsonStr, "utf-8", "application/json; charset=utf-8", resp);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
System.out.println("Response status code: " + resp.getStatusCode());
System.out.println("Response body:");
System.out.println(resp.getBodyStr());
}
}