How ipconnex-services/canada-compliance-erpnext works
Canada Business Compliance is a Frappe/ERPNext app that configures Canadian sales and purchase tax, then selects and applies tax templates to business documents. Administrators configure each company, create payable accounts and generate province-specific templates and rules; runtime logic resolves the relevant province and template, while document-form logic handles exemptions and zero-rated items. The app also normalizes province names, synchronizes customer territories, provides tax-rate lookup, and supplies a tax-invoice format. Some subsystem links are based on README documentation because their implementation was not sampled.
Main entry points: ca_company_tax_config.py Config fields · province.py Province normalization · tax_resolver.py Sales tax resolver · ca_sales_tax.js Sales form tax rules
Components 18
Company configuration
- Company tax config
canada_business_compliance/ca_sales_tax/doctype/ca_company_tax_config/ca_company_tax_config.js - Config fields
canada_business_compliance/ca_sales_tax/doctype/ca_company_tax_config/ca_company_tax_config.py
Tax setup
- Tax accounts
canada_business_compliance/utils/setup_taxes.py - Templates and rules
canada_business_compliance/utils/setup_taxes.py - ERPNext tax records
Tax resolution
- Province normalization
canada_business_compliance/utils/province.py - Sales tax resolver
canada_business_compliance/utils/tax_resolver.py - Purchase destination resolver
canada_business_compliance/utils/tax_resolver.py - ERPNext addresses
Document application
- Sales form tax rules
canada_business_compliance/public/js/ca_sales_tax.js
Compliance support
- Customer territory sync
canada_business_compliance/utils/territory.py - Province tax lookup
canada_business_compliance/utils/tax_calculator.py - Compliance fields
canada_business_compliance/utils/custom_fields.py - Address form behavior
canada_business_compliance/public/js/ca_address.js - CA tax invoice
canada_business_compliance/ca_sales_tax/print_format/ca_tax_invoice/ca_tax_invoice.json
Other components
- ERPNext administrator
- Sales documents
- Purchase documents
Connections 27
- ERPNext administrator → Company tax config: configures company
README.md - Company tax config → Config fields: edits config
canada_business_compliance/ca_sales_tax/doctype/ca_company_tax_config/ca_company_tax_config.js - ERPNext administrator → Tax accounts: creates accounts
README.md - ERPNext administrator → Templates and rules: generates rules
README.md - Tax accounts → Config fields: saves account links
canada_business_compliance/utils/setup_taxes.py - Tax accounts → ERPNext tax records: creates accounts
canada_business_compliance/utils/setup_taxes.py - Templates and rules → ERPNext tax records: creates templates and rules
README.md - Templates and rules → Province normalization: normalizes province
canada_business_compliance/utils/setup_taxes.py - Sales documents → Sales tax resolver: selects sales tax
- Purchase documents → Purchase destination resolver: selects purchase tax
- Sales tax resolver → Province normalization: normalizes location
canada_business_compliance/utils/tax_resolver.py - Purchase destination resolver → Province normalization: normalizes destination
canada_business_compliance/utils/tax_resolver.py - Sales tax resolver → ERPNext addresses: reads address state
canada_business_compliance/utils/tax_resolver.py - Purchase destination resolver → ERPNext addresses: checks delivery location
canada_business_compliance/utils/tax_resolver.py - Sales tax resolver → ERPNext tax records: finds sales template
canada_business_compliance/utils/tax_resolver.py - Purchase destination resolver → ERPNext tax records: finds purchase template
canada_business_compliance/utils/tax_resolver.py - Sales documents → Sales form tax rules: runs form rules
- Sales form tax rules → ERPNext addresses: reads address state
canada_business_compliance/public/js/ca_sales_tax.js - Sales form tax rules → Config fields: loads company settings
README.md - Sales form tax rules → Sales documents: updates tax rows
canada_business_compliance/public/js/ca_sales_tax.js - Province tax lookup → Province normalization: uses province mapping
canada_business_compliance/utils/tax_calculator.py - Province tax lookup → ERPNext tax records: reads tax templates
canada_business_compliance/utils/tax_calculator.py - Customer territory sync → Province normalization: normalizes address state
canada_business_compliance/utils/territory.py - Customer territory sync → ERPNext addresses: reads linked address
canada_business_compliance/utils/territory.py - Compliance fields → Config fields: adds compliance fields
- Address form behavior → ERPNext addresses: uses address state
- CA tax invoice → Config fields: prints registration details
README.md