Quick Search
The Quick Search feature lets you quickly find and navigate to records, reports, pages, and actions throughout Frappe Books from a single search interface.
It supports fuzzy searching, allowing you to locate entries even if you don’t remember the exact name or make minor spelling mistakes.
Tip
Use Ctrl + K (Windows/Linux) or Cmd + K (macOS) to open Quick Search instantly from anywhere in the application.
Opening Quick Search
You can open the Quick Search dialog in either of the following ways:
- Click the Search icon in the application header.
- Press Ctrl + K (Windows/Linux) or Cmd + K (macOS).
Searching
After opening the dialog, simply start typing in the search box.
Quick Search automatically searches across multiple areas of Frappe Books, including records, reports, pages, and navigation shortcuts.
Because it uses fuzzy search, you don’t need to type the exact name of a record. Similar words and minor spelling mistakes are matched automatically.
Search Result Types
Search results are grouped into different categories based on what they represent.
| Type | Purpose | Example |
|---|---|---|
| Docs | Opens an existing document or record. | PAY-1001 |
| List | Opens the List View of a record type. | Sales Items |
| Create | Creates a new record. | Purchase Invoice |
| Report | Opens a report. | General Ledger |
| Page | Opens an application page. | Dashboard |
For document results, the record type (such as Customer, Payment, or Sales Invoice) is displayed alongside the document name.
Using Filters
Click More Filters to display additional filtering options and narrow your search results.
Two types of filters are available:
- Regular Filters — Filter results by category such as Docs, Lists, Reports, or Pages.
- Document Filters — Filter results by specific document types, such as Payments or Sales Invoices.
Regular Filters
Disabling a regular filter removes that category from the search results.
For example, disabling Docs hides all document records while continuing to display Lists, Reports, Pages, and Create actions.
Document Filters
Document filters allow you to exclude specific document types from the search.
For example, disabling the Payment filter hides all payment records while leaving other document types visible.
Shortcut filters such as Skip Child Tables and Skip Transactions let you quickly exclude multiple document types at once.
Example Searches
Quick Search can be used for a variety of everyday tasks, including:
- Finding all Sales Invoices created for a specific customer.
- Searching Purchase Invoices containing a particular item.
- Locating the payment associated with a Purchase Invoice.
- Finding all payments received from a particular customer.
The order of the search keywords does not matter. Quick Search matches relevant results regardless of the sequence in which keywords are entered.
Related Features
- Dashboard
- Reports
- Sales Invoices
- Payments
- Import Wizard
Best Practices
- Use keyboard shortcuts to access Quick Search without leaving your current page.
- Take advantage of fuzzy search instead of typing exact document names.
- Use filters to narrow results when searching large datasets.
- Search using customer names, document numbers, or item names to locate related records quickly.
- Remember that keyword order does not affect the search results.