encapuk/helloxero

Purpose and Platform

Encap_HelloXero is a Magento 2.4.x module that exports selected Magento sales orders as Xero-importable CSV. It runs inside Magento’s PHP module framework; output is a browser-downloaded file rather than a direct Xero API integration.

Module Registration and Routing

Magento discovers and enables the module through app/code/Encap/HelloXero/registration.php and app/code/Encap/HelloXero/etc/module.xml. Separate frontend and admin route declarations define request namespaces:

• app/code/Encap/HelloXero/etc/adminhtml/routes.xml

• app/code/Encap/HelloXero/etc/frontend/routes.xml

Primary Admin Export Flow

The architecturally central workflow begins on Magento Admin Sales Orders. The order-grid UI component adds a “XERO CSV” mass action via app/code/Encap/HelloXero/view/adminhtml/ui_component/sales_order_grid.xml. Selected order IDs are submitted to app/code/Encap/HelloXero/Controller/Adminhtml/Export/Csv.php.

That admin controller is the core integration boundary: it loads/order-processes Magento order data, transforms it into Xero CSV rows, applies accounting defaults and VAT rules, and returns a CSV download response.

Xero CSV Transformation Rules

app/code/Encap/HelloXero/Controller/Adminhtml/Export/Csv.php owns the export schema and business mapping, including static Xero values such as currency, account code, and tax type. Its documented tax behavior defaults to “20% (VAT on Income)” but selects “No VAT” for international shipping descriptions containing Int or customer group 5. Invoice numbers remain a post-export/manual Xero sequencing concern.

Frontend Demonstration Surface

The module also contains a frontend route and page flow, distinct from the admin mass export:

• app/code/Encap/HelloXero/Controller/Index/Index.php

• app/code/Encap/HelloXero/view/frontend/layout/helloworld_index_index.xml

• app/code/Encap/HelloXero/view/frontend/templates/helloxero.phtml

app/code/Encap/HelloXero/Controller/Index/ExportCsv.php provides a frontend CSV-export endpoint. app/code/Encap/HelloXero/Block/Helloxero.php is the presentation-layer block for the frontend page.

Runtime and External Boundaries

Execution depends on Magento’s PHP runtime, sales-order domain models, admin grid/mass-action UI framework, routing/controller dispatch, and file-download response mechanisms. Xero is not called at runtime: CSV is the integration contract, and users import the generated file into Xero externally.