Trade Promotion Management — Features (Full Detail)

← Back to Trade Promotion Management overview

Features (Full Detail) — Trade Promotion Management

Current version: v1.0.0

Trade promotion planning, execution and tracking for Perfex CRM

This page explains module capabilities in depth so new users understand what each feature does, why it matters, and how to use it inside Perfex CRM.

Feature catalog (explained)

Every major capability below is explained in plain language — what it is, why it helps, and how to use it.

1. Promotion planning with types, product lines, client targeting, and approval workflow

In plain words: Promotion planning with types, product lines, client targeting, and approval workflow

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Create a draft record, submit it, then have an approver open the same record and Approve / Reject. Approvers need the approve permission on their role.

2. Accruals, claims, deduction codes, and invoice / credit-note matching

In plain words: Accruals, claims, deduction codes, and invoice / credit-note matching

Why it matters: This reduces manual work so agents can focus on exceptions and high-value customers.

How to use it: Open Trade Promotion Management in the admin sidebar, then use the related menu screen for this capability.

3. Sell-out data, CSV import, uplift analysis, and execution checklists

In plain words: Sell-out data, CSV import, uplift analysis, and execution checklists

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Open the list screen for this data, use Import / Export / PDF buttons (or the bulk actions menu), follow the template columns, then verify a few rows after upload.

4. ROI dashboard, budget vs actual, scorecard, deduction aging, and PDF export

In plain words: ROI dashboard, budget vs actual, scorecard, deduction aging, and PDF export

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Go to Trade Promotion Management → Reports / Dashboard (or the matching analytics screen), set filters (date, status, warehouse, staff), then run or export the report.

5. REST API with scoped API keys and rate limiting

In plain words: REST API with scoped API keys and rate limiting

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Trade Promotion Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

6. Webhooks (promotion.approved, claim.settled)

In plain words: Webhooks (promotion.approved, claim.settled)

Why it matters: This reduces manual work so agents can focus on exceptions and high-value customers.

How to use it: Enable credentials in Trade Promotion Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

7. Optional Distributors sync and Accounting Pro GL posting

In plain words: Optional Distributors sync and Accounting Pro GL posting

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Enable credentials in Trade Promotion Management → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.

8. Role-based permissions and dashboard widget

In plain words: Role-based permissions and dashboard widget

Why it matters: This helps your team complete the work faster with fewer mistakes and a clear audit trail inside Perfex CRM.

How to use it: Go to Trade Promotion Management → Reports / Dashboard (or the matching analytics screen), set filters (date, status, warehouse, staff), then run or export the report.

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.

#ScreenAdmin pathGuide
1TPM Dashboardadmin/trade_promotion_managementHow to use
2Promotionsadmin/trade_promotion_management/trade_promotion_management_promotionsHow to use
3Promotion Typesadmin/trade_promotion_management/trade_promotion_management_typesHow to use
4Accrualsadmin/trade_promotion_management/trade_promotion_management_accrualsHow to use
5Claimsadmin/trade_promotion_management/trade_promotion_management_claimsHow to use
6Deduction Codesadmin/trade_promotion_management/trade_promotion_management_deduction_codesHow to use
7Sell-Out Dataadmin/trade_promotion_management/trade_promotion_management_sell_outHow to use
8Execution Checklistsadmin/trade_promotion_management/trade_promotion_management_executionHow to use
9Uplift Analysisadmin/trade_promotion_management/trade_promotion_management_upliftHow to use
10Reportsadmin/trade_promotion_management/trade_promotion_management_reportsHow to use
11Integrationsadmin/trade_promotion_management/trade_promotion_management_integrationsHow to use
12Settingsadmin/trade_promotion_management/trade_promotion_management_settingsHow to use

Features & workflows from documentation

Features

  • Promotion planning with types, product lines, client targeting, and approval workflow
  • Accruals, claims, deduction codes, and invoice / credit-note matching
  • Sell-out data, CSV import, uplift analysis, and execution checklists
  • ROI dashboard, budget vs actual, scorecard, deduction aging, and PDF export
  • REST API with scoped API keys and rate limiting
  • Webhooks (promotion.approved, claim.settled)
  • Optional Distributors sync and Accounting Pro GL posting
  • Role-based permissions and dashboard widget

Permissions

Assign capabilities under Setup → Staff → Roles for dashboard, promotions, types, accruals, claims, deduction codes, sell-out, execution, reports, integrations, API keys, webhooks, and settings.

REST API Quick Start

  1. Integrations → API Keys — create a scoped API key (save token immediately)
  2. Settings — enable REST API / webhooks as needed
  3. Authenticate with:
Authorization: Bearer tpm_xxxxxxxx

Listing highlights

Item Title

Trade Promotion Management — Module for Perfex CRM

Short Description (max ~160 chars)

Trade promotion planning, accruals, claims, sell-out & ROI tracking for Perfex CRM by Nasbix Technologies

Full Description

Paste HTML from: codecanyon/copy/03_html_description.html (Source mode).

Tags

See codecanyon/copy/05_tags.txt (max 15).

Category

PHP Scripts > Add-ons > Perfex CRM

Images

FieldFileSize
-------------------
Thumbnailcodecanyon/assets/thumbnail_80x80.jpg80×80
Inline Previewcodecanyon/assets/inline_preview_590x300.jpg590×300

Main File

releases/codecanyon/trade_promotion_management-v1.0.0-codecanyon.zip

Contains:

  • trade_promotion_management/ (module)
  • documentation/ (index.html)
  • HOW_TO_USE.txt, README, CHANGELOG, LICENSE

Screenshots

Add real UI captures to codecanyon/screenshots/ then rebuild.

ZIP: releases/codecanyon/trade_promotion_management-v1.0.0-screenshots.zip

Build

bash modules/trade_promotion_management/build_release.sh
bash modules/trade_promotion_management/codecanyon/build_submission_assets.sh

Official HTML documentation (feature sections)

Features

Enterprise trade promotion management for Perfex CRM by Nasbix Technologies.

  • Promotion planning with types, product lines, client targeting, and approval workflow
  • Accruals, claims, deduction codes, and invoice / credit-note matching
  • Sell-out data, CSV import, uplift analysis, and execution checklists
  • ROI dashboard, budget vs actual, scorecard, deduction aging, and PDF export
  • REST API, webhooks, Distributors sync, and Accounting Pro GL posting
  • Granular staff permissions and dashboard widget

See README.md and HOW_TO_USE.txt in the module folder for the complete feature list and step-by-step guide.

Permissions

Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the Trade Promotion Management capability group.

Typical capabilities include view, create, edit, delete, plus module-specific actions (approve, export, settings, API access).

Uninstall

  1. Deactivate Trade Promotion Management in Setup → Modules.
  2. Click Uninstall.

This removes all TPM database tables (tpm_*), module settings, and files under uploads/trade_promotion_management/. Core Perfex CRM files are not modified.

Cron Jobs

Background tasks (if enabled) run through Perfex CRM's main cron. Example crontab (every 5 minutes):

* * * * * php /path/to/perfex/index.php cron/index > /dev/null 2>&1

Check module settings for scheduled jobs and integration toggles.

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

FeatureActions
TPM Dashboard
tpm_dashboard
view
Promotions
tpm_promotions
view, create, edit, delete, approve
Promotion Types
tpm_types
view, create, edit, delete
Accruals
tpm_accruals
view, create, edit, delete, post
Claims
tpm_claims
view, create, edit, delete, validate, pay
Deduction Codes
tpm_deduction_codes
view, create, edit, delete
Sell-Out Data
tpm_sell_out
view, create, edit, delete, import
Execution Checklists
tpm_execution
view, create, edit, delete, verify
Reports
tpm_reports
view, export
Settings
tpm_settings
view, edit
Integrations
tpm_integrations
view
API Keys
tpm_api_keys
view, create, edit, delete
Webhooks
tpm_webhooks
view, create, edit, delete

Related: Quick Start · How to Install · FAQ & Tips · Version & Changelog

Did you find this article useful?