FBR Digital Invoicing v2.5 Master Handbook

Complete Operational & Visual Guide for All Platform Screens

Go to App
Official Operator & Developer Manual

Everything You Need to Know About the FBR Digital Invoicing Platform

This visual guide walks through every single screen, button, fiscal calculation, and API workflow. Use the interactive mockups below with numbered pins ① to understand how each feature functions in practice.

Module 01

Hierarchical Multi-Tenancy & Company Workspace Switching

The platform supports a 4-tier hierarchical enterprise structure designed for conglomerates, accounting firms, and multi-branch retailers.

Screen: Impersonation Banner & Workspace Context Switcher UI / Top Navigation
Currently Managing Company Context: Al-Rehman Synthetics (Karachi Branch)
FBR DI Platform Master Admin
Switch Entity: Lahore Outlet (POS-02) ▼ ②
OP
① Exit Workspace Context

Returns the operator instantly to their home organisation level without logging out.

② Switch Active Entity

Select any client company, subsidiary, or physical POS outlet. All invoices, buyers, items, and quotas instantly scope to this entity.

Access Control & RBAC

Role-Based Access Control: Company Admin vs. Client / Branch

The platform enforces granular role segregation across multi-entity hierarchies, distinguishing between master corporate governance and localized point-of-sale execution.

Role: company_admin
HQ

Company Admin (Master Company)

Corporate Governance & Multi-Entity Master

Assigned to headquarters management and parent holding entities. Company Admins possess overarching authority across the parent company and all affiliated child branches.

Key Capabilities:
  • ✓ Sub-Client & Branch Creation: Spawn child branches, POS stations, and subsidiaries up to the allotted subclient limit.
  • ✓ Quota Management: Administer shared enterprise invoice pools or allocate dedicated quotas per branch.
  • ✓ Master Company Conversion: Convert standalone company profiles into Master Companies directly.
  • ✓ Cross-Entity Operations: Seamlessly switch context between outlets to view unified sales, buyers, items, and audit trails.
Role: client
POS

Client / Branch User

Point-of-Sale Cashier & Local Operator

Assigned to physical branch operators, cashiers, or single-store merchants. Scoped strictly to their designated store or POS station.

Key Capabilities & Scope:
  • ✓ Sales Invoicing: Create, validate, and certify digital sales tax invoices with live FBR QR codes.
  • ✓ Local Directory: Search registered buyers, ATL status verification, and product catalog lookups.
  • ✕ Restricted Hierarchy: Cannot create unauthorized sub-clients or reassign corporate parent relationships.
  • ✕ Isolated Data Scope: Prevented from accessing peer branch financial transactions or unassigned company workspaces.
Multi-Entity Onboarding

Company Registration & Sub-Entities / Branching Controls

When registering a client company (/clients/create), administrators configure the organizational architecture, sub-entity authorization, and quota limits.

Screen: Client Company Registration & Hierarchy Setup /clients/create
Sub-Entities & Branching Authorization
①

Controls whether this business entity can create child branches, physical store outlets, POS terminals, and sub-clients.

Enabled (Master Multi-Entity)
Permits creating child branches, POS stations, and subsidiaries.
Disabled (Standalone Only)
Restricted to a single standalone business account.
Leave blank for unlimited branches.
Shared Quota Pool (Default for Branches)
Branches draw from parent company monthly quota.
① can_manage_subclients

Enables the company admin and organization staff to manage sub-clients under this account.

② subclient_limit

Hard cap enforcing maximum child entities to prevent plan quota abuse.

③ Shared vs Isolated Quota

Child branches automatically share the master quota or can be restricted to individual monthly caps.

Enterprise Restructuring

Structure & Hierarchy Management Actions

From the Company Profile screen (/clients/{client}), administrators can restructure company hierarchies, convert accounts, add branches, and reassign parent entities with automated onward commission routing.

Screen: Company Profile Hierarchy Actions Toolbar /clients/{id}
Convert to Master ①

Upgrades standalone clients to Master Companies with branch creation capabilities and customizable subclient limits.

POST /clients/{id}/convert-master
Add Child Branch ②

Creates branch outlets, POS stations, or subsidiaries under the master company with inherited FBR tokens and shared quotas.

POST /clients/{id}/subclients
Move Hierarchy ③

Reassigns branch entities across parent companies, detaches sub-clients to standalone, and manages referral partner commissions.

/clients/{id}/move-hierarchy
Section 233 Onward Commission Routing Strategies Atomic Commission Transfer

When transferring companies across hierarchy structures, administrators select how partner commissions route:

1. Inherit Target Adopts target master parent's referral partner.
2. Keep Original Retains client's currently assigned partner.
3. Custom Partner Assigns specific partner ID from registry.
4. None (Clear) Clears partner attribution for direct client.
Module 02

Invoice Creator & FBR Certification Gateway

The Invoice Creator (/invoices/create) allows operators to prepare digital sales tax invoices compliant with SRO 350(I)/2024 and PRAL digital invoicing standards.

Screen: Invoice Header & Buyer Section Real-Time PRAL Gateway
Invoice Ref No ①
INV/2026-27/00042
Auto-Generated Sequential
Invoice Date
2026-09-22
Document Type ②
Sale Invoice (Standard)
1-Click "Fetch from FBR" Taxpayer Auto-Fill ③
FERTILIZER MANUFAC IRS NEW ✓ Active Taxpayer (ATL)
STRN: 1700204600419 • Sindh • Registered Corporate
Response: 78ms
① Sequential Reference

Automatically suggested by your Numbering Engine with zero-collision row locks.

② Document Type

Switches between Sale Invoices, Credit Notes, Debit Notes, and Advance Invoices.

③ 1-Click FBR Auto-Fetch

Queries PRAL Iris by NTN/CNIC to fill business name, STRN, ATL status, and province automatically.

Module 03

Line Items Engine, PCT Code Search & Advance Taxes

The platform computes sales tax (18%), extra tax, further tax (for non-ATL buyers), FED, and withholding advance income taxes (Sections 236CB and 236H) automatically.

# Product Description (Auto-Suggest) HS / PCT Code Qty Price (PKR) Tax Line Total
1 Pure Copper Electrical Cable (10mm) 7408.1100 10 Meter 1,450.00 18% ST 17,110.00
Advance Income Taxes Applied
Section 236CB (Cash-back / Commercial) PKR 10,000.00
Section 236H (Wholesale / Retail Advance) PKR 500.00
Value Excluding ST: PKR 100,000.00
Sales Tax (18%): PKR 18,000.00
Advance Taxes: PKR 10,500.00
Grand Total: PKR 128,500.00
Module 04

Invoice Template Studio & Dynamic Numbering Engine

The Template Customizer (/invoices/template) lets you personalize PDF layouts, thermal POS receipts (80mm/58mm), custom typography, bank settlement cards, and tokenized invoice numbering.

Tokenized Numbering Engine Controls Pakistani Fiscal Rollover
Live Next Reference Preview INV/2026-27/00001
Atomic Concurrency Lock
{PREFIX} {FY} {FY_SHORT} {YYYY} {MM} {BRANCH} {SEQ:5}
Pakistani Fiscal Year (July 1 – June 30)
1 (or custom initial counter)
Module 05

Developer API, Swagger Sandbox & Webhooks

Integrate your ERP, SAP, Oracle, or POS systems directly via our authenticated REST API with OpenAPI 3.1 documentation and automated webhooks.

Webhook Delivery Inspector & Manual Replay HMAC-SHA256 Signed
200 OK invoice.verified #DEL-8891
https://erp.client.com/api/v1/fbr-webhooks (Attempt 1 • 142ms)

Enterprise Health & Liveness Probes

HTTP 200 Healthy

Automated monitoring probes designed for Kubernetes, AWS ALB, and uptime bots:

GET /healthz

Liveness probe checking Database connection, Redis cache, and disk storage.

GET /readyz

Readiness probe checking live PRAL FBR Gateway DNS and latency reachability.

Module 06

Operator Productivity & Keyboard Shortcuts

Ctrl + K / Cmd + K Spotlight Search Palette

Instant search across invoices, drafts, buyers, items, and clients from any screen.

1-Click Fetch FBR Taxpayer Auto-Fill

Auto-fills legal name, STRN, ATL status, and province in ~80ms with zero typos.

Batch Actions Drafts Queue Toolbar

Validate and certify hundreds of queued invoices with FBR in 1 click.