zatca 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d50ea1cc7ced6ae04db6b019bbb93b89acd164c93ce6bf0f918e93d3300ca2
-  data.tar.gz: 29217d567f38527e15424d822c681e84c44de620f1212658f49fd7e9c9d28a46
+  metadata.gz: d65cb57654ffcf290ba95965eff7e0c0ec6f5413a890b16cbce127e76a5356d8
+  data.tar.gz: 7c3a4bbd85c5630d541e30bf4c8b510bbffbb0f4a67bc91e8969c5551cbeffe2
 SHA512:
-  metadata.gz: 3b3c1935011617463f0adee23e3590eddf956be5df53dd6adcd56e1f0c0ba97135faabcb5c97baa93b0565e04dcd2ffde0136573751c12d390f531a5cdccc576
-  data.tar.gz: b1f4612a7c601565791d14d21bae937ef0c7728e3e2aeada65611b7db7a10d12261ebaf2f8b3c56ff6bb5f793173022ea3c26ae126732e3038d17fb27903ca69
+  metadata.gz: 6341d6dcb453d1a50b98bb25326ea36f1a2569d856ad53515ae607b3b92f3937358aab733dbf509fd404685a54b5cbf171021a00304e411cc0b297da6d538b84
+  data.tar.gz: b32f22b71a5ff6532bd7c9ca63b2bbca9eaa2c36d948d32cd7338cacfd5278dc3b2a83ab36929a9272a0280ee0183bcbdb89a2aa8682d7060006d41119eb645c

data/README.md

@@ -1,9 +1,9 @@
 # zatca
 ![](https://img.shields.io/gem/v/zatca) ![](https://img.shields.io/github/workflow/status/mrsool/zatca/Ruby)
 
-A Ruby library for generating QR Codes for the e-invoice standard by ZATCA in Saudi Arabia.
+A Ruby library for generating QR Codes and e-invoices according to the standard created by ZATCA in Saudi Arabia.
 
-✅ Validated to have the same output as [ZATCA's SDK](https://zatca.gov.sa/en/E-Invoicing/SystemsDevelopers/ComplianceEnablementToolbox/Pages/DownloadSDK.aspx) as of 12 November 2021.
+This library supports both Phase 1 and Phase 2. Phase 2 support is still new so there may be bugs. Please [report any issues](https://github.com/mrsool/zatca/issues/new) you find.
 
 # Installation
 
@@ -19,6 +19,7 @@ bundle add zatca
 
 # Usage
 
+## Phase 1
 ```rb
 require "zatca"
 
@@ -51,3 +52,11 @@ tags = ZATCA::Tags.new({
 generator = ZATCA::QRCodeGenerator.new(tags)
 generator.render(size: 512)
 ```
+
+## Phase 2
+Documentation lives in the [wiki](https://github.com/mrsool/zatca/wiki)
+
+# Notice of Non-Affiliation and Disclaimer
+This library is not affiliated, associated, authorized, endorsed by, or in any way officially connected with ZATCA (Zakat, Tax and Customs Authority), or any of its subsidiaries or its affiliates. The official ZATCA website can be found at https://zatca.gov.sa.
+
+

data/einvoicing-sdk/Apps/fatoora

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+EXTVER=$(jq -r '.version' ${FATOORA_HOME}/global.json)
+
+CERTPASSWORD=$(jq -r '.certPassword' ${FATOORA_HOME}/global.json)
+
+
+java -Djdk.module.illegalAccess=deny -Djdk.sunec.disableNative=false -jar ${FATOORA_HOME}/zatca-einvoicing-sdk-${EXTVER}.jar --globalVersion $EXTVER -certpassword $CERTPASSWORD $1 $2 $3 $4 $5 $6
+
+
+
+

data/einvoicing-sdk/Apps/fatoora.bat

@@ -0,0 +1,16 @@
+
+@echo off
+
+SET VAR=
+FOR /F %%I IN ('jq .version %FATOORA_HOME%/global.json') DO set "VAR=%%I"
+
+SET CERT_PASS=
+FOR /F %%N IN ('jq .certPassword %FATOORA_HOME%/global.json') DO set "CERT_PASS=%%N"
+
+
+set "VAR=%VAR:~1,-1%"
+
+set "CERT_PASS=%CERT_PASS:~1,-1%"
+
+
+if exist "%FATOORA_HOME%/zatca-einvoicing-sdk-%VAR%.jar" call java -Djdk.module.illegalAccess=deny -Dfile.encoding=UTF-8 -jar %FATOORA_HOME%/zatca-einvoicing-sdk-%VAR%.jar --globalVersion %VAR% -certpassword %CERT_PASS% %*

data/einvoicing-sdk/Apps/global.json

@@ -0,0 +1 @@
+{"version":"238-R3.2.7" , "certPassword": "123456789" }

data/einvoicing-sdk/Configuration/config.json

@@ -0,0 +1,11 @@
+{
+  "xsdPath": "/zatca/Data/Schemas/xsds/UBL2.1/xsd/maindoc/UBL-Invoice-2.1.xsd",
+  "enSchematron": "/zatca/Data/Rules/schematrons/CEN-EN16931-UBL.xsl",
+  "zatcaSchematron": "/zatca/Data/Rules/schematrons/20210819_ZATCA_E-invoice_Validation_Rules.xsl",
+  "certPath": "/zatca/Data/Certificates/cert.pem",
+  "privateKeyPath": "/zatca/Data/Certificates/ec-secp256k1-priv-key.pem",
+  "pihPath": "/zatca/Data/PIH/pih.txt",
+  "certPassword": "123456789",
+  "inputPath": "/zatca/Data/Input",
+  "usagePathFile": "/zatca/Configuration/usage.txt"
+}

data/einvoicing-sdk/Configuration/defaults.json

@@ -0,0 +1,11 @@
+{
+  "xsdPath": "../Data/Schemas/xsds/UBL2.1/xsd/maindoc/UBL-Invoice-2.1.xsd",
+  "enSchematron": "../Data/Rules/schematrons/CEN-EN16931-UBL.xsl",
+  "zatcaSchematron": "../Data/Rules/schematrons/20210819_ZATCA_E-invoice_Validation_Rules.xsl",
+  "certPath": "../Data/Certificates/cert.pem",
+  "privateKeyPath": "../Data/Certificates/ec-secp256k1-priv-key.pem",
+  "pihPath": "../Data/PIH/pih.txt",
+  "certPassword": "123456789",
+  "inputPath": "../Data/Input",
+  "usagePathFile": "../Configuration/usage.txt"
+}

data/einvoicing-sdk/Configuration/usage.txt

@@ -0,0 +1,16 @@
+[-csr]: flag used to generate csr and private key.
+[-pem]: flag used to generate csr and private key in pem format.
+[-privateKey <fileName>]: The name of the private key output file.
+[-generatedCsr <fileName>]: The name of the csr output file.
+[-csrConfig] <fileName> : The name of the csr configuration file.
+[-invoice] <filename> : The name of the invoice file.
+[-qr]: flag used to generate qr.
+[-sign]: flag used to sign invoice.
+[-signedInvoice <fileName>]: The name of the signed invoice output file.
+[-invoiceRequest]: flag used to generate invoice request.
+[-apiRequest <fileName>]: The name of the invoice json request output file
+[-generateHash]: flag used to generate new hash for the provided invoice.
+[-validate]: flag used to validate invoice.
+[-nonprod]: flag pointing to use the csr and private key on non production server.
+[-sim]: flag pointing to use the csr and private key on simulation server.
+[-help]: flag used to display this help menu and exit.

data/einvoicing-sdk/Data/Certificates/cert.pem

@@ -0,0 +1 @@
+MIID6jCCA5CgAwIBAgITbwAAgbuRbo5tpQ+QjgABAACBuzAKBggqhkjOPQQDAjBjMRUwEwYKCZImiZPyLGQBGRYFbG9jYWwxEzARBgoJkiaJk/IsZAEZFgNnb3YxFzAVBgoJkiaJk/IsZAEZFgdleHRnYXp0MRwwGgYDVQQDExNUU1pFSU5WT0lDRS1TdWJDQS0xMB4XDTIyMTEwOTA4MDcyMloXDTI0MTEwODA4MDcyMlowTjELMAkGA1UEBhMCU0ExEzARBgNVBAoTCjM5OTk5OTk5OTkxDDAKBgNVBAsTA1RTVDEcMBoGA1UEAxMTVFNULTM5OTk5OTk5OTkwMDAwMzBWMBAGByqGSM49AgEGBSuBBAAKA0IABGGDDKDmhWAITDv7LXqLX2cmr6+qddUkpcLCvWs5rC2O29W/hS4ajAK4Qdnahym6MaijX75Cg3j4aao7ouYXJ9GjggI5MIICNTCBmgYDVR0RBIGSMIGPpIGMMIGJMTswOQYDVQQEDDIxLVRTVHwyLVRTVHwzLTlmMDkyMjM4LTFkOTctNDcxOC1iNDQxLWNiYzMwMTMyMWIwYTEfMB0GCgmSJomT8ixkAQEMDzM5OTk5OTk5OTkwMDAwMzENMAsGA1UEDAwEMTEwMDEMMAoGA1UEGgwDVFNUMQwwCgYDVQQPDANUU1QwHQYDVR0OBBYEFDuWYlOzWpFN3no1WtyNktQdrA8JMB8GA1UdIwQYMBaAFHZgjPsGoKxnVzWdz5qspyuZNbUvME4GA1UdHwRHMEUwQ6BBoD+GPWh0dHA6Ly90c3RjcmwuemF0Y2EuZ292LnNhL0NlcnRFbnJvbGwvVFNaRUlOVk9JQ0UtU3ViQ0EtMS5jcmwwga0GCCsGAQUFBwEBBIGgMIGdMG4GCCsGAQUFBzABhmJodHRwOi8vdHN0Y3JsLnphdGNhLmdvdi5zYS9DZXJ0RW5yb2xsL1RTWkVpbnZvaWNlU0NBMS5leHRnYXp0Lmdvdi5sb2NhbF9UU1pFSU5WT0lDRS1TdWJDQS0xKDEpLmNydDArBggrBgEFBQcwAYYfaHR0cDovL3RzdGNybC56YXRjYS5nb3Yuc2Evb2NzcDAOBgNVHQ8BAf8EBAMCB4AwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMDMCcGCSsGAQQBgjcVCgQaMBgwCgYIKwYBBQUHAwIwCgYIKwYBBQUHAwMwCgYIKoZIzj0EAwIDSAAwRQIgeWUEjxXaW4s8XilH/abzbDJhHHjO3uLaD87YqioA89YCIQDNltfAU98b8FnTD7M8NYIk8cqi7OnPu7h85v5V1Bt3Hg==

data/einvoicing-sdk/Data/Certificates/ec-secp256k1-priv-key.pem

@@ -0,0 +1 @@
+MHQCAQEEIDyLDaWIn/1/g3PGLrwupV4nTiiLKM59UEqUch1vDfhpoAcGBSuBBAAKoUQDQgAEYYMMoOaFYAhMO/steotfZyavr6p11SSlwsK9azmsLY7b1b+FLhqMArhB2dqHKboxqKNfvkKDePhpqjui5hcn0Q==

data/einvoicing-sdk/Data/Input/csr-config-example-AR-VAT-Group.properties

@@ -0,0 +1,9 @@
+csr.common.name=TST-886431145-311111111101113
+csr.serial.number=1-TST|2-TST|3-ed22f1d8-e6a2-1118-9b58-d9a8f11e445f
+csr.organization.identifier=311111111111113
+csr.organization.unit.name=3111111111
+csr.organization.name=ABCD المحدودة
+csr.country.name=SA
+csr.invoice.type=1111
+csr.location.address=RRRD2929
+csr.industry.business.category=الأنشطة العقارية

data/einvoicing-sdk/Data/Input/csr-config-example-AR.properties

@@ -0,0 +1,9 @@
+csr.common.name=TST-886431145-311111111101113
+csr.serial.number=1-TST|2-TST|3-ed22f1d8-e6a2-1118-9b58-d9a8f11e445f
+csr.organization.identifier=311111111101113
+csr.organization.unit.name=فرع الرياض
+csr.organization.name=ABCD المحدودة
+csr.country.name=SA
+csr.invoice.type=1111
+csr.location.address=RRRD2929
+csr.industry.business.category=الأنشطة العقارية

data/einvoicing-sdk/Data/Input/csr-config-example-EN-VAT-group.properties

@@ -0,0 +1,9 @@
+csr.common.name=TST-886431145-311111111101113
+csr.serial.number=1-TST|2-TST|3-ed22f1d8-e6a2-1118-9b58-d9a8f11e445f
+csr.organization.identifier=311111111111113
+csr.organization.unit.name=3111111111
+csr.organization.name=ABCD Limited
+csr.country.name=SA
+csr.invoice.type=1111
+csr.location.address=RRRD2929
+csr.industry.business.category=Real estate activities

data/einvoicing-sdk/Data/Input/csr-config-example-EN.properties

@@ -0,0 +1,9 @@
+csr.common.name=TST-886431145-311111111101113
+csr.serial.number=1-TST|2-TST|3-ed22f1d8-e6a2-1118-9b58-d9a8f11e445f
+csr.organization.identifier=311111111101113
+csr.organization.unit.name=Riyadh Branch
+csr.organization.name=ABCD Limited
+csr.country.name=SA
+csr.invoice.type=1111
+csr.location.address=RRRD2929
+csr.industry.business.category=Real estate activities

data/einvoicing-sdk/Data/Input/csr-config-template.properties

@@ -0,0 +1,9 @@
+csr.common.name=
+csr.serial.number=
+csr.organization.identifier=
+csr.organization.unit.name=
+csr.organization.name=
+csr.country.name=
+csr.invoice.type=
+csr.location.address=
+csr.industry.business.category=

data/einvoicing-sdk/Data/PIH/pih.txt

@@ -0,0 +1 @@
+NWZlY2ViNjZmZmM4NmYzOGQ5NTI3ODZjNmQ2OTZjNzljMmRiYzIzOWRkNGU5MWI0NjcyOWQ3M2EyN2ZiNTdlOQ==