GET api/General/Report/GetRestaurantSalesSummary?PartnerID={PartnerID}&StartDate={StartDate}&EndDate={EndDate}&SearchTerm={SearchTerm}&UserID={UserID}&UserRole={UserRole}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PartnerID | string |
Required |
|
| StartDate | date |
Required |
|
| EndDate | date |
Required |
|
| SearchTerm | string |
Required |
|
| UserID | string |
Required |
|
| UserRole | string |
Required |
Body Parameters
None.
Response Information
Resource Description
RestaurantSalesSummaryView| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalOrders | integer |
None. |
|
| TotalRestaurants | integer |
None. |
|
| CouponDiscount | decimal number |
None. |
|
| DeliveryDiscount | decimal number |
None. |
|
| TotalDiscountAmount | decimal number |
None. |
|
| TotalTax | decimal number |
None. |
|
| TotalAmount | decimal number |
None. |
|
| ItemsTotalAmount | decimal number |
None. |
|
| ItemsTotalTax | decimal number |
None. |
|
| CC21ServiceFee | decimal number |
None. |
|
| CC21ServiceTax | decimal number |
None. |
|
| TotalDeliveryFee | decimal number |
None. |
|
| TotalDeliveryFeeTax | decimal number |
None. |
|
| PaymentCycleStartDate | date |
None. |
|
| PaymentCycleEndDate | date |
None. |
|
| PartnerID | string |
None. |
|
| PartnerName | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalOrders": 1,
"TotalRestaurants": 2,
"CouponDiscount": 1.0,
"DeliveryDiscount": 1.0,
"TotalDiscountAmount": 1.0,
"TotalTax": 3.0,
"TotalAmount": 4.0,
"ItemsTotalAmount": 5.0,
"ItemsTotalTax": 6.0,
"CC21ServiceFee": 7.0,
"CC21ServiceTax": 8.0,
"TotalDeliveryFee": 9.0,
"TotalDeliveryFeeTax": 10.0,
"PaymentCycleStartDate": "2025-12-07T09:58:02.2153639+05:30",
"PaymentCycleEndDate": "2025-12-07T09:58:02.2153639+05:30",
"PartnerID": "sample string 11",
"PartnerName": "sample string 12"
}
application/xml, text/xml
Sample:
<RestaurantSalesSummaryView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/General.Operations.CustomModels"> <CC21ServiceFee>7</CC21ServiceFee> <CC21ServiceTax>8</CC21ServiceTax> <CouponDiscount>1</CouponDiscount> <DeliveryDiscount>1</DeliveryDiscount> <ItemsTotalAmount>5</ItemsTotalAmount> <ItemsTotalTax>6</ItemsTotalTax> <PartnerID>sample string 11</PartnerID> <PartnerName>sample string 12</PartnerName> <PaymentCycleEndDate>2025-12-07T09:58:02.2153639+05:30</PaymentCycleEndDate> <PaymentCycleStartDate>2025-12-07T09:58:02.2153639+05:30</PaymentCycleStartDate> <TotalAmount>4</TotalAmount> <TotalDeliveryFee>9</TotalDeliveryFee> <TotalDeliveryFeeTax>10</TotalDeliveryFeeTax> <TotalDiscountAmount>1</TotalDiscountAmount> <TotalOrders>1</TotalOrders> <TotalRestaurants>2</TotalRestaurants> <TotalTax>3</TotalTax> </RestaurantSalesSummaryView>