Module: Revenue Recognition (IFRS 15) v1.4.0
IFRS 15 compliant revenue recognition — contracts, performance obligations, and recognition schedules for BIXCRM
Screen-by-screen guides (each tab explained)
Click a menu item below for step-by-step instructions on that Revenue Recognition (IFRS 15) screen:
How to use in BIXCRM (daily operations)
- Sign in to the admin area with a role that includes Revenue Recognition (IFRS 15) permissions.
- Open Revenue Recognition (sidebar) or search for Revenue Recognition (IFRS 15) in the admin menu.
- Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
- Review Settings after upgrades — new options may need defaults for your company.
- Create or import master data first; most modules block transactions until masters exist.
- Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
- Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
- For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
- Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
- If something fails overnight, check BIXCRM cron ran and open the module log / failed queue screen if present.
Admin menu — where to work
Open the Revenue Recognition (IFRS 15) section in the admin sidebar. Screens your staff may use (depending on role):
- Contract Modifications
- Recognition Schedules
- Reports
- Revenue Contracts
- Revenue Dashboard
- Rev Recognition
- Settings
Detailed guide — features, workflows, API & FAQ
Features Summary
| Phase | Highlights |
|---|---|
| ------- | ------------ |
| 1 | Contracts, obligations, schedules, dashboard, permissions |
| 2 | Variable consideration, modifications, approval, progress methods |
| 3 | Deferred revenue ledger, Accounting Pro GL posting |
| 4 | IFRS 15 disclosure reports, CSV/PDF export |
| 5 | REST API, webhooks, invoice auto-contract, project milestone sync |
Phase 5 Features
| Feature | Status |
|---|---|
| --------- | -------- |
| REST API (contracts, obligations, schedules) | Done |
| API key management (read / write scopes) | Done |
| Outbound webhooks with HMAC signatures | Done |
| Auto-create contract from invoice | Done |
| Sync BIXCRM project milestones | Done |
| Integration audit log | Done |
REST API
Base URL: {site}/revenue_recognition/rr_api
Auth: X-RR-API-Key: {token} or Authorization: Bearer {token}
| Method | Endpoint | Scope |
|---|---|---|
| -------- | ---------- | ------- |
| GET | /contracts | read |
| GET | /contracts/{id} | read |
| GET | /contracts/{id}/obligations | read |
| GET | /contracts/{id}/schedules | read |
| GET | /schedules | read |
| POST | /create_contract | write |
| POST | /recognize/{schedule_id} | write |
| POST | /create_from_invoice/{invoice_id} | write |
| POST | /sync_project_milestones/{contract_id} | write |
Manage keys: Revenue Recognition → Settings → API Keys
Webhook Events
| Event | Trigger |
|---|---|
| ------- | --------- |
contract.created | New revenue contract |
contract.approved | Contract approved |
contract.activated | Contract activated |
contract.cancelled | Contract cancelled |
schedule.recognized | Revenue recognized |
modification.applied | Modification applied |
invoice.contract | Auto-contract from invoice |
DB Version
Check option rr_db_version — expected 104.
See [docs/ROADMAP.md](docs/ROADMAP.md) for full phase history.
Features
IFRS 15 compliant revenue recognition — contracts, performance obligations, and recognition schedules for BIXCRM
See README.md in the module folder for the complete feature list.
Permissions
Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the Revenue Recognition (IFRS 15) capability group.
Typical capabilities include view, create, edit, delete, plus module-specific actions (approve, export, settings, API access).
Cron Jobs
Background tasks (if enabled) run through BIXCRM's main cron. Example crontab (every 5 minutes):
* * * * * php /path/to/bixcrm/index.php cron/index > /dev/null 2>&1
Check module settings for scheduled jobs (alerts, sync, reports, retention).
After activation — configuration checklist
- Go to Setup → Modules and activate Revenue Recognition (IFRS 15).
- If prompted, click Upgrade Database or reload admin — migrations run automatically.
- Assign permissions under Setup → Staff → Roles.
- Open the module menu and configure settings.
- BIXCRM 3.0+
- PHP 7.4+ (8.1+ recommended)
- MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
- PHP extensions: mysqli, json, mbstring, curl, fileinfo
One-time setup (first time only)
- Setup → Modules → activate Revenue Recognition (IFRS 15).
- Setup → Staff → Roles → assign Revenue Recognition (IFRS 15) permissions (view, create, edit, delete, approve, export, settings as needed).
- Open Revenue Recognition (IFRS 15) → Settings and complete company defaults, prefixes, integrations, and notification options.
- Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
- Enable BIXCRM cron (
php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
BIXCRM Knowledge Base — usage guide generated from module README and documentation.