Pascal (Lazarus/Delphi)
Pascal (Lazarus/Delphi)
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 Pascal (Lazarus/Delphi) Downloads
program ChilkatDemo;
// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.
{$IFDEF FPC}
{$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}
uses
{$IFDEF UNIX}
cthreads,
{$ENDIF}
SysUtils,
CkDllLoader,
Chilkat.Http,
Chilkat.HttpRequest,
Chilkat.HttpResponse,
Chilkat.StringBuilder,
Chilkat.JsonObject,
Chilkat.Cert,
Chilkat.Crypt2;
// ---------------------------------------------------------------------------
procedure RunDemo;
var
success: Boolean;
crypt: TCrypt2;
cert: TCert;
cmsOptions: TJsonObject;
jsonSigningAttrs: TJsonObject;
json: TJsonObject;
jsonToSign: string;
sigBase64: string;
sbToSend: TStringBuilder;
clientId: string;
clientSecretKey: string;
http: THttp;
req: THttpRequest;
resp: THttpResponse;
jsonToken: TJsonObject;
accessToken: string;
jsonStr: string;
url: string;
begin
success := False;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
crypt := TCrypt2.Create;
crypt.VerboseLogging := True;
cert := TCert.Create;
cert.VerboseLogging := True;
// Set the smart card PIN, which will be needed for signing.
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..
success := cert.LoadFromSmartcard('');
if (success = False) then
begin
WriteLn(cert.LastErrorText);
Exit;
end;
// Tell the crypt class to use this cert.
success := crypt.SetSigningCert(cert);
if (success = False) then
begin
WriteLn(crypt.LastErrorText);
Exit;
end;
cmsOptions := TJsonObject.Create;
// 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.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.CadesEnabled := True;
crypt.HashAlgorithm := 'sha256';
jsonSigningAttrs := TJsonObject.Create;
jsonSigningAttrs.UpdateInt('contentType',1);
jsonSigningAttrs.UpdateInt('signingTime',1);
jsonSigningAttrs.UpdateInt('messageDigest',1);
jsonSigningAttrs.UpdateInt('signingCertificateV2',1);
crypt.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.IncludeCertChain := 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
json := TJsonObject.Create;
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.EmitCompact := True;
jsonToSign := json.Emit();
// Create the CAdES-BES signature.
crypt.EncodingMode := 'base64';
// Make sure we sign the utf-8 byte representation of the JSON string
crypt.Charset := 'utf-8';
sigBase64 := crypt.SignStringENC(jsonToSign);
if (crypt.LastMethodSuccess = False) then
begin
WriteLn(crypt.LastErrorText);
Exit;
end;
WriteLn('Base64 signature:');
WriteLn(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":[ ... ]}
sbToSend := TStringBuilder.Create;
sbToSend.Append('{"documents":[');
sbToSend.Append(json.Emit());
sbToSend.Append(']}');
// ------------------------------------------------------------------------
// Get an access token using our client ID and client secret key
clientId := 'abc999ff-1234';
clientSecretKey := '123fff22-1234-abcd';
http := THttp.Create;
// Causes the Authorization: Basic header to be added..
http.Login := clientId;
http.Password := clientSecretKey;
http.BasicAuth := True;
req := THttpRequest.Create;
req.HttpVerb := 'POST';
req.Path := '/connect/token';
req.ContentType := 'application/x-www-form-urlencoded';
req.AddParam('grant_type','client_credentials');
req.AddHeader('Connection','close');
http.Accept := 'application/json';
resp := THttpResponse.Create;
success := http.HttpReq('https://id.preprod.eta.gov.eg/connect/token',req,resp);
if (success = False) then
begin
WriteLn(http.LastErrorText);
Exit;
end;
http.CloseAllConnections();
WriteLn('Response status code: ' + resp.StatusCode);
WriteLn('Response body:');
WriteLn(resp.BodyStr);
if (resp.StatusCode <> 200) then
begin
WriteLn('Failed.');
Exit;
end;
jsonToken := TJsonObject.Create;
success := jsonToken.Load(resp.BodyStr);
accessToken := jsonToken.StringOf('access_token');
WriteLn('access_token = ' + accessToken);
// ------------------------------------------------------------------------
// Submit the signed JSON to the ETA (Egypt Tax Authority) Portal
// No longer sending basic authentication...
http.Login := '';
http.Password := '';
http.BasicAuth := False;
// Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
http.AuthToken := accessToken;
jsonStr := sbToSend.GetAsString();
url := 'https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions';
success := http.HttpStr('POST',url,jsonStr,'utf-8','application/json; charset=utf-8',resp);
if (success = False) then
begin
WriteLn(http.LastErrorText);
Exit;
end;
WriteLn('Response status code: ' + resp.StatusCode);
WriteLn('Response body:');
WriteLn(resp.BodyStr);
crypt.Free;
cert.Free;
cmsOptions.Free;
jsonSigningAttrs.Free;
json.Free;
sbToSend.Free;
http.Free;
req.Free;
resp.Free;
jsonToken.Free;
end;
// ---------------------------------------------------------------------------
begin
try
RunDemo;
except
on E: Exception do
WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
end;
WriteLn;
{$IFDEF MSWINDOWS}
WriteLn('Press Enter to exit...');
ReadLn;
{$ENDIF}
end.