e-Invoice — How to Install

← Back to e-Invoice overview

How to Install — e-Invoice

Module folder: modules/einvoice/   Version: v1.0.0

Default module for e-Invoice

Before you begin

• Backup your database (Setup → Backup or your host backup tool).
• Use a staff account with Modules / Settings access.
• PHP version and Perfex CRM version should match the module README requirements when listed.
• Keep the module folder name exactly einvoice.

Step-by-step installation

1. Upload the einvoice folder into your CRM modules/ directory (FTP, cPanel, or Setup → Modules → Upload when available).
2. Log in to Admin.
3. Go to Setup → Modules.
4. Find e-Invoice and click Activate (or Upgrade if already installed).
5. Wait for migrations/tables to finish — do not refresh mid-activation.
6. Go to Setup → Staff → Roles and assign permissions for this module.
7. Open e-Invoice → Settings and save defaults.

Install notes from README

Setup

1. Activate e-Invoice under Setup → Modules.
2. Configure templates and defaults under Setup → Settings → e-Invoice.
3. (Optional) Build CodeMirror assets if developing the editor:

cd modules/einvoice
npm install

Verify installation (checklist)

1. Setup → Modules shows e-Invoice as Active.
2. Admin sidebar shows the e-Invoice menu for an admin user.
3. Setup → Staff → Roles lists this module's permission groups.
4. Opening e-Invoice → Settings loads without PHP errors.
5. Creating one sample record succeeds and appears in the list/table.
6. (If used) Cron-dependent features have Perfex CRM cron enabled on the server.

After install — first actions

1. Create master data required by this module.
2. Create one sample record and walk it through approve/complete if applicable.
3. Train staff using the Quick Start Guide.

Related: Features · Quick Start · FAQ · Version & Changelog