Skip to main content

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 idinvoices
NameInvoices
Version2.0.0
Ships from@endora-commerce/mod-invoices
LicenceMIT

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​

ModuleBindingWhat it means
_i18nyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
admin_rolesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
assets_libraryyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
authyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
customer_accountsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
document_templatesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
ordersyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
organizationsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
settingsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
transactional_emailsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
invoice_ledgernodegrades-without invoiceLedgerRoutingPort — Issuance stays Endora-numbered and ready; mode B wait is ignored.
paymentsnodegrades-without paymentReadPort — An issued invoice records as paid the order's stored total when the order is paid, and nothing otherwise.
returnsnodegrades-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​

CodeLabelAlso needs
invoices:readView invoices and download invoice PDFs—
invoices:writeIssue/correct invoices and configure invoicing—

Command palette​

ActionOpensPermission
open-invoices/invoicesinvoices:read

Settings​

CodeNameType
invoices.auto_issue.trigger_statusAuto-issue on order statusstring
invoices.document_templates_grant_doneDocument template access grantedboolean
invoices.email.delivery_modeInvoice email delivery modestring
invoices.email.send_on_issueEmail invoice on issueboolean
invoices.enabledInvoices enabledboolean
invoices.numbering.correction.patternCorrection numbering patternstring
invoices.numbering.invoice.patternInvoice numbering patternstring
invoices.numbering.proforma.patternProforma numbering patternstring
invoices.seller.company_dataSeller company datajson
invoices.seller.tax_idSeller VAT / NIPstring
invoices.storefront_base_urlStorefront base URL (for invoice email links)string

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

None.