FBR Integration — Quick Start Guide

← Back to FBR Integration overview

Quick Start — FBR Integration

Pakistan FBR Digital Invoicing integration for Perfex CRM (sandbox and production APIs).

5-minute Quick Start

Follow this short path the first time you use FBR Integration:

  1. Activate — Setup → Modules → activate FBR Integration (run Upgrade if prompted).
  2. Permissions — Setup → Staff → Roles → enable view/create/edit (and approve/settings if needed) for this module.
  3. Settings — Open FBR Integration → Settings and save company defaults, prefixes, and integrations.
  4. Master data — Create the first required masters (products, warehouses, templates, channels, accounts, routes, etc.).
  5. First transaction — Create one sample record end-to-end (save → submit/approve → complete) and confirm it appears in lists/reports.
  6. Cron — If the module uses alerts, sync, queues, or AI, confirm Perfex CRM cron is scheduled on the server.

Setup & usage notes from README

Setup

  1. Activate module: Setup → Modules → FBR Integration
  2. Open Setup → Settings → Integrations → FBR Integration
  3. Configure auto-submit, field mapping, retry, webhooks, and REST API
  4. Open FBR Integration → API settings
  5. Set mode, environment, seller NTN, API key (and optional custom URLs)
  6. Click Test connection
  7. Start in Simulation, then switch to Live

Cron (required for retries & webhooks)

Ensure Perfex CRM cron runs on schedule. Failed live submissions retry when Retry failed FBR submissions is enabled. Webhook delivery also runs on cron.


Related: How to Install · Features · FAQ & Tips

Did you find this article useful?