PHPackages sevaske/php-zatca-xml - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Payment Processing](/categories/payments) 4. / 5. sevaske/php-zatca-xml ActiveLibrary[Payment Processing](/categories/payments) sevaske/php-zatca-xml ===================== An unofficial PHP library for generating ZATCA Fatoora e-invoices. This library facilitates the creation of compliant e-invoices, QR Codes, and certificates, as well as the submission of e-invoices to ZATCA's servers. It provides developers with an easy-to-use, customizable, and robust toolkit to integrate and automate ZATCA e-invoicing processes in PHP applications. v3.4.5(3mo ago)193.3kβ€”6.6%11[1 issues](https://github.com/sevaske/php-zatca-xml/issues)1MITPHPPHP >=8.1CI passing Since Jul 10Pushed 3mo ago2 watchersCompare [ Source](https://github.com/sevaske/php-zatca-xml)[ Packagist](https://packagist.org/packages/sevaske/php-zatca-xml)[ Docs](https://github.com/sevaske/php-zatca-xml)[ RSS](/packages/sevaske-php-zatca-xml/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (10)Versions (21)Used By (1) [![php Vers ion](https://camo.githubusercontent.com/31d879fd74617eec2e260779099a54dc48742c4c0928c78ad555706ae966aad5/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f73657661736b652f7068702d7a617463612d786d6c)](https://camo.githubusercontent.com/31d879fd74617eec2e260779099a54dc48742c4c0928c78ad555706ae966aad5/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f73657661736b652f7068702d7a617463612d786d6c)[![Packagist Stars](https://camo.githubusercontent.com/42fbf81053905e9e237a80491fe6f2e4ecc7b7e44434fc5b4fc804fa7305760d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f73746172732f73657661736b652f7068702d7a617463612d786d6c)](https://packagist.org/packages/sevaske/php-zatca-xml)[![Packagist Downloads](https://camo.githubusercontent.com/7c92d52159a9382ab04983a7e465a82b10d20bf6362ef223629b3c38655cdea8/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73657661736b652f7068702d7a617463612d786d6c)](https://packagist.org/packages/sevaske/php-zatca-xml)[![Packagist Version](https://camo.githubusercontent.com/2fe9aad617c8ff360e6e16b386ccec8d99952ee34ace86ec2eacb3fa688c9e19/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73657661736b652f7068702d7a617463612d786d6c)](https://packagist.org/packages/sevaske/php-zatca-xml)[![License](https://camo.githubusercontent.com/fdf2982b9f5d7489dcf44570e714e3a15fce6253e0cc6b5aa61a075aac2ff71b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d79656c6c6f772e737667)](https://packagist.org/packages/sevaske/php-zatca-xml) Please feel free to [**contribute**](https://github.com/sevaske/php-zatca-xml/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen) if you are missing features or tags [View Examples](https://github.com/sevaske/php-zatca-xml/tree/main/examples)Β· [Report a bug](https://github.com/sevaske/php-zatca-xml/issues) ### FORK! [](#fork) **Note:** The original author of the repository [Saleh7/php-zatca-xml](https://github.com/Saleh7/php-zatca-xml) has been inactive and unresponsive for several months. This repository is a community-maintained fork with fixes and updates to keep the library functional and improved. **API Integration:** API-related functionality has been refactored and moved to a separate library for better modularity and maintainability: πŸ”— [sevaske/zatca-api:^1.0](https://github.com/sevaske/zatca-api/tree/v1) Original project: πŸ“– Introduction -------------- [](#-introduction) This is an unofficial PHP library for generating ZATCA Fatoora e-invoices (simplified invoice, simplified credit note, simplified debit note, standard invoice, standard credit note, standard debit note), certificates, and for interacting with the API. ✨ Features ---------- [](#-features) - πŸš€ **ZATCA-Compliant** – Easily generate valid e-invoices for ZATCA regulations - πŸ“œ **Invoice Creation** – Generate standard and simplified invoices in XML format - πŸ” **Digital Signing** – Sign invoices securely to ensure compliance - 🏷 **QR Code Generation** – Automatically generate QR codes for invoices - πŸ“‘ **Direct Submission to ZATCA** – Send invoices directly to ZATCA’s servers πŸ“Œ Requirements -------------- [](#-requirements) ### βœ… PHP Version [](#-php-version) - **PHP 8.1 or higher** πŸ›  Installation -------------- [](#-installation) ``` composer require sevaske/php-zatca-xml ``` πŸš€ Usage ------- [](#-usage) This library simplifies the process of generating **ZATCA-compliant** e-invoices, handling **certificates**, signing invoices, and submitting them to **ZATCA’s API**. You can find working examples for generating and signing invoices and notes here: πŸ”— [examples](https://github.com/sevaske/php-zatca-xml/tree/main/examples) --- ### πŸ“œ **1. Generating a Compliance Certificate** [](#-1-generating-a-compliance-certificate) First, generate a **certificate signing request (CSR)** and private key: ``` use Saleh7\Zatca\CertificateBuilder; use Saleh7\Zatca\Exceptions\CertificateBuilderException; try { (new CertificateBuilder()) ->setOrganizationIdentifier('312345678901233') // The Organization Identifier must be 15 digits, starting andending with 3 // string $solutionName .. The solution provider name // string $model .. The model of the unit the stamp is being generated for // string $serialNumber .. # If you have multiple devices each should have a unique serial number ->setSerialNumber('Saleh', '1n', 'SME00023') ->setCommonName('My Organization') // The common name to be used in the certificate ->setCountryName('SA') // The Country name must be Two chars only ->setOrganizationName('My Company') // The name of your organization ->setOrganizationalUnitName('IT Department') // A subunit in your organizatio ->setAddress('Riyadh 1234 Street') // like Riyadh 1234 Street ->setInvoiceType(1100)// # Four digits, each digit acting as a bool. The order is as follows: Standard Invoice, Simplified, future use, future use ->setProduction(false)// true = Production | false = Testing ->setBusinessCategory('Technology') // Your business category like food, real estate, etc ->generateAndSave('output/certificate.csr', 'output/private.pem'); echo "Certificate and private key saved.\n"; } catch (CertificateBuilderException $e) { echo "Error: " . $e->getMessage() . "\n"; exit(1); } ``` ### πŸ” **2. Requesting a Compliance Certificate from ZATCA** [](#-2-requesting-a-compliance-certificate-from-zatca) Once the CSR is generated, you need to request a **compliance certificate** from **ZATCA's API**. ``` use GuzzleHttp\Client; use Sevaske\ZatcaApi\Api; use Sevaske\ZatcaApi\Exceptions\ZatcaException; $api = new Api('sandbox', new Client); $certificatePath = __DIR__.'/output/certificate.csr'; $csr = file_get_contents($certificatePath); try { $response = $api->complianceCertificate($csr, '123123'); $credentials = [ 'requestId' => $response->requestId(), 'certificate' => $response->certificate(), 'secret' => $response->secret(), ]; print_r($credentials); // sava file output/ZATCA_certificate_data.json $outputFile = __DIR__.'/output/ZATCA_certificate_data.json'; file_put_contents($outputFile, json_encode($credentials, JSON_PRETTY_PRINT)); echo "\nCertificate data saved to {$outputFile}\n"; } catch (ZatcaException $e) { echo 'API Error: '.$e->getMessage()."\n"; print_r($e->context()); } catch (\Exception $e) { echo 'Error: '.$e->getMessage(); } ``` ### 🧾 **3. Generating and signing an Invoice XML** [](#-3-generating-and-signing-an-invoice-xml) Now that we have the compliance certificate, we can generate a **ZATCA-compliant e-invoice in XML format**. Example of the simplified invoice: ``` use Saleh7\Zatca\GeneratorInvoice; use Saleh7\Zatca\Helpers\Certificate; use Saleh7\Zatca\InvoiceSigner; use Saleh7\Zatca\Mappers\InvoiceMapper; $invoiceData = [ 'uuid' => 'b51bd500-9081-4acf-9ae4-c266d569cb77', 'id' => '111222333', 'issueDate' => date('Y-m-d H:i:s'), 'issueTime' => date('Y-m-d H:i:s'), 'delivery' => [ 'actualDeliveryDate' => date('Y-m-d H:i:s'), ], 'currencyCode' => 'SAR', 'taxCurrencyCode' => 'SAR', 'note' => 'Tax ID is 333333333333333 because a customer didnt provide it.', 'languageID' => 'en', 'invoiceType' => [ 'invoice' => 'simplified', 'type' => 'invoice', 'isThirdParty' => false, 'isNominal' => false, 'isExport' => false, 'isSummary' => false, 'isSelfBilled' => false, ], 'additionalDocuments' => [ [ 'id' => 'ICV', 'uuid' => '1', // counter value ], [ 'id' => 'PIH', 'attachment' => [ 'content' => 'MA==', // previous hash ], ], ], 'supplier' => [ 'registrationName' => 'My company name', 'taxId' => '311111111111113', 'identificationId' => '1111111111', // my company CRN 'identificationType' => 'CRN', 'address' => [ 'street' => 'company street name', 'buildingNumber' => '8008', 'subdivision' => 'sub', 'city' => 'Riyadh', 'postalZone' => '12345', 'country' => 'SA', ], ], 'customer' => [ 'registrationName' => 'Naruto Uzumaki', 'taxId' => '333333333333333', 'address' => [ 'street' => 'Al Urubah Road', 'buildingNumber' => '7176', 'subdivision' => 'Al Olaya', 'city' => 'Riyadh', 'postalZone' => '12251', 'country' => 'SA', ], ], 'paymentMeans' => [ 'code' => '10', // cash ], 'allowanceCharges' => [ [ 'isCharge' => false, 'reason' => 'discount', 'amount' => 0.0, 'taxCategories' => [ 0 => [ 'percent' => 15, 'taxScheme' => [ 'id' => 'VAT', ], ], ], ], ], 'taxTotal' => [ 'taxAmount' => 6.86, 'subTotals' => [ 0 => [ 'taxableAmount' => 45.75, 'taxAmount' => 6.86, 'taxCategory' => [ 'percent' => 15, 'taxScheme' => [ 'id' => 'VAT', ], ], ], ], ], 'legalMonetaryTotal' => [ 'lineExtensionAmount' => 45.75, 'taxExclusiveAmount' => 45.75, 'taxInclusiveAmount' => 52.61, 'prepaidAmount' => 0, 'payableAmount' => 52.61, 'allowanceTotalAmount' => 0.0, ], 'invoiceLines' => [ [ 'id' => 1, 'unitCode' => 'PCE', 'quantity' => 1, 'lineExtensionAmount' => 20.75, 'item' => [ 'name' => 'My product', 'classifiedTaxCategory' => [ 0 => [ 'percent' => 15.0, 'taxScheme' => [ 'id' => 'VAT', ], ], ], ], 'price' => [ 'amount' => 20.75, 'unitCode' => 'UNIT', 'allowanceCharges' => [ 0 => [ 'isCharge' => false, 'reason' => 'discount', 'amount' => 0.0, ], ], ], 'taxTotal' => [ 'taxAmount' => 3.11, 'roundingAmount' => 23.86, ], ], [ 'id' => 2, 'unitCode' => 'C62', 'quantity' => 1, 'lineExtensionAmount' => 25.0, 'item' => [ 'name' => 'My another product', 'classifiedTaxCategory' => [ 0 => [ 'percent' => 15.0, 'taxScheme' => [ 'id' => 'VAT', ], ], ], ], 'price' => [ 'amount' => '25.00', 'unitCode' => 'UNIT', 'allowanceCharges' => [ 0 => [ 'isCharge' => false, 'reason' => 'discount', 'amount' => 0.0, ], ], ], 'taxTotal' => [ 'taxAmount' => 3.75, 'roundingAmount' => 28.75, ], ], ], ]; // Map the data to an Invoice object $invoiceMapper = new InvoiceMapper; $invoice = $invoiceMapper->mapToInvoice($invoiceData); // Generate the invoice XML $generatorInvoice = GeneratorInvoice::invoice($invoice); // sign the invoice XML with the certificate $certificate = (new Certificate( 'MIID3jCCA4SgAwIBAgITEQAAOAPF90Ajs/xcXwABAAA4AzAKBggqhkjOPQQDAjBiMRUwEwYKCZImiZPyLGQBGRYFbG9jYWwxEzARBgoJkiaJk/IsZAEZFgNnb3YxFzAVBgoJkiaJk/IsZAEZFgdleHRnYXp0MRswGQYDVQQDExJQUlpFSU5WT0lDRVNDQTQtQ0EwHhcNMjQwMTExMDkxOTMwWhcNMjkwMTA5MDkxOTMwWjB1MQswCQYDVQQGEwJTQTEmMCQGA1UEChMdTWF4aW11bSBTcGVlZCBUZWNoIFN1cHBseSBMVEQxFjAUBgNVBAsTDVJpeWFkaCBCcmFuY2gxJjAkBgNVBAMTHVRTVC04ODY0MzExNDUtMzk5OTk5OTk5OTAwMDAzMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEoWCKa0Sa9FIErTOv0uAkC1VIKXxU9nPpx2vlf4yhMejy8c02XJblDq7tPydo8mq0ahOMmNo8gwni7Xt1KT9UeKOCAgcwggIDMIGtBgNVHREEgaUwgaKkgZ8wgZwxOzA5BgNVBAQMMjEtVFNUfDItVFNUfDMtZWQyMmYxZDgtZTZhMi0xMTE4LTliNTgtZDlhOGYxMWU0NDVmMR8wHQYKCZImiZPyLGQBAQwPMzk5OTk5OTk5OTAwMDAzMQ0wCwYDVQQMDAQxMTAwMREwDwYDVQQaDAhSUlJEMjkyOTEaMBgGA1UEDwwRU3VwcGx5IGFjdGl2aXRpZXMwHQYDVR0OBBYEFEX+YvmmtnYoDf9BGbKo7ocTKYK1MB8GA1UdIwQYMBaAFJvKqqLtmqwskIFzVvpP2PxT+9NnMHsGCCsGAQUFBwEBBG8wbTBrBggrBgEFBQcwAoZfaHR0cDovL2FpYTQuemF0Y2EuZ292LnNhL0NlcnRFbnJvbGwvUFJaRUludm9pY2VTQ0E0LmV4dGdhenQuZ292LmxvY2FsX1BSWkVJTlZPSUNFU0NBNC1DQSgxKS5jcnQwDgYDVR0PAQH/BAQDAgeAMDwGCSsGAQQBgjcVBwQvMC0GJSsGAQQBgjcVCIGGqB2E0PsShu2dJIfO+xnTwFVmh/qlZYXZhD4CAWQCARIwHQYDVR0lBBYwFAYIKwYBBQUHAwMGCCsGAQUFBwMCMCcGCSsGAQQBgjcVCgQaMBgwCgYIKwYBBQUHAwMwCgYIKwYBBQUHAwIwCgYIKoZIzj0EAwIDSAAwRQIhALE/ichmnWXCUKUbca3yci8oqwaLvFdHVjQrveI9uqAbAiA9hC4M8jgMBADPSzmd2uiPJA6gKR3LE03U75eqbC/rXA==', 'MHQCAQEEIL14JV+5nr/sE8Sppaf2IySovrhVBtt8+yz+g4NRKyz8oAcGBSuBBAAKoUQDQgAEoWCKa0Sa9FIErTOv0uAkC1VIKXxU9nPpx2vlf4yhMejy8c02XJblDq7tPydo8mq0ahOMmNo8gwni7Xt1KT9UeA==', 'secret' )); $signedInvoice = InvoiceSigner::signInvoice($generatorInvoice->getXML(), $certificate); $outputXML = GeneratorInvoice::invoice($invoice)->saveXMLFile('Simplified_Invoice.xml'); echo "Simplified Invoice Generated Successfully\n"; $signedInvoice->saveXMLFile('Simplified_Invoice_Signed.xml'); echo "Simplified Invoice Signed Successfully\n"; ``` Other examples you can find in the ./examples folder. ### πŸ“€ **5. Submitting the Signed Invoice to ZATCA** [](#-5-submitting-the-signed-invoice-to-zatca) Once the invoice is **digitally signed**, it can be submitted to **ZATCA’s API** for compliance validation and clearance. Contributing ------------ [](#contributing) Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. License ------- [](#license) This project is licensed under the [MIT License](LICENSE). ### Health Score 49 β€” FairBetter than 95% of packages Maintenance80 Actively maintained with recent releases Popularity34 Limited adoption so far Community19 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 52.3% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~11 days Recently: every ~3 days Total 20 Last Release 96d ago Major Versions v3.4.5 β†’ v4.0.0-beta2026-01-28 ### Community Maintainers ![](https://www.gravatar.com/avatar/94643c38672a39a9b675ab6d43f5c1d3c0789300cc052f742a960e0a7d70847e?d=identicon)[sevaske](/maintainers/sevaske) --- Top Contributors [![Saleh7](https://avatars.githubusercontent.com/u/5176469?v=4)](https://github.com/Saleh7 "Saleh7 (56 commits)")[![sevaske](https://avatars.githubusercontent.com/u/42838184?v=4)](https://github.com/sevaske "sevaske (44 commits)")[![MuneebStack](https://avatars.githubusercontent.com/u/133972442?v=4)](https://github.com/MuneebStack "MuneebStack (4 commits)")[![SohaibSEG](https://avatars.githubusercontent.com/u/61911926?v=4)](https://github.com/SohaibSEG "SohaibSEG (3 commits)") --- Tags qr codexmlinvoiceE-Invoiceublinvoiceelectronic invoicexml invoiceubl invoicedigital invoiceZATCAzatca-xmlfatoora ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/sevaske-php-zatca-xml/health.svg) ``` [![Health](https://phpackages.com/badges/sevaske-php-zatca-xml/health.svg)](https://phpackages.com/packages/sevaske-php-zatca-xml) ``` ### Alternatives [saleh7/php-zatca-xml An unofficial PHP library for generating ZATCA Fatoora e-invoices. This library facilitates the creation of compliant e-invoices, QR Codes, and certificates, as well as the submission of e-invoices to ZATCA's servers. It provides developers with an easy-to-use, customizable, and robust toolkit to integrate and automate ZATCA e-invoicing processes in PHP applications. 5112.5k](/packages/saleh7-php-zatca-xml)[num-num/ubl-invoice A modern object-oriented PHP library to create and read valid UBL and EN 16931/Peppol BIS 3.0 files 135820.5k](/packages/num-num-ubl-invoice)[cleverit/ubl_invoice A PHP wrapper for UBL invoices 36283.4k](/packages/cleverit-ubl-invoice)[atgp/factur-x PHP library to manage your Factur-X / ZUGFeRD 2.0 PDF invoices files 138825.5k3](/packages/atgp-factur-x)[superfaktura/apiclient Api client for SuperFaktura | online invoicing tool 19133.3k](/packages/superfaktura-apiclient) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)