How beveren-software-inc/zatca_integration works
This ERPNext app provides Saudi ZATCA Phase 2 e-invoicing: it prepares standard B2B and simplified B2C invoices, generates and signs compliant XML, submits invoices for clearance or reporting, and tracks responses. Company administrators also configure ZATCA environments and credentials; invoice data validation, VAT reporting, and compliant PDF/QR output support the main workflow. The README documents these capabilities, while the excerpts show key submission, signing, and validation relationships. Several listed subsystems were not sampled, so their internal links are omitted.
Main entry points: sales_invoice.js Sales Invoice · clearence_util.py ZATCA Submission · compliance_csid.py Compliance CSID · final_invoice_signing.py Invoice Signing
Components 18
Invoice Workflow
- Sales Invoice
zatca_integration/public/js/sales_invoice.js - Invoice Validation
zatca_integration/common_util.py - Invoice XML
zatca_integration/saudi_arabia_electronic_invoicing/signing_engine/generate_invoice_xml.py - Invoice Signing
zatca_integration/saudi_arabia_electronic_invoicing/signing_engine/final_invoice_signing.py - ZATCA Submission
zatca_integration/clearence_util.py - ZATCA Portal
- Submission Audit
zatca_integration/saudi_arabia_electronic_invoicing/doctype/zatca_transactions/zatca_transactions.py
ZATCA Setup
- CSR Settings
zatca_integration/saudi_arabia_electronic_invoicing/doctype/zatca_csr_settings/zatca_csr_settings.py - Compliance CSID
zatca_integration/saudi_arabia_electronic_invoicing/doctype/compliance_csid/compliance_csid.py - Production CSID
zatca_integration/saudi_arabia_electronic_invoicing/doctype/production_csid/production_csid.py - Environment Settings
zatca_integration/saudi_arabia_electronic_invoicing/doctype/zatca_environment/zatca_environment.py
Tax Compliance
- VAT Setup
zatca_integration/saudi_arabia_electronic_invoicing/vat_setup.py - VAT Reports
zatca_integration/saudi_arabia_electronic_invoicing/report/zatca_vat/zatca_vat.py - VAT Return
zatca_integration/saudi_arabia_electronic_invoicing/zatca_vat_return_api.py - Party Validation
zatca_integration/overrides/address.py
Invoice Outputs
- Invoice PDF
zatca_integration/customization/sales_invoice/generate_pdf_3a_convertapi.py - QR Generation
zatca_integration/saudi_arabia_electronic_invoicing/temp_qr_generator.py
Other components
- ERPNext User
Connections 19
- ERPNext User → Sales Invoice: creates invoice
README.md - Sales Invoice → Invoice Validation: validates data
- Sales Invoice → Invoice XML: starts submission
- Invoice Signing → Invoice XML: builds signed XML
zatca_integration/saudi_arabia_electronic_invoicing/signing_engine/final_invoice_signing.py - ZATCA Submission → Invoice Signing: invokes signing
zatca_integration/clearence_util.py - ZATCA Submission → ZATCA Portal: submits invoice
zatca_integration/clearence_util.py - ZATCA Portal → ZATCA Submission: returns response
zatca_integration/clearence_util.py - ZATCA Submission → Submission Audit: tracks status
- ERPNext User → CSR Settings: configures credentials
README.md - CSR Settings → Compliance CSID: creates compliance CSID
README.md - Compliance CSID → ZATCA Portal: requests CSID
zatca_integration/saudi_arabia_electronic_invoicing/doctype/compliance_csid/compliance_csid.py - Compliance CSID → Production CSID: generates production CSID
README.md - Environment Settings → ZATCA Submission: selects endpoint
- ERPNext User → VAT Setup: sets up VAT
README.md - VAT Reports → ERPNext User: presents reports
README.md - VAT Return → ZATCA Portal: supports filing
- Party Validation → Invoice Validation: checks party data
zatca_integration/overrides/address.py - Sales Invoice → Invoice PDF: produces PDF
README.md - Sales Invoice → QR Generation: generates QR
README.md