Global Consolidation & Reporting — Features (Full Detail)

2. How to Use This Module

Step A — Configure settings

1. Open the sidebar menu Global Consolidation & Reporting → Settings.
2. Set default currency and code prefixes (groups, entities, periods, runs, eliminations, adjustments).
3. Optionally enable scheduled monthly runs, API, and webhooks.

Step B — Create reporting entities

1. Go to Reporting Entities.
2. Add entities as plant, branch, company, or custom.
3. If Multi-Plant Management is installed, you can sync plants as entities.

Step C — Create a consolidation group

1. Go to Consolidation Groups → create a group.
2. Add member entities and set ownership % for each member.
3. Set the group status to Active when ready.

Step D — Define report periods

1. Go to Report Periods.
2. Create periods (monthly / quarterly / yearly / custom).
3. Keep periods Open while working; Close when reporting is finished.

Step E — FX rates (multi-currency)

1. Go to FX Rates.
2. Add rates for from/to currency pairs by date.

Step F — Run a consolidation report

1. Go to Reports → create a new run.
2. Select consolidation group, period, and report definition (TB / P&L / BS / operational types).
3. Click Calculate.
4. Review results → mark Reviewed → Publish when approved.
5. Export CSV / PDF / executive pack as needed.

Step G — Eliminations & adjustments (optional)

1. Use Eliminations for inter-company amounts.
2. Use Adjustments for manual consolidation journals.

Step H — KPI dashboard

1. Open KPI Dashboard to view operational snapshots for a group and period.

Typical first-week workflow

Settings → Entities → Group (+ ownership %) → Periods → FX Rates → Report Run → Publish → Export

3. Features

Optional integrations

• Accounting Pro — branch-linked financial balances
• Multi-Plant Management — sync plants as entities
• Inventory / Manufacturing / Demand Planning — operational consolidation sources

These modules enhance data sources but are not required for installing and using the core module.

4. Permissions

Assign under Setup → Staff → Roles.

Administrators have full access by default.

5. REST API & Webhooks

1. Enable API under Settings → API & Integrations and generate an API key.
2. Authenticate with header X-GCR-API-Key, or Authorization: Bearer {key}, or ?api_key={key}.
3. Base path: admin/global_consolidation_reporting/global_consolidation_reporting_api/ (follow on-screen API docs / helper routes).
4. Webhook events: consolidation.published, period.closed.
5. BI export: CSV/JSON for published runs (Power BI / Tableau friendly).

6. Uninstall (clean removal)

1. Go to Setup → Modules.
2. Deactivate the module, then click Uninstall.

Uninstall removes:

• All module database tables ({prefix}gcr_*)
• All module options (gcr_*)
• Upload folder uploads/global_consolidation_reporting/ (if present)

Core Perfex CRM tables and other modules are not affected. Uninstall is irreversible for module data — export reports first if needed.

7. Cron Jobs

Scheduled consolidation (if enabled in Settings) uses the main Perfex CRM cron:

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

Ensure cron is already configured for your Perfex installation.