Setup, permissions and settings

Enable credit-note e-Invoice email attachments

This guide explains and test the supplied credit-note attachment hook before production use.

Audience: CRM staffPermission: AdministratorModule v1.0.0
Jump to steps
Where to goAdmin Area → Setup → Settings → Finance → e-Invoice
Before you start
  • Use an authorised account and confirm the source CRM record or setting is correct.
  • Follow the exact route shown above; do not force database values to imitate a completed action.

What this guide helps you do

Understand and test the supplied credit-note attachment hook before production use. These instructions follow the supplied module’s live hooks, controller, model, view and validation flow.

Follow these steps

  1. Select a default credit-note template.
  2. Set Send e-Invoice as credit note email attachment to Yes.
  3. Send a controlled test credit note.
  4. Check every placeholder and output value before enabling broadly.

Fields and options

Action scopeUnderstand and test the supplied credit-note attachment hook before production use.
Module version1.0.0
NavigationAdmin Area → Setup → Settings → Finance → e-Invoice
EvidenceVerify the stored record, status, output, email, event or log produced by the code path.

Rules and limits

  • The hook runs before_credit_note_sent_to_client and uses the formatted credit-note number for the filename.
  • The supplied code constructs Data\Invoice with the credit-note object instead of Data\CreditNote; this is a verified implementation defect and may produce incorrect output or fail depending on object fields.

Check it worked

  • The requested record, output or setting is created or updated through the supported module flow.
  • Any related status, count, email, audit/event, PDF/file or queue evidence agrees with the source action.
  • An error message is investigated rather than bypassed.

Security, privacy and operational checks

  • Apply least privilege and verify the correct customer, lead, sales document or recipient before processing.
  • Protect public tokens, recipient data, IP/browser evidence, templates and exported files according to organisational policy.
  • Test configuration changes with controlled records before production-wide use.
  • Retain or delete evidence only under an authorised retention process.
Important code-backed limitationDo not enable credit-note email attachment in production until a controlled test confirms the supplied version produces the required data, or the module code is corrected.