How erpgulf/zatca_erpgulf works
This Frappe ERPNext app connects Sales Invoice and POS Invoice submission to ZATCA Phase-2 processing. The documented workflow covers compliance checks, invoice preparation and signing, then clearance or reporting; POS has a parallel path. CSR/certificate setup, QR/XML handling, event logs, settings, dashboards, and comparison/status reports support that workflow. Hooks and selected source excerpts establish only some runtime links; other subsystem relationships are left unconnected where source evidence is incomplete.
Main entry points: sign_invoice.py Sales signing and submission · hooks.py Sales invoice hook · pos_sign.py POS signing and submission · sign_invoice_first.py CSR and certificates
Components 23
ERPNext entry points
- Sales Invoice
- POS Invoice
- Sales invoice hook
zatca_erpgulf/hooks.py
Compliance preparation
- Invoice validation
zatca_erpgulf/zatca_erpgulf/validations.py - Tax validation
zatca_erpgulf/zatca_erpgulf/tax_error.py - Sales invoice XML
zatca_erpgulf/zatca_erpgulf/createxml.py - XML tax data
zatca_erpgulf/zatca_erpgulf/xml_tax_data.py - UBL XML assembly
zatca_erpgulf/zatca_erpgulf/create_xml_final_part.py - POS XML
zatca_erpgulf/zatca_erpgulf/posxml.py
Signing and submission
- Sales signing and submission
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - POS signing and submission
zatca_erpgulf/zatca_erpgulf/pos_sign.py - POS background jobs
zatca_erpgulf/zatca_erpgulf/pos_schedule_background.py - QR generation
zatca_erpgulf/zatca_erpgulf/create_qr.py - Invoice XML and QR
zatca_erpgulf/zatca_erpgulf/sales_invoice_with_xmlqr.py
Configuration and operations
- CSR and certificates
zatca_erpgulf/zatca_erpgulf/sign_invoice_first.py - Company settings
zatca_erpgulf/zatca_erpgulf/doctype/zatca_erpgulf_setting/zatca_erpgulf_setting.py - Multiple settings
zatca_erpgulf/zatca_erpgulf/doctype/zatca_multiple_setting/zatca_multiple_setting.py - Scheduled submission
zatca_erpgulf/zatca_erpgulf/scheduler_event.py
Monitoring and reports
- Event logging
zatca_erpgulf/zatca_erpgulf/event_log.py - ZATCA dashboard
zatca_erpgulf/zatca_erpgulf/page/zatca_dashboard/zatca_dashboard.js - Status and comparison reports
zatca_erpgulf/zatca_erpgulf/report
Other components
- ERPNext user
- ZATCA services
Connections 22
- ERPNext user → Sales Invoice: creates or submits
README.md - ERPNext user → POS Invoice: creates or submits
README.md - Sales Invoice → Sales invoice hook: on submit
zatca_erpgulf/hooks.py - POS Invoice → POS signing and submission: on submit
- Sales invoice hook → Sales signing and submission: dispatches to
zatca_erpgulf/hooks.py - Sales invoice hook → Invoice validation: validates
zatca_erpgulf/hooks.py - Sales invoice hook → Tax validation: validates tax
zatca_erpgulf/hooks.py - Sales signing and submission → ZATCA services: requests clearance or reporting
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - POS signing and submission → ZATCA services: requests clearance
zatca_erpgulf/zatca_erpgulf/pos_sign.py - CSR and certificates → ZATCA services: requests production credentials
zatca_erpgulf/zatca_erpgulf/sign_invoice_first.py - Sales signing and submission → Event logging: logs outcomes
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - POS signing and submission → Event logging: logs outcomes
zatca_erpgulf/zatca_erpgulf/pos_sign.py - Scheduled submission → Sales signing and submission: submits in background
- Scheduled submission → POS background jobs: submits in background
- Sales signing and submission → Sales invoice XML: prepares invoice XML
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - Sales invoice XML → XML tax data: uses tax data
- Sales signing and submission → UBL XML assembly: assembles XML
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - POS signing and submission → POS XML: prepares POS XML
zatca_erpgulf/zatca_erpgulf/pos_sign.py - Sales signing and submission → QR generation: creates QR
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - Sales signing and submission → Invoice XML and QR: attaches returned XML
zatca_erpgulf/zatca_erpgulf/sign_invoice.py - Company settings → CSR and certificates: provides certificate settings
- Multiple settings → CSR and certificates: provides certificate settings