GET api/report/z/{businessDay}
Get Z Report
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| businessDay |
Date for which data to fetch |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ZReportDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | RStatus |
None. |
|
| Description | string |
None. |
|
| ReportCalc | Collection of SalesCalculation |
None. |
Response Formats
application/json
Sample:
{
"ReportCalc": [
{
"TotalSales": 42.0,
"Cash": 10.5,
"Card": 0.0,
"GiftCards": 0.0,
"Loyalty": 0.0,
"Voucher": 0.0,
"Wallet": 10.5,
"Aggregator": 21.0,
"CashRefunds": 0.0,
"CashInHand": 10.5,
"NetSales": 40.0,
"Discount": 0.0,
"Void": 0.0,
"Complimentary": 0.0,
"Refunds": 0.0,
"Tax": 2.0,
"Gratuity": 0.0,
"Charges": 0.0,
"TotalOrders": 4.0,
"ItemSold": 4.0,
"RefundedItems": 0.0,
"VoidOrderCount": 0.0,
"Date": "2020-07-20-00-00-00",
"CardDetails": {
"Mada": 0.0,
"Visa": 0.0,
"MasterCard": 0.0,
"AmericanExpress": 0.0,
"Other": 0.0
},
"WebOrderSales": [],
"WebOrderCounts": [],
"OrderTypeSales": [
{
"OrderType": "Take Away",
"Count": 1,
"Amount": 10.5,
"Percentage": 25.0,
"PaymentMethodSales": [
{
"PaymentMethod": "Wallet",
"Count": 1,
"Amount": 10.5,
"Percentage": 100.0
}
]
},
{
"OrderType": "Dine In",
"Count": 0,
"Amount": 0.0,
"Percentage": 0.0,
"PaymentMethodSales": []
},
{
"OrderType": "Pick Up",
"Count": 3,
"Amount": 31.5,
"Percentage": 75.0,
"PaymentMethodSales": [
{
"PaymentMethod": "Aggregator",
"Count": 2,
"Amount": 21.0,
"Percentage": 66.67
},
{
"PaymentMethod": "Cash",
"Count": 1,
"Amount": 10.5,
"Percentage": 33.33
}
]
},
{
"OrderType": "Delivery",
"Count": 0,
"Amount": 0.0,
"Percentage": 0.0,
"PaymentMethodSales": []
},
{
"OrderType": "Jahez",
"Count": 0,
"Amount": 0.0,
"Percentage": 0.0,
"PaymentMethodSales": []
},
{
"OrderType": "Hunger Station",
"Count": 0,
"Amount": 0.0,
"Percentage": 0.0,
"PaymentMethodSales": []
},
{
"OrderType": "Jahez",
"Count": 0,
"Amount": 0.0,
"Percentage": 0.0,
"PaymentMethodSales": []
}
]
}
],
"Status": 1,
"Description": "Report Data Successfully Fetched"
}
text/json
Sample:
{
"ReportCalc": [
{
"TotalSales": 1.1,
"Cash": 1.1,
"Card": 1.1,
"GiftCards": 1.1,
"Loyalty": 1.1,
"Voucher": 1.1,
"Wallet": 1.1,
"Aggregator": 1.1,
"CashRefunds": 1.1,
"CashInHand": 1.1,
"NetSales": 1.1,
"Discount": 1.1,
"Void": 1.1,
"Complimentary": 1.1,
"Refunds": 1.1,
"Tax": 1.1,
"Gratuity": 1.1,
"Charges": 1.1,
"TotalOrders": 1.1,
"ItemSold": 1.1,
"RefundedItems": 1.1,
"VoidOrderCount": 1.1,
"Date": "sample string 1",
"CardDetails": {
"sample string 1": 2.1,
"sample string 3": 4.1
},
"WebOrderSales": [
{
"Name": "sample string 1",
"Amount": 2.1
},
{
"Name": "sample string 1",
"Amount": 2.1
}
],
"WebOrderCounts": [
{
"Name": "sample string 1",
"Count": 2
},
{
"Name": "sample string 1",
"Count": 2
}
],
"OrderTypeSales": [
{
"OrderType": "sample string 2",
"Count": 3,
"Amount": 4.1,
"Percentage": 5.1,
"PaymentMethodSales": [
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
},
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
}
]
},
{
"OrderType": "sample string 2",
"Count": 3,
"Amount": 4.1,
"Percentage": 5.1,
"PaymentMethodSales": [
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
},
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
}
]
}
]
},
{
"TotalSales": 1.1,
"Cash": 1.1,
"Card": 1.1,
"GiftCards": 1.1,
"Loyalty": 1.1,
"Voucher": 1.1,
"Wallet": 1.1,
"Aggregator": 1.1,
"CashRefunds": 1.1,
"CashInHand": 1.1,
"NetSales": 1.1,
"Discount": 1.1,
"Void": 1.1,
"Complimentary": 1.1,
"Refunds": 1.1,
"Tax": 1.1,
"Gratuity": 1.1,
"Charges": 1.1,
"TotalOrders": 1.1,
"ItemSold": 1.1,
"RefundedItems": 1.1,
"VoidOrderCount": 1.1,
"Date": "sample string 1",
"CardDetails": {
"sample string 1": 2.1,
"sample string 3": 4.1
},
"WebOrderSales": [
{
"Name": "sample string 1",
"Amount": 2.1
},
{
"Name": "sample string 1",
"Amount": 2.1
}
],
"WebOrderCounts": [
{
"Name": "sample string 1",
"Count": 2
},
{
"Name": "sample string 1",
"Count": 2
}
],
"OrderTypeSales": [
{
"OrderType": "sample string 2",
"Count": 3,
"Amount": 4.1,
"Percentage": 5.1,
"PaymentMethodSales": [
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
},
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
}
]
},
{
"OrderType": "sample string 2",
"Count": 3,
"Amount": 4.1,
"Percentage": 5.1,
"PaymentMethodSales": [
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
},
{
"PaymentMethod": "sample string 1",
"Count": 2,
"Amount": 3.1,
"Percentage": 4.1
}
]
}
]
}
],
"Status": 1,
"Description": "sample string 1"
}
text/xml
Sample:
<ZReportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.Response">
<Description>sample string 1</Description>
<ReportCalc>
<SalesCalculation>
<TotalSales>1.1</TotalSales>
<Cash>1.1</Cash>
<Card>1.1</Card>
<GiftCards>1.1</GiftCards>
<Loyalty>1.1</Loyalty>
<Aggregator>1.1</Aggregator>
<Voucher>1.1</Voucher>
<Wallet>1.1</Wallet>
<CashRefunds>1.1</CashRefunds>
<CashInHand>1.1</CashInHand>
<NetSales>1.1</NetSales>
<Discount>1.1</Discount>
<Void>1.1</Void>
<Complimentary>1.1</Complimentary>
<Refunds>1.1</Refunds>
<Tax>1.1</Tax>
<Gratuity>1.1</Gratuity>
<Charges>1.1</Charges>
<TotalOrders>1.1</TotalOrders>
<ItemSold>1.1</ItemSold>
<RefundedItems>1.1</RefundedItems>
<VoidOrderCount>1.1</VoidOrderCount>
<Date>sample string 1</Date>
<CardDetails xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringfloat>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>2.1</d4p1:Value>
</d4p1:KeyValueOfstringfloat>
<d4p1:KeyValueOfstringfloat>
<d4p1:Key>sample string 3</d4p1:Key>
<d4p1:Value>4.1</d4p1:Value>
</d4p1:KeyValueOfstringfloat>
</CardDetails>
<WebOrderSales>
<WebSales>
<Name>sample string 1</Name>
<Amount>2.1</Amount>
</WebSales>
<WebSales>
<Name>sample string 1</Name>
<Amount>2.1</Amount>
</WebSales>
</WebOrderSales>
<WebOrderCounts>
<WebOrderCount>
<Name>sample string 1</Name>
<Count>2</Count>
</WebOrderCount>
<WebOrderCount>
<Name>sample string 1</Name>
<Count>2</Count>
</WebOrderCount>
</WebOrderCounts>
<OrderTypeSales>
<OrderTypeSale>
<OrderType>sample string 2</OrderType>
<Count>3</Count>
<Amount>4.1</Amount>
<Percentage>5.1</Percentage>
<PaymentMethodSales>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
</PaymentMethodSales>
</OrderTypeSale>
<OrderTypeSale>
<OrderType>sample string 2</OrderType>
<Count>3</Count>
<Amount>4.1</Amount>
<Percentage>5.1</Percentage>
<PaymentMethodSales>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
</PaymentMethodSales>
</OrderTypeSale>
</OrderTypeSales>
</SalesCalculation>
<SalesCalculation>
<TotalSales>1.1</TotalSales>
<Cash>1.1</Cash>
<Card>1.1</Card>
<GiftCards>1.1</GiftCards>
<Loyalty>1.1</Loyalty>
<Aggregator>1.1</Aggregator>
<Voucher>1.1</Voucher>
<Wallet>1.1</Wallet>
<CashRefunds>1.1</CashRefunds>
<CashInHand>1.1</CashInHand>
<NetSales>1.1</NetSales>
<Discount>1.1</Discount>
<Void>1.1</Void>
<Complimentary>1.1</Complimentary>
<Refunds>1.1</Refunds>
<Tax>1.1</Tax>
<Gratuity>1.1</Gratuity>
<Charges>1.1</Charges>
<TotalOrders>1.1</TotalOrders>
<ItemSold>1.1</ItemSold>
<RefundedItems>1.1</RefundedItems>
<VoidOrderCount>1.1</VoidOrderCount>
<Date>sample string 1</Date>
<CardDetails xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringfloat>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>2.1</d4p1:Value>
</d4p1:KeyValueOfstringfloat>
<d4p1:KeyValueOfstringfloat>
<d4p1:Key>sample string 3</d4p1:Key>
<d4p1:Value>4.1</d4p1:Value>
</d4p1:KeyValueOfstringfloat>
</CardDetails>
<WebOrderSales>
<WebSales>
<Name>sample string 1</Name>
<Amount>2.1</Amount>
</WebSales>
<WebSales>
<Name>sample string 1</Name>
<Amount>2.1</Amount>
</WebSales>
</WebOrderSales>
<WebOrderCounts>
<WebOrderCount>
<Name>sample string 1</Name>
<Count>2</Count>
</WebOrderCount>
<WebOrderCount>
<Name>sample string 1</Name>
<Count>2</Count>
</WebOrderCount>
</WebOrderCounts>
<OrderTypeSales>
<OrderTypeSale>
<OrderType>sample string 2</OrderType>
<Count>3</Count>
<Amount>4.1</Amount>
<Percentage>5.1</Percentage>
<PaymentMethodSales>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
</PaymentMethodSales>
</OrderTypeSale>
<OrderTypeSale>
<OrderType>sample string 2</OrderType>
<Count>3</Count>
<Amount>4.1</Amount>
<Percentage>5.1</Percentage>
<PaymentMethodSales>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
<PaymentMethodSale>
<PaymentMethod>sample string 1</PaymentMethod>
<Count>2</Count>
<Amount>3.1</Amount>
<Percentage>4.1</Percentage>
</PaymentMethodSale>
</PaymentMethodSales>
</OrderTypeSale>
</OrderTypeSales>
</SalesCalculation>
</ReportCalc>
<Status>Success</Status>
</ZReportDto>