← Back to Trade Promotion Management overview
Quick Start — Trade Promotion Management
Trade promotion planning, execution and tracking for Perfex CRM
5-minute Quick Start
Follow this short path the first time you use Trade Promotion Management:
- Activate — Setup → Modules → activate Trade Promotion Management (run Upgrade if prompted).
- Permissions — Setup → Staff → Roles → enable view/create/edit (and approve/settings if needed) for this module.
- Settings — Open Trade Promotion Management → Settings and save company defaults, prefixes, and integrations.
- Master data — Create the first required masters (products, warehouses, templates, channels, accounts, routes, etc.).
- First transaction — Create one sample record end-to-end (save → submit/approve → complete) and confirm it appears in lists/reports.
- Cron — If the module uses alerts, sync, queues, or AI, confirm Perfex CRM cron is scheduled on the server.
Full how-to guide (from module package)
The steps below come from the module author's printable guide — follow them in order for best results.
HOW TO USE — Trade Promotion Management for Perfex CRM
Author: Nasbix Technologies | Version: 1.0.0
INSTALLATION
- Upload the folder "trade_promotion_management" into your Perfex CRM modules/ directory.
- Log in as administrator.
- Go to Setup → Modules.
- Find "Trade Promotion Management" and click Activate.
- Database tables and default options are created automatically (schema version 100).
- Go to Setup → Staff → Roles and assign TPM permissions to the roles that need access.
- Open Trade Promo from the sidebar and configure Settings (prefixes, approval, API, webhooks, GL).
QUICK START
1. Promotion Types
- Open Trade Promo → Promotion Types (defaults are seeded on install).
- Add or edit types (percentage discount, fixed, buy X get Y, rebate, display, bundle).
2. Create a Promotion
- Trade Promo → Promotions → New Promotion.
- Enter code/name, type, dates, budget, currency.
- Select target clients and add product lines (discount type/value, min/max qty).
- Save as Draft.
3. Approval Workflow
- Submit for approval → Approve → Activate (capabilities depend on staff role).
- Close the promotion when the campaign ends.
4. Accruals
- Trade Promo → Accruals → create an accrual for a promotion period.
- Post when ready; reverse if needed.
5. Claims & Deduction Codes
- Maintain deduction codes under Deduction Codes.
- Create claims linked to promotion + client; validate, dispute, or mark paid.
- Optionally link invoice / credit note references.
6. Sell-Out & Uplift
- Add sell-out rows manually or import CSV.
- Use Uplift Analysis with baseline weeks from Settings.
7. Execution Checklists
- Record in-store compliance (display, pricing, signage, stock) per client/date.
8. Reports & Dashboard
- Dashboard shows budget vs spend, active promotions, and quick links.
- Reports: ROI, scorecard, deduction aging; export PDF/CSV where available.
9. Integrations (optional)
- Integrations → API Keys: create a scoped token (copy it once).
- Integrations → Webhooks: subscribe to promotion.approved / claim.settled.
- Settings: enable REST API, webhooks, and optional Accounting Pro GL accounts.
- Authenticate API with: Authorization: Bearer tpm_xxxxxxxx
or header X-TPM-API-Key: tpm_xxxxxxxx
PERMISSIONS (Setup → Staff → Roles)
Assign as needed: tpm_dashboard, tpm_promotions, tpm_types, tpm_accruals,
tpm_claims, tpm_deduction_codes, tpm_sell_out, tpm_execution, tpm_reports,
tpm_integrations, tpm_api_keys, tpm_webhooks, tpm_settings
(Capabilities typically include view / create / edit / delete / approve where applicable.)
UNINSTALL
- Setup → Modules → Deactivate Trade Promotion Management.
- Click Uninstall.
This removes ALL module data: every tpm_* table, every tpm_* option/setting,
and uploads/trade_promotion_management/ if present.
Core Perfex CRM data is not modified. Export first — uninstall cannot be undone.
DOCUMENTATION
Open documentation/index.html in a browser for the full HTML guide.
See also README.md, CHANGELOG.md, and LICENSE.txt in this package.
SUPPORT
Nasbix Technologies — https://nasbix.com
Include your CodeCanyon purchase code when requesting support.
Screens map — what each menu is for
These are the admin screens registered by Trade Promotion Management. Click a name in the Knowledge Base for a full how-to, or open the path in admin.
| # | Screen | Admin path | Guide |
|---|---|---|---|
| 1 | TPM Dashboard | admin/trade_promotion_management | How to use |
| 2 | Promotions | admin/trade_promotion_management/trade_promotion_management_promotions | How to use |
| 3 | Promotion Types | admin/trade_promotion_management/trade_promotion_management_types | How to use |
| 4 | Accruals | admin/trade_promotion_management/trade_promotion_management_accruals | How to use |
| 5 | Claims | admin/trade_promotion_management/trade_promotion_management_claims | How to use |
| 6 | Deduction Codes | admin/trade_promotion_management/trade_promotion_management_deduction_codes | How to use |
| 7 | Sell-Out Data | admin/trade_promotion_management/trade_promotion_management_sell_out | How to use |
| 8 | Execution Checklists | admin/trade_promotion_management/trade_promotion_management_execution | How to use |
| 9 | Uplift Analysis | admin/trade_promotion_management/trade_promotion_management_uplift | How to use |
| 10 | Reports | admin/trade_promotion_management/trade_promotion_management_reports | How to use |
| 11 | Integrations | admin/trade_promotion_management/trade_promotion_management_integrations | How to use |
| 12 | Settings | admin/trade_promotion_management/trade_promotion_management_settings | How to use |
Related: How to Install · Features · FAQ & Tips