Official Technical Documentation & User Manual
User Manual › Volume 4: Sales, CRM & Accounts Receivable (Money Coming In)
Verified Guide • Updated 16 Oct 2026
User Manual Volume 4: Sales, CRM & Accounts Receivable (Money Coming In) Verified Guide

#09: Commercial Proposals, Quotes & Pro-Forma Deposit Command Center & Studio

Updated 20 hours ago 12 min read 4 views
Volume 4 • Article #09 Routes: quote/index, quote/add, quote/preview, quote/settings Quotes & Pro-Forma Engine

Commercial Proposals, Quotes & Pro-Forma Deposit Command Center & Studio

Build multi-revision commercial proposals with live cost-vs-margin guards, issue SARS/tax-compliant Pro-Forma Deposit Invoices (`PRO-`), collect digital client signatures online, and convert approved deals into Tax Invoices, ERP Projects, or Field Job Cards in one click.

1. Plain-English Accounting: Commercial Quote vs. Pro-Forma Invoice vs. Tax Invoice

One of the most common mistakes in business accounting is issuing a Tax Invoice just to ask a customer for a deposit before work starts. If the client changes their mind or cancels the deal, you are stuck reversing Output VAT/Tax you haven't even collected! Keystone X solves this with a Dual-Stream Document Engine:

Document Type Prefix General Ledger & VAT Impact When to Use It
1. Commercial Quote / Proposal QUO-0001 Zero GL / Zero VAT Impact Presenting pricing options, executive summaries, scope of work, and validity dates to a client for approval and digital signature.
2. Pro-Forma Deposit Invoice PRO-0001 Zero VAT Risk Until Paid Corporate clients often refuse to pay a deposit against a document titled "Quote"—their finance department demands an invoice showing banking details and a required mobilization deposit (e.g., 50% Deposit Required). A Pro-Forma Invoice satisfies the client's bank without triggering premature Output VAT liability on your General Ledger!
3. Tax Invoice (Covered in Article #10) INV-0001 Full GL & Output VAT Posting Issued once the proposal is accepted or goods/services are delivered. Debits Accounts Receivable (`1100`), Credits Sales Revenue (`4000`), and Credits Output VAT (`2100`).

2. Dual-Stream Command Center & 3 View Modes (quote/index)

Navigate to Sales & CRM → Quotes & Proposals (quote/index).

SCREENSHOT PLACEHOLDER vol4-09-quotes-command-center.png

How to capture this screenshot:

  1. Navigate to quote/index?view=list.
  2. Ensure you have both `QUO-` (Commercial Quote) and `PRO-` (Pro-Forma Invoice) records visible in the table, including at least one with a `v2` revision badge and a required deposit badge.
  3. Capture the full screen showing the 3 View Mode buttons (Ledger View, Deal Pipeline, Pro-Forma Stream), the 6 KPI cards, and the ledger table.
A. Top Command Bar & 3 View Mode Switchers
Button / Switcher Route / Trigger Function
Ledger View quote/index?view=list Displays the unified DataTables ledger containing both Commercial Quotes (`QUO-`) and Pro-Forma Invoices (`PRO-`).
Deal Pipeline quote/index?view=board Switches to a 5-column drag-and-drop Kanban board (Draft → Sent → Viewed → Approved → Invoiced). Dragging a card updates its status via `quote/updateStatusAjax/{id}`.
Pro-Forma Stream quote/index?view=proforma Filters the entire ledger strictly to Pro-Forma Deposit Invoices (`PRO-`) so finance staff can track pending mobilization deposits.
From Blueprint #quickProposalModal Appears when you have pre-built templates configured in Studio. Opens the 10-second Generate Proposal from Blueprint modal.
New Pro-Forma quote/add?type=proforma Opens the document builder pre-configured in Pro-Forma Deposit Invoice (`PRO-`) mode.
New Quote quote/add Opens the document builder in standard Commercial Quote (`QUO-`) mode.
(Studio Gear) quote/settings Opens the Quotes, Proposals & Pro-Forma Studio.
B. The 6 Commercial KPI Cards
KPI Card Studio Toggle Meaning
1. Open Pipeline Value kpi_pipeline_value Total monetary value of all open quotes (`Draft`, `Sent`, `Viewed`) plus total document count.
2. Conversion Win Rate kpi_win_rate Percentage of total quotes that reached `Approved` or `Invoiced` status, plus total value won.
3. Pro-Forma Stream kpi_proforma_stream Total value and count of active `PRO-` Pro-Forma Deposit Invoices, plus total required deposit value.
4. Ready to Invoice kpi_ready_to_invoice Value and count of client-approved proposals (`status = Approved`) that have not yet been converted into a Tax Invoice.
5. Expiring Soon (7d) kpi_expiring_soon Count of open quotes whose `valid_until_date` expires within the next 7 days, plus count of already expired quotes.
6. Average Deal Size kpi_avg_deal_size Mean monetary value across all quotes and proposals.
C. Row Action Icons & 3-Dot ERP Conversion Menu

Every row in the Quote Ledger (`quote/index?view=list`) features 3 direct action buttons plus a 3-Dot Quick ERP Workflow Menu ():

  • Open Proposal Cockpit (`quote/preview/{id}`): Opens the interactive executive preview & conversion bridge.
  • Edit Document (`quote/edit/{id}`): Modifies line items, scope, or deposit terms.
  • Download PDF (`quote/pdf/{id}`): Generates the print-ready PDF in a new tab.
  • Quick ERP Workflow Dropdown:
    • Convert to Tax Invoice (`quote/convertToInvoice/{id}`): Converts the quote into a formal Tax Invoice (`INV-`).
    • Switch to Pro-Forma Invoice / Commercial Quote (`quote/convertToProForma/{id}`): Flips the document between `QUO-` and `PRO-` stream instantaneously.
    • Create New Revision (`quote/revise/{id}`): Clones the quote into `v2` (or `v3`, `v4`...) so you can revise pricing while preserving the original revision history.
    • Launch ERP Project (`quote/convertToProject/{id}`): Creates a new project in the Project Management Suite pre-populated with this quote's client, budget, and scope.
    • Dispatch Field Job Card (`quote/convertToJobcard/{id}`): Creates a Field Service Job Card (`JC-`) directly from the quote's line items.

3. Rapid Generation: The "From Blueprint" Modal (#quickProposalModal)

Clicking From Blueprint in the top bar opens a modal (`#quickProposalModal`) that generates a complete proposal in seconds using templates saved in your Studio:

  1. Select Proposal Blueprint (`template_id`): Choose a saved template (e.g., "10kVA Solar Backup Package" or "Annual SLA Retainer"). Choosing a blueprint automatically fills in the default Document Type (`Quote` vs `Pro-Forma Invoice`), Deal Title, and Required Mobilization Deposit %!
  2. Client / Customer (`customer_id`): Select the target customer.
  3. Document Type (`document_type`): Choose Commercial Quote (`QUO-`) or Pro-Forma Invoice (`PRO-`).
  4. Deal / Reference Title (`reference_title`): Custom project or deal headline.
  5. Link to ERP Project (`project_id`): Optional project association.
  6. Required Mobilization Deposit % (`deposit_percentage`): Percentage deposit required upfront. Click Generate Document to create the populated proposal immediately.

4. Building a Proposal or Pro-Forma (quote/add & quote/edit)

Whether you click + New Quote or + New Pro-Forma, Keystone X opens the interactive Commercial Document Builder (`quote/add`).

SCREENSHOT PLACEHOLDER vol4-09-quote-builder-margin-guard.png

How to capture this screenshot:

  1. Navigate to quote/add.
  2. Select a Customer, enter a Deal Title, set Mobilization Deposit % to 50%, and add 2–3 inventory items to the Line Items table.
  3. Notice the Gross Margin Guard pill above the line items table and the live Cost & Margin % column on each row.
  4. Capture the full builder interface.
A. Document Header, Commercial Metadata & Deposit Settings
Field Label Input Name Purpose & Behavior
Load Proposal Blueprint #blueprintQuickLoad Top-right selector. Picking a blueprint dynamically populates the Document Type, Deal Title, Deposit %, Executive Summary, and Terms & Conditions on the fly.
Document Stream document_type Switches between Commercial Quote / Proposal (`QUO-`) and Pro-Forma Deposit Invoice (`PRO-`). Automatically swaps the read-only Document Number field between the next `QUO-` and `PRO-` sequence numbers!
Client / Customer customer_id Required. Selects the target customer account.
Deal / Proposal Title reference_title High-visibility subject line printed on the PDF cover banner and shown in the ledger (e.g., "Phase 2 Data Center Cabling & Racking").
Link to ERP Project project_id Optional. Associates this quote with an active project for project budget/revenue tracking.
Assign Sales Owner salesperson_id Selects the Sales Rep responsible for closing the proposal.
Issue Date & Valid Until Expiry quote_date, valid_until_date Sets the quote date and expiration deadline (defaults to today + your Studio `default_expiry_days`).
Mobilization Deposit (%) deposit_percentage Enter a percentage (0% to 100%). The builder automatically calculates and displays the exact monetary Required Deposit (`deposit_amount`) in the totals block and prints a formal deposit callout box on the PDF.
Currency & Exchange Rate currency, exchange_rate Supports ZAR, USD, EUR, GBP, BWP, NAD, and AUD. Selecting a foreign currency reveals the Exchange Rate field.
Lifecycle Status status Draft, Sent to Client, Viewed by Client, Approved / Won, or Rejected / Lost.

5. Line-Item Pricing, Cost Price & Live Gross Margin Guard

Sales reps often accidentally underquote deals when giving discounts. Keystone X includes a built-in Staff-Only Gross Margin & Profit Guard inside the Quote Builder (`quote/add` and `quote/edit`):

  • Catalog Picker (`item_id[]`) + Rich Description (`item_description[]`): Select any SKU from your Inventory Catalog to auto-fill its Selling Price (`unit_price[]`), Unit Cost (`unit_cost[]`), and Tax Rate (`tax_rate[]`), or type a freeform custom service item and multi-line scope description.
  • Optional Item Checkbox (`is_optional[]`): Tick the Optional Add-on checkbox on any row to present an upsell option to the customer without adding its price into the mandatory Grand Total!
  • Internal Unit Cost & Row Margin Badge (`unit_cost[]`): Visible only to internal staff (never printed on client PDFs). Shows your unit cost and calculates a live Row Margin % Badge.
  • Live Deal Gross Margin Banner: Above the line items table and inside the summary card, Keystone X calculates total Estimated Profit and Overall Deal Margin %. If the deal's margin drops below your Studio Minimum Gross Margin Target % (e.g., 20%), the badge turns **Red (Below Target)** to warn the salesperson before they send the quote!
Narrative Proposal Sections (Below the Line Items)
  • Executive Summary / Cover Letter (`introduction_text`): Printed at the top of the proposal PDF before the pricing table to introduce your company's value proposition.
  • Scope of Work / Technical Deliverables (`scope_of_work`): Detailed breakdown of phases, milestones, inclusions, and exclusions.
  • Terms, Conditions & Payment Milestones (`terms`): Legal validity, warranty terms, and deposit conditions.
  • Private Staff Deal Notes (`internal_notes`): Strictly internal notes for managers and technicians; hidden from client PDFs and the Client Portal.

6. The Proposal Cockpit, Revisions (v1, v2) & 4-Card ERP Conversion Bridge (quote/preview/{id})

Clicking any quote number or the preview icon opens the **Proposal & Pro-Forma Cockpit** (`quote/preview/{id}`).

SCREENSHOT PLACEHOLDER vol4-09-quote-preview-cockpit.png

How to capture this screenshot:

  1. Navigate to quote/preview/{id} for a rich multi-line quote.
  2. Capture the top action bar (New Revision, Email to Client, Download PDF), the 5-Stage Lifecycle Stepper, the 4-Card ERP Downstream Conversion Bridge, the Internal Deal Profitability & Margin Guard banner, and the executive document preview below.
A. Top Cockpit Controls & Version Revisions
  • New Revision (`v2`, `v3`...): Clicking New Revision (`quote/revise/{id}`) creates a linked child revision (e.g., `QUO-0042 v2`) and displays a Revision History Switcher Bar at the top of the cockpit so you can toggle between `v1`, `v2`, and `v3` at any time.
  • Email to Client (`#emailQuoteModal`): Opens a modal pre-filled with the client's email (respecting your Customer Document Routing settings!) and dispatches the PDF proposal + online portal acceptance link (`quote/sendEmail/{id}`).
  • 5-Stage Visual Lifecycle Stepper: Shows the real-time progress across 1. Draft → 2. Sent to Client → 3. Client Viewed → 4. Approved / Won → 5. Invoiced, along with quick Mark Approved and Mark Rejected buttons.
B. The 4-Card ERP Downstream Conversion Bridge

Directly beneath the lifecycle stepper sits the 4-Card ERP Conversion Bridge, connecting pre-sales quoting to every operational and financial module in Keystone X:

Card 1: Pro-Forma Deposit Stream

Flips a Commercial Quote into a Pro-Forma Deposit Invoice (`PRO-`) (or back to a Quote) via `quote/convertToProForma/{id}` so the client can pay their mobilization deposit before a Tax Invoice is issued.

Card 2: Revenue & Tax Billing (`Convert to Tax Invoice`)

Converts all mandatory line items (excluding unchecked Optional Add-ons) into a formal **Tax Invoice (`INV-`)** via `quote/convertToInvoice/{id}` and marks the quote as `Invoiced`.

Card 3: Project Delivery Suite (`Launch Project`)

Spawns a linked **ERP Project** (`quote/convertToProject/{id}`) carrying over the customer, deal title, budget, and scope of work—or links straight to the active project if already launched.

Card 4: Field Operations & Dispatch (`Create Job Card`)

Generates a **Field Service Job Card (`JC-`)** (`quote/convertToJobcard/{id}`) pre-loaded with the quote's hardware/service line items for technician dispatch.

7. Quotes, Proposals & Pro-Forma Studio (quote/settings)

Click the Gear Icon () on `quote/index` to open the **Quotes, Proposals & Pro-Forma Studio** (`quote/settings`). It is organized into **4 Governance Tabs**:

SCREENSHOT PLACEHOLDER vol4-09-quotes-studio-blueprints.png

How to capture this screenshot:

  1. Navigate to quote/settings.
  2. Capture Tab 1: Numbering, Margin & Pro-Forma first, and optionally capture Tab 4: Proposal Blueprints showing the reusable template builder.
Studio Tab Key Settings & Controls What It Controls
Tab 1: Numbering, Margin & Pro-Forma (#pane-numbering) Quote & Pro-Forma Sequencing (quote_prefix, quote_next_number, proforma_prefix, proforma_next_number, default_expiry_days) Configures independent prefixes (`QUO-` and `PRO-`), next sequential numbers, and default validity period (e.g., 14 or 30 days).
Profitability & Margin Guard (enable_margin_calculator, min_gross_margin_percent, default_deposit_percentage, auto_require_deposit_above) Enables the live Cost vs. Margin calculator, sets the minimum acceptable Gross Margin % target, sets default deposit %, and can automatically enforce a deposit when a deal exceeds a specified monetary threshold!
Workflow & Digital Acceptance Rules (require_digital_signature, allow_proforma_conversion, enable_revision_tracking, lock_approved_quotes, show_bank_on_proforma) Controls client portal e-signature capture, Pro-Forma switching, `v1/v2` revision cloning, locking approved quotes against tampering, and printing banking details on Pro-Forma PDFs.
Tab 2: Narrative & Legal Defaults (#pane-narrative) default_intro_text, default_scope_of_work, default_quote_terms, proforma_footer_note Sets the default Cover Letter, Scope of Work template, Standard Terms & Conditions, and the legal SARS/Tax compliance notice printed at the bottom of Pro-Forma Invoices ("This is a Pro-Forma Invoice for deposit/mobilization purposes only and does not constitute a Tax Invoice...").
Tab 3: Command Center UI (#pane-display) default_view_mode (Ledger / Deal Pipeline / Pro-Forma Stream) + 6 KPI Card toggles + 7 Table Column toggles Customizes which view mode opens by default and which KPI cards and table columns are displayed on `quote/index`.
Tab 4: Proposal Blueprints (#pane-blueprints) Create & Manage Proposal Blueprints (`quote/saveTemplate`, `quote/deleteTemplate/{id}`) Allows you to build reusable turnkey packages (e.g., "8kW Hybrid Solar System" or "Monthly IT Managed Services") with pre-set Document Type (`Quote` or `Pro-Forma`), Category, Deposit %, Cover Letter, Scope of Work, and Terms. These power the 1-click From Blueprint modal!
Was this technical guide helpful?
Back to top