> For the complete documentation index, see [llms.txt](https://help.rbsgo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rbsgo.com/dineplan/front-desk/report/custom-reports.md).

# Custom Reports

## **Overview** <a href="#custom-reports" id="custom-reports"></a>

The Custom Reports category provides specialized reports for analyzing restaurant operations, product performance, service efficiency, and inventory activities. These reports help managers monitor service speed, track product returns, review sold-out items, and identify the best and least performing menu items based on sales quantity and revenue.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-0191ac312aba0209ed8a638d07bed50ee92bf0b7%2Fatt_122_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

## **Reports Available** <a href="#reports-available.7" id="reports-available.7"></a>

The Custom Reports category includes the following reports:

* Speed of Service Report
* Sold Out History Report
* Return Product Report
* Top Sell Report by Quantity
* Top Sell Report by Amount
* Down Sell Report by Quantity
* Down Sell Report by Amount

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-98644a1450c12162582f673b58616d05829bc7aa%2Fatt_123_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Screen Elements** <a href="#screen-elements.10" id="screen-elements.10"></a>

The following screen elements are common to all reports in the Custom Reports category.

**View Mode**

* Select how the report is displayed.
* Available options include:
  * **Compact** – Displays the report in a condensed format.
  * **Full** – Displays the complete report with all available information.
  * **Free** – Displays the report without predefined formatting, allowing flexible viewing.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-d3af00a368ea200e2311d5bf38daf28804e5e49e%2Fatt_124_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Filter by Condition**

* Apply report-specific filters such as department, product, cashier, staff, ticket number, date, or other available conditions before generating the report.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-74c77d92d8cc3d1adcc9b0689fb1179afb79f23f%2Fatt_125_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Filter by Date**

* Specify the required date or date range for generating the report.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-7bcf2ae5eeb0fa4f1b3b9f6dec6ea14902e4862f%2Fatt_126_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Export as PDF**

* Exports the generated report as a PDF document.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-4c1de5e624e934011cf6190f85fe365b6b0eea45%2Fatt_127_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Export to Excel**

* Exports the generated report as an Excel file.

**Print**

* Prints the currently displayed report.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-91ce83a788ab7c4661b4364e08303a5493693fff%2Fatt_129_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

### **Speed of Service Report** <a href="#speed-of-service-report" id="speed-of-service-report"></a>

The Speed of Service Report displays the time taken to process customer orders from order placement until completion. It helps managers evaluate staff efficiency, monitor service performance, and ensure service time targets are consistently achieved.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-9c2bb9d7d8722722aec08181d996d2dcd9850624%2Fatt_130_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.54" id="report-fields.54"></a>

The report includes information such as:

| **Field**     | **Description**                                                                                                                             |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Department    | Displays the restaurant department where the order was processed. It helps identify service performance across different operational areas. |
| POS           | Displays the point-of-sale terminal used to process the order. It helps identify the workstation handling each transaction.                 |
| Staff         | Displays the staff member responsible for processing the order. It helps evaluate employee performance and service efficiency.              |
| Ticket Number | Displays the ticket number assigned to the order. It helps locate the corresponding transaction for verification.                           |
| Date/Time     | Displays the date and time when the order was created. It helps analyze service activity during different business periods.                 |
| Order Time    | Displays the time taken to prepare the customer's order. It helps measure kitchen preparation efficiency.                                   |
| Packing Time  | Displays the time taken to pack the completed order. It helps evaluate packaging performance before delivery or pickup.                     |
| Total Time    | Displays the overall service time from order initiation to completion. It helps measure the total customer service duration.                |
| Avg Server    | Displays the average service time achieved by the selected server or staff member. It helps compare staff performance.                      |
| Total Avg     | Displays the overall average service time for all processed orders. It helps evaluate operational efficiency during the selected period.    |
| Met %         | Displays the percentage of orders completed within the defined service target. It helps measure compliance with service-level expectations. |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.54" id="use-case.54"></a>

Use the Speed of Service Report to:

* Monitor service efficiency.
* Evaluate staff performance.
* Measure order processing time.
* Identify service delays.
* Improve customer experience.

### **Sold Out History Report** <a href="#sold-out-history-report" id="sold-out-history-report"></a>

The Sold Out History Report displays the history of menu items marked as sold out during the selected period. It helps managers review inventory shortages, monitor stock availability, and analyze sold-out trends.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-2dda7f806ea2f7cecc16e7294637a6334580986b%2Fatt_131_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.55" id="report-fields.55"></a>

The report includes information such as:

| **Field**   | **Description**                                                                                                                           |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Date        | Displays the date when the product was marked as sold out. It helps identify stock shortages on specific business days.                   |
| Time        | Displays the time the sold-out status was recorded. It helps analyze inventory depletion during operating hours.                          |
| Product     | Displays the name of the menu item marked as sold out. It helps identify frequently unavailable products.                                 |
| Portion     | Displays the product portion that became unavailable. It helps distinguish sold-out quantities for different serving sizes.               |
| Balance Qty | Displays the remaining inventory quantity at the time of the update. It helps verify stock availability before the product was exhausted. |
| User        | Displays the user who updated the sold-out status. It helps maintain accountability for inventory changes.                                |
| Action      | Displays the action performed, such as marking or restoring product availability. It helps review inventory management activities.        |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.55" id="use-case.55"></a>

Use the Sold Out History Report to:

* Monitor stock shortages.
* Review inventory updates.
* Track sold-out items.
* Analyze product availability.
* Improve inventory planning.

### **Return Product Report** <a href="#return-product-report" id="return-product-report"></a>

The Return Product Report displays detailed information about returned menu items, including customer details, refund information, and return reasons. It helps managers review product returns, verify refunds, and monitor return trends.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-1b55458364e4b9800ede5376162018038883fde8%2Fatt_132_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.56" id="report-fields.56"></a>

The report includes information such as:

| **Field**           | **Description**                                                                                                          |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Date/Time           | Displays the date and time when the product was returned. It helps identify when return transactions occurred.           |
| Cashier             | Displays the cashier who processed the return. It helps maintain accountability for return transactions.                 |
| Ticket Number       | Displays the ticket number associated with the returned product. It helps locate the original sales transaction.         |
| Customer Name       | Displays the customer associated with the returned item. It helps verify customer-related return requests.               |
| Menu Code           | Displays the unique code assigned to the returned menu item. It helps identify products within the system.               |
| Menu Name           | Displays the name of the returned menu item. It helps quickly recognize the product being returned.                      |
| Quantity            | Displays the quantity of items returned. It helps review the volume of returned products.                                |
| Payment Type        | Displays the payment method used for the original purchase. It helps verify payment information during refunds.          |
| Refund Type         | Displays the method used to process the refund. It helps distinguish between cash, card, or other refund types.          |
| Return Product Date | Displays the date when the product return was processed. It helps maintain accurate return records.                      |
| Return Product By   | Displays the user or staff member who processed the return. It helps support auditing and accountability.                |
| Reason              | Displays the reason provided for returning the product. It helps identify common return patterns.                        |
| Detail              | Displays additional information related to the return transaction. It helps provide further clarification when required. |
| Amount              | Displays the total value refunded for the returned product. It helps verify refund accuracy.                             |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*\
**Use Case**

Use the Return Product Report to:

* Review product returns.
* Verify refund transactions.
* Monitor return reasons.
* Analyze return trends.
* Support audit activities.

### **Top Sell Report by Quantity** <a href="#top-sell-report-by-quantity" id="top-sell-report-by-quantity"></a>

The Top Sell Report by Quantity displays the highest-selling menu items based on the number of units sold during the selected period. It helps managers identify popular products and understand customer purchasing trends.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-90187cdc29fc222faad01c3599b4bda1955e70e4%2Fatt_133_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.57" id="report-fields.57"></a>

The report includes information such as:

| **Field**    | **Description**                                                                                                  |
| ------------ | ---------------------------------------------------------------------------------------------------------------- |
| Product Code | Displays the unique code assigned to the product. It helps identify menu items within the system.                |
| Product Name | Displays the name of the menu item. It helps easily recognize the product being analyzed.                        |
| Unit Price   | Displays the selling price of a single unit. It helps compare pricing across products.                           |
| Quantity     | Displays the total quantity sold during the reporting period. It helps measure product popularity.               |
| % Quantity   | Displays the percentage contribution of the product to total quantity sold. It helps compare product demand.     |
| Amount       | Displays the total sales value generated by the product. It helps evaluate product revenue.                      |
| % Amount     | Displays the percentage contribution of the product to total sales value. It helps analyze revenue distribution. |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.56" id="use-case.56"></a>

Use the Top Sell Report by Quantity to:

* Identify best-selling products.
* Monitor product demand.
* Analyze sales volume.
* Support inventory planning.
* Improve menu decisions.

### **Top Sell Report by Amount** <a href="#top-sell-report-by-amount" id="top-sell-report-by-amount"></a>

The **Top Sell Report by Amount** displays the highest revenue-generating menu items during the selected reporting period. It helps managers identify profitable products and evaluate revenue contribution.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-0226d7bfa12773c362bda31a4246f6df756332b7%2Fatt_134_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.58" id="report-fields.58"></a>

The report includes information such as:

| **Field**    | **Description**                                                                                                  |
| ------------ | ---------------------------------------------------------------------------------------------------------------- |
| Product Code | Displays the unique code assigned to the product. It helps identify menu items within the system.                |
| Product Name | Displays the name of the menu item. It helps easily recognize the product being analyzed.                        |
| Unit Price   | Displays the selling price of a single unit. It helps compare pricing across products.                           |
| Quantity     | Displays the total quantity sold during the reporting period. It helps measure product popularity.               |
| % Quantity   | Displays the percentage contribution of the product to total quantity sold. It helps compare product demand.     |
| Amount       | Displays the total sales value generated by the product. It helps evaluate product revenue.                      |
| % Amount     | Displays the percentage contribution of the product to total sales value. It helps analyze revenue distribution. |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.57" id="use-case.57"></a>

Use the Top Sell Report by Amount to:

* Identify high-revenue products.
* Compare product profitability.
* Analyze revenue contribution.
* Support pricing decisions.
* Improve menu performance.

### **Down Sell Report by Quantity** <a href="#down-sell-report-by-quantity" id="down-sell-report-by-quantity"></a>

The Down Sell Report by Quantity displays the lowest-selling menu items based on quantity sold. It helps managers identify slow-moving products and evaluate menu performance.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-121028a55d41cff9e510dd37a2d15df5497999bc%2Fatt_135_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.59" id="report-fields.59"></a>

The report includes information such as:

| **Field**    | **Description**                                                                                                  |
| ------------ | ---------------------------------------------------------------------------------------------------------------- |
| Product Code | Displays the unique code assigned to the product. It helps identify menu items within the system.                |
| Product Name | Displays the name of the menu item. It helps easily recognize the product being analyzed.                        |
| Unit Price   | Displays the selling price of a single unit. It helps compare pricing across products.                           |
| Quantity     | Displays the total quantity sold during the reporting period. It helps measure product popularity.               |
| % Quantity   | Displays the percentage contribution of the product to total quantity sold. It helps compare product demand.     |
| Amount       | Displays the total sales value generated by the product. It helps evaluate product revenue.                      |
| % Amount     | Displays the percentage contribution of the product to total sales value. It helps analyze revenue distribution. |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.58" id="use-case.58"></a>

Use the Down Sell Report by Quantity to:

* Identify slow-moving products.
* Monitor low sales volume.
* Review menu performance.
* Optimize inventory levels.
* Improve product offerings.

### **Down Sell Report by Amount** <a href="#down-sell-report-by-amount" id="down-sell-report-by-amount"></a>

The Down Sell Report by Amount displays the menu items generating the lowest sales revenue during the selected period. It helps managers identify underperforming products and evaluate profitability.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-8a737dd1e0423ff2834041d68cbb8fa10f6c1ac1%2Fatt_136_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.60" id="report-fields.60"></a>

The report includes information such as:

| **Field**    | **Description**                                                                                                  |
| ------------ | ---------------------------------------------------------------------------------------------------------------- |
| Product Code | Displays the unique code assigned to the product. It helps identify menu items within the system.                |
| Product Name | Displays the name of the menu item. It helps easily recognize the product being analyzed.                        |
| Unit Price   | Displays the selling price of a single unit. It helps compare pricing across products.                           |
| Quantity     | Displays the total quantity sold during the reporting period. It helps measure product popularity.               |
| % Quantity   | Displays the percentage contribution of the product to total quantity sold. It helps compare product demand.     |
| Amount       | Displays the total sales value generated by the product. It helps evaluate product revenue.                      |
| % Amount     | Displays the percentage contribution of the product to total sales value. It helps analyze revenue distribution. |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.59" id="use-case.59"></a>

Use the Down Sell Report by Amount to:

* Identify low-revenue products.
* Analyze product profitability.
* Review underperforming items.
* Support menu optimization.
* Improve sales performance.

## **Notes** <a href="#notes" id="notes"></a>

* The information displayed in the reports may vary depending on the selected report, available transaction data, and restaurant configuration.
* Report results are generated based on the selected date range and applied conditions.
* Some fields, such as Cost, Total Cost, and Profit, are available only when costing is configured in the system.
* Empty reports indicate that no transactions match the selected date range or filter conditions.
* Report totals are displayed based on the transactions included in the generated report.
* Use Export to PDF, Export to Excel, or Print to save or share the generated report as required.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.rbsgo.com/dineplan/front-desk/report/custom-reports.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
