---
title: "BI PMX Summary"
canonical: "https://kb.webcockpit.app/en/customer-api/pmx/getbipmxsummary"
updatedDate: 2026-10-16T00:00:00.000Z
description: "Get the BI PMX report summary for a restaurant and a business day"
tags: ["api", "pmx"]
---

## Endpoint URL

<Endpoint
  method="GET"
  path="/api/Pmx/getBiPmxSummary"
/>

### Authentication

This endpoint requires the `X-Api-Key` header for authentication.
*Example:* `X-Api-Key 12345abcdef`

### Parameters

| Name | Type | Position | Description |
| ---- | ---- | -------- | ----------- |
| `storeNumber` | integer (int32) | query | Restaurant number |
| `countryCode` | string | query | ISO Country code |
| `businessDay` | string (date) | query | Date with the "yyyy-MM-dd" format |



### Responses

#### 200 — OK

**Media type:** `application/json`

```json
{
  "success": true,
  "message": "string",
  "warnings": [
    {
      "title": "string",
      "body": "string"
    }
  ],
  "storeNumber": 0,
  "businessDay": "string",
  "items": [
    {
      "name": "string",
      "items": [
        {
          "name": "string",
          "items": [
            {
              "name": "string",
              "items": [
                {
                  "name": "string",
                  "totalUnits": 0,
                  "unitsIn": 0.0,
                  "unitsOut": 0.0,
                  "unitsDelivery": 0.0,
                  "totalUnitsSold": 0,
                  "unitsPer1000Guests": 0.0,
                  "percentageOfTotalGrossSales": 0.0,
                  "percentageOfTotalNetSales": 0.0,
                  "menuPriceWithVAT": 0.0,
                  "menuPriceWithoutVAT": 0.0,
                  "foodAndPaperCost": 0.0,
                  "foodAndPaperCostGrossPercentage": 0.0,
                  "foodAndPaperCostNetPercentage": 0.0,
                  "grossProfitMargin": 0.0,
                  "grossProfitMarginPercent": 0.0,
                  "foodCost": 0.0,
                  "paperCost": 0.0,
                  "netSales": 0.0,
                  "code": 0
                }
              ],
              "summary": {
                "name": "string",
                "totalUnits": 0,
                "unitsIn": 0.0,
                "unitsOut": 0.0,
                "unitsDelivery": 0.0,
                "totalUnitsSold": 0,
                "unitsPer1000Guests": 0.0,
                "percentageOfTotalGrossSales": 0.0,
                "percentageOfTotalNetSales": 0.0,
                "menuPriceWithVAT": 0.0,
                "menuPriceWithoutVAT": 0.0,
                "foodAndPaperCost": 0.0,
                "foodAndPaperCostGrossPercentage": 0.0,
                "foodAndPaperCostNetPercentage": 0.0,
                "grossProfitMargin": 0.0,
                "grossProfitMarginPercent": 0.0,
                "foodCost": 0.0,
                "paperCost": 0.0,
                "netSales": 0.0
              }
            }
          ],
          "summary": {
            "name": "string",
            "totalUnits": 0,
            "unitsIn": 0.0,
            "unitsOut": 0.0,
            "unitsDelivery": 0.0,
            "totalUnitsSold": 0,
            "unitsPer1000Guests": 0.0,
            "percentageOfTotalGrossSales": 0.0,
            "percentageOfTotalNetSales": 0.0,
            "menuPriceWithVAT": 0.0,
            "menuPriceWithoutVAT": 0.0,
            "foodAndPaperCost": 0.0,
            "foodAndPaperCostGrossPercentage": 0.0,
            "foodAndPaperCostNetPercentage": 0.0,
            "grossProfitMargin": 0.0,
            "grossProfitMarginPercent": 0.0,
            "foodCost": 0.0,
            "paperCost": 0.0,
            "netSales": 0.0
          }
        }
      ],
      "summary": {
        "name": "string",
        "totalUnits": 0,
        "unitsIn": 0.0,
        "unitsOut": 0.0,
        "unitsDelivery": 0.0,
        "totalUnitsSold": 0,
        "unitsPer1000Guests": 0.0,
        "percentageOfTotalGrossSales": 0.0,
        "percentageOfTotalNetSales": 0.0,
        "menuPriceWithVAT": 0.0,
        "menuPriceWithoutVAT": 0.0,
        "foodAndPaperCost": 0.0,
        "foodAndPaperCostGrossPercentage": 0.0,
        "foodAndPaperCostNetPercentage": 0.0,
        "grossProfitMargin": 0.0,
        "grossProfitMarginPercent": 0.0,
        "foodCost": 0.0,
        "paperCost": 0.0,
        "netSales": 0.0
      }
    }
  ]
}
```