← Back to FBR Integration overview
Features (Full Detail) — FBR Integration
Current version: v1.0.0
Pakistan FBR Digital Invoicing integration for Perfex CRM (sandbox and production APIs).
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. Submit invoices to FBR (manual + auto-submit)
In plain words: Submit invoices to FBR (manual + auto-submit)
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
2. Credit note submission with source invoice FBR reference
In plain words: Credit note submission with source invoice FBR reference
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
3. Simulation mode for safe testing
In plain words: Simulation mode for safe testing
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
4. Encrypted API credentials at rest
In plain words: Encrypted API credentials at rest
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 FBR Integration → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.
5. Custom field mapping (HS code, sale type, buyer NTN)
In plain words: Custom field mapping (HS code, sale type, buyer NTN)
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
6. QR codes on invoice PDF / client view
In plain words: QR codes on invoice PDF / client view
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.
7. FBR report (CSV / PDF export)
In plain words: FBR report (CSV / 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 FBR Integration → Reports / Dashboard (or the matching analytics screen), set filters (date, status, warehouse, staff), then run or export the report.
8. Retry queue — with exponential backoff (cron)
In plain words: Retry queue: with exponential backoff (cron)
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: Ensure Perfex CRM cron is running (`php /path/to/perfex/index.php cron/index`). Then enable the related option in module Settings so jobs, alerts, or queues process automatically.
9. Test connection — button (validate endpoint)
In plain words: Test connection: button (validate endpoint)
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
10. Audit log — of submit / retry / test actions
In plain words: Audit log: of submit / retry / test actions
Why it matters: This supports compliance, audit readiness, and on-time operations so nothing important is missed.
How to use it: Open FBR Integration in the admin sidebar, then use the related menu screen for this capability.
11. Bulk submit — admin UI for unsent invoices
In plain words: Bulk submit: admin UI for unsent invoices
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
12. Webhooks — (HTTPS + HMAC) on submit success/failure
In plain words: Webhooks: (HTTPS + HMAC) on submit success/failure
Why it matters: This reduces manual work so agents can focus on exceptions and high-value customers.
How to use it: Enable credentials in FBR Integration → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.
13. External REST API — for third-party integrations
In plain words: External REST API: for third-party integrations
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 FBR Integration → Settings (API keys, webhooks, sandbox/production). Test with a sample record, then monitor the module log or sync screen.
14. Configurable API URLs — per environment
In plain words: Configurable API URLs: per environment
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: Configure under FBR Integration → Settings, and assign staff access from Setup → Staff → Roles.
15. Urdu + Arabic — language packs
In plain words: Urdu + Arabic: language packs
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
16. SaaS multi-tenant hooks (nasbix_saas)
In plain words: SaaS multi-tenant hooks (nasbix_saas)
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 FBR Integration in the admin sidebar, then use the related menu screen for this capability.
Features & workflows from documentation
Features
- Submit invoices to FBR (manual + auto-submit)
- Credit note submission with source invoice FBR reference
- Simulation mode for safe testing
- Encrypted API credentials at rest
- Custom field mapping (HS code, sale type, buyer NTN)
- QR codes on invoice PDF / client view
- FBR report (CSV / PDF export)
- Retry queue with exponential backoff (cron)
- Test connection button (validate endpoint)
- Audit log of submit / retry / test actions
- Bulk submit admin UI for unsent invoices
- Webhooks (HTTPS + HMAC) on submit success/failure
- External REST API for third-party integrations
- Configurable API URLs per environment
- Urdu + Arabic language packs
- SaaS multi-tenant hooks (
nasbix_saas)
External REST API
Enable in settings and set an API key. Endpoints (site URL, not admin):
| Method | Path | Description |
|---|---|---|
| -------- | ------ | ------------- |
| GET | /fbr_integration/fbr_rest | Service info |
| GET | /fbr_integration/fbr_rest/invoice_status/{id} | FBR status for invoice |
| POST | /fbr_integration/fbr_rest/invoice_submit/{id} | Submit single invoice |
| POST | /fbr_integration/fbr_rest/bulk_submit | JSON body: {"invoice_ids":[1,2,3]} |
Authenticate: Authorization: Bearer {api_key} or ?api_key=
Listing highlights
Item Title
FBR Integration - Module for Perfex CRM
Short Description (max ~160 chars)
FBR Digital Invoicing for Perfex CRM by Nasbix Technologies (sandbox & production APIs).
Full Description
Paste HTML from:
releases/codecanyon/fbr_integration_submission/copy/html_description.html
Tags
perfex crm, fbr, pakistan, digital invoicing, tax, invoice, qr code, nasbix, sandbox, production, webhook, rest api, credit note
Category
PHP Scripts > Add-ons > Perfex CRM
Framework
CodeIgniter
Files
| Upload field | File |
|---|---|
| --- | --- |
| Thumbnail 80×80 | thumbnail/thumbnail.png |
| Inline Preview 590×300 | preview/inline_preview.png |
| Main File(s) | fbr_integration-v1.0.0-main.zip |
| Screenshots | fbr_integration-v1.0.0-screenshots.zip |
Official HTML documentation (feature sections)
2. How to Use This Module
Step A — Configure settings
- Go to Setup → Settings → Integrations → FBR Integration.
- Enable/disable auto-submit for invoices and credit notes.
- Map custom fields for HS code, sale type, and buyer NTN (optional).
- Configure retry queue, webhooks, and REST API if needed.
Step B — API credentials
- Open sidebar FBR Integration → Settings (API settings page).
- Set Mode = Simulation (safe testing) or Live.
- Set Environment = Sandbox or Production.
- Enter Seller NTN, POS ID (if required), and FBR API token/key.
- Click Test connection before going live.
Always test in Simulation / Sandbox first. Live mode posts real invoices to FBR.
Step C — Submit an invoice
- Open any non-draft invoice in admin.
- In the left panel, use the FBR Integration box.
- Click Send to FBR.
- On success, FBR invoice number and QR code are stored and can appear on PDF / client view.
Step D — Bulk submit
- Go to FBR Integration → Bulk Submit.
- Select invoices that are not yet sent to FBR.
- Submit in batch (up to 50 per request).
Step E — Credit notes
- First submit the original invoice to FBR successfully.
- Create a credit note applied to that invoice.
- Open credit note preview → Send credit note to FBR.
Step F — Reports & audit
- FBR Report — filter submissions and export CSV/PDF.
- Audit Log — review submit / retry / test-connection events.
3. Features
- Manual + automatic invoice submission to FBR Digital Invoicing API
- Credit note submission linked to source FBR invoice number
- Simulation mode (no real API calls) for safe QA
- Sandbox and Production environments
- Encrypted API credentials at rest
- Custom field mapping: HS code, sale type, buyer NTN/CNIC
- QR verification URL / QR on invoice PDF and client invoice view
- Retry queue with exponential backoff (cron)
- Test connection button
- Audit log for compliance visibility
- Bulk submit admin UI
- HTTPS webhooks with optional HMAC secret
- External REST API for third-party systems
- Configurable API URLs per environment
- English, Urdu, and Arabic language packs
- SaaS / multi-tenant friendly hooks
- Clean uninstall: drops all module tables and options
4. Permissions
Assign under Setup → Staff → Roles → capability group FBR Integration.
| Capability | Purpose |
|---|---|
view | View FBR status panels |
send | Submit invoices / credit notes / bulk submit |
settings | Manage FBR settings & API credentials |
view_fbr_report | Access report & audit log |
5. Cron (retries & webhooks)
Use Perfex CRM’s built-in cron. Example (every minute):
* * * * * php /path/to/perfex/index.php cron/index > /dev/null 2>&1
Enable Retry failed FBR submissions and/or webhooks in settings for background processing.
6. External REST API
Enable REST API in settings and set an API key. Authenticate with Authorization: Bearer {api_key} or ?api_key=.
| Method | Endpoint | Description |
|---|---|---|
| GET | /fbr_integration/fbr_rest | Service info |
| GET | /fbr_integration/fbr_rest/invoice_status/{id} | Invoice FBR status |
| POST | /fbr_integration/fbr_rest/invoice_submit/{id} | Submit invoice |
| POST | /fbr_integration/fbr_rest/bulk_submit | Body: {"invoice_ids":[1,2]} |
7. Uninstall (removes all module data)
- Setup → Modules → Deactivate FBR Integration.
- Then click Uninstall.
This permanently removes:
- Tables:
tblfbr_settings,tblfbr_invoices,tblfbr_audit_log,tblfbr_webhook_queue - All
fbr_integration_*options - Module files from
modules/fbr_integration
Uninstall cannot be undone. Export reports before uninstalling if you need records.
Related: Quick Start · How to Install · FAQ & Tips · Version & Changelog