Technical architecture, tables and endpoint reference
This section maps all module-owned tables, controller endpoints, transactions, tenant keys and host integrations without instructing direct database edits.
Understand the POS controller architecture
Understand the POS controller architectureMap Britixo_pos, Pos_shop, Api_v1 and the compatibility controller.
Open guide →GuideUnderstand the model and service responsibilities
Understand the model and service responsibilitiesSeparate persistence/integration operations from cart/order calculation and commit logic.
Open guide →GuideUnderstand tenant keys
Understand tenant keysKnow how bpos_tenant_key identifies the current SaaS tenant.
Open guide →GuideUnderstand database transaction boundaries
Understand database transaction boundariesKnow order, stock, purchase, shift and return writes are committed or rolled back together.
Open guide →GuideUnderstand immutable order snapshots
Understand immutable order snapshotsKnow line/customer/money values are retained independently of later catalogue changes.
Open guide →GuideUnderstand correlation IDs
Understand correlation IDsTrace related audit, inventory, order and webhook records.
Open guide →GuideUnderstand host invoice integration
Understand host invoice integrationLink native invoices through invoice_id and payment hooks without changing core invoice tables.
Open guide →GuideUnderstand host email integration
Understand host email integrationUse create_email_template and the host mail classes/SMTP.
Open guide →GuideUnderstand host menu and capability hooks
Understand host menu and capability hooksUse admin_init, clients_init and registered staff capabilities.
Open guide →GuideUnderstand cron and payment hooks
Understand cron and payment hooksUse after_cron_run and payment add/update/delete events.
Open guide →GuideUnderstand the categories table
Understand the categories tableMap the module-owned categories records without editing them directly.
Open guide →GuideUnderstand the locations table
Understand the locations tableMap the module-owned locations records without editing them directly.
Open guide →GuideUnderstand the registers table
Understand the registers tableMap the module-owned registers records without editing them directly.
Open guide →GuideUnderstand the shifts table
Understand the shifts tableMap the module-owned shifts records without editing them directly.
Open guide →GuideUnderstand the products table
Understand the products tableMap the module-owned products records without editing them directly.
Open guide →GuideUnderstand the stock table
Understand the stock tableMap the module-owned stock records without editing them directly.
Open guide →GuideUnderstand the inventory_movements table
Understand the inventory_movements tableMap the module-owned inventory_movements records without editing them directly.
Open guide →GuideUnderstand the orders table
Understand the orders tableMap the module-owned orders records without editing them directly.
Open guide →GuideUnderstand the order_lines table
Understand the order_lines tableMap the module-owned order_lines records without editing them directly.
Open guide →GuideUnderstand the payments table
Understand the payments tableMap the module-owned payments records without editing them directly.
Open guide →GuideUnderstand the returns table
Understand the returns tableMap the module-owned returns records without editing them directly.
Open guide →GuideUnderstand the return_lines table
Understand the return_lines tableMap the module-owned return_lines records without editing them directly.
Open guide →GuideUnderstand the suppliers table
Understand the suppliers tableMap the module-owned suppliers records without editing them directly.
Open guide →GuideUnderstand the purchases table
Understand the purchases tableMap the module-owned purchases records without editing them directly.
Open guide →GuideUnderstand the purchase_lines table
Understand the purchase_lines tableMap the module-owned purchase_lines records without editing them directly.
Open guide →GuideUnderstand the promotions table
Understand the promotions tableMap the module-owned promotions records without editing them directly.
Open guide →GuideUnderstand the gift_cards table
Understand the gift_cards tableMap the module-owned gift_cards records without editing them directly.
Open guide →GuideUnderstand the gift_ledger table
Understand the gift_ledger tableMap the module-owned gift_ledger records without editing them directly.
Open guide →GuideUnderstand the digital_entitlements table
Understand the digital_entitlements tableMap the module-owned digital_entitlements records without editing them directly.
Open guide →GuideUnderstand the audit_events table
Understand the audit_events tableMap the module-owned audit_events records without editing them directly.
Open guide →GuideUnderstand the idempotency table
Understand the idempotency tableMap the module-owned idempotency records without editing them directly.
Open guide →GuideUnderstand the api_keys table
Understand the api_keys tableMap the module-owned api_keys records without editing them directly.
Open guide →GuideUnderstand the webhooks table
Understand the webhooks tableMap the module-owned webhooks records without editing them directly.
Open guide →GuideUnderstand the webhook_deliveries table
Understand the webhook_deliveries tableMap the module-owned webhook_deliveries records without editing them directly.
Open guide →GuideUnderstand the rate_limits table
Understand the rate_limits tableMap the module-owned rate_limits records without editing them directly.
Open guide →GuidePOS administrator endpoint reference
POS administrator endpoint referenceMap every live Britixo_pos controller method and capability gate.
Open guide →GuidePOS public endpoint reference
POS public endpoint referenceMap every live Pos_shop route.
Open guide →GuidePOS API endpoint reference
POS API endpoint referenceMap every live read-only Api_v1 route and scope.
Open guide →GuideUnderstand the OpenAPI document
Understand the OpenAPI documentUse docs/openapi.yaml as the supplied read-only API contract and verify it against routes.
Open guide →GuideUnderstand module release audit evidence
Understand module release audit evidenceUse docs/RELEASE-AUDIT.md and archive hashes as package evidence.
Open guide →GuideUnderstand compatibility controller behaviour
Understand compatibility controller behaviourKnow Britixo_enterprise_pos.php is present alongside the active Britixo_pos controller naming convention.
Open guide →GuideUnderstand data retention boundaries
Understand data retention boundariesPreserve module data on deactivation and plan any deletion as a separately authorised process.
Open guide →