invoices — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| Module id | invoices |
| Name | Invoices |
| Version | 2.0.0 |
| Ships from | @endora-commerce/mod-invoices |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting invoices.enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|---|---|
_i18n | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
admin_roles | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
assets_library | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
customer_accounts | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
document_templates | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
orders | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
organizations | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
transactional_emails | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
invoice_ledger | no | degrades-without invoiceLedgerRoutingPort — Issuance stays Endora-numbered and ready; mode B wait is ignored. |
payments | no | degrades-without paymentReadPort — An issued invoice records as paid the order's stored total when the order is paid, and nothing otherwise. |
returns | no | degrades-without returnRefundReadPort — An issued invoice deducts from what was paid only the refunds the payments module recorded; a return refunded by hand or credited to the credit limit is not deducted. |
Permissions
| Code | Label | Also needs |
|---|---|---|
invoices:read | View invoices and download invoice PDFs | — |
invoices:write | Issue/correct invoices and configure invoicing | — |
Command palette
| Action | Opens | Permission |
|---|---|---|
open-invoices | /invoices | invoices:read |
Settings
| Code | Name | Type |
|---|---|---|
invoices.auto_issue.trigger_status | Auto-issue on order status | string |
invoices.document_templates_grant_done | Document template access granted | boolean |
invoices.email.delivery_mode | Invoice email delivery mode | string |
invoices.email.send_on_issue | Email invoice on issue | boolean |
invoices.enabled | Invoices enabled | boolean |
invoices.numbering.correction.pattern | Correction numbering pattern | string |
invoices.numbering.invoice.pattern | Invoice numbering pattern | string |
invoices.numbering.proforma.pattern | Proforma numbering pattern | string |
invoices.seller.company_data | Seller company data | json |
invoices.seller.tax_id | Seller VAT / NIP | string |
invoices.storefront_base_url | Storefront base URL (for invoice email links) | string |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.