POST DailyPerformanceReport/GenerateReport
Request Information
URI Parameters
None.
Body Parameters
IConnect.Domain.Reports.SalesReport.DailyPerformanceReport.ReportViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SelectedType | IConnect.Domain.Reports.ProductType |
None. |
|
| ExcludeGiftCards | boolean |
None. |
|
| AreMultipleLocationsSelected | boolean |
None. |
|
| SelectedCompanies | Collection of integer |
None. |
|
| OrderSource | IConnect.Domain.Orders.DisplayOrderSource |
None. |
|
| Start | date |
None. |
|
| End | date |
None. |
|
| StartDateObjectString | string |
None. |
|
| EndDateObjectString | string |
None. |
|
| SkipTimeZoneConvertion | boolean |
None. |
|
| ForceImmediateExport | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"SelectedType": 0,
"ExcludeGiftCards": true,
"AreMultipleLocationsSelected": true,
"SelectedCompanies": [
1,
2
],
"OrderSource": 1,
"Start": "2024-10-18T04:39:04.5380546-04:00",
"End": "2024-10-18T04:39:04.5380546-04:00",
"StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":39,\"seconds\":4,\"miliseconds\":538}",
"EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":39,\"seconds\":4,\"miliseconds\":538}",
"SkipTimeZoneConvertion": true,
"ForceImmediateExport": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IConnect.Core.PagedListOfIConnect.Domain.Reports.SalesReport.DailyPerformanceReport.ReportItem| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of IConnect.Domain.Reports.SalesReport.DailyPerformanceReport.ReportItem |
None. |
|
| Footer | IConnect.Domain.Reports.SalesReport.DailyPerformanceReport.ReportItem |
None. |
|
| PageFooter | IConnect.Domain.Reports.SalesReport.DailyPerformanceReport.ReportItem |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalRows | integer |
None. |
|
| TotalPages | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"LocationId": 1,
"LocationName": "sample string 2",
"Date": "2024-10-18T04:39:04.5380546-04:00",
"DateFormatted": "sample string 4",
"Day": "Friday",
"SalePrice": 5.0,
"ReturnsPrice": 6.0,
"Discounts": 7.0,
"Subtotal": 8.0,
"SubtotalWithoutZeroCostServices": 9.0,
"Tax": 10.0,
"OverallSales": 11.0,
"NumberOfTickets": 12,
"QtySales": 13.0,
"QtyReturns": 14.0,
"TotalQty": 27.0,
"TicketAvg": 0.67,
"QtyAvgPerTicket": 2.25,
"Customers": 31,
"NewCustomers": 15,
"RecurringCustomers": 16,
"CostOfSales": 17.0,
"Margin": -0.88888888888888884,
"ReportDisplayMargin": -88.888888888888886,
"SalesGoal": 18.0,
"VarianceToGoalAmount": 7.0,
"VarianceToGoalPercentage": 0.3888888888888889,
"ReportDisplayVarianceToGoalPercentage": 38.888888888888886
},
{
"LocationId": 1,
"LocationName": "sample string 2",
"Date": "2024-10-18T04:39:04.5380546-04:00",
"DateFormatted": "sample string 4",
"Day": "Friday",
"SalePrice": 5.0,
"ReturnsPrice": 6.0,
"Discounts": 7.0,
"Subtotal": 8.0,
"SubtotalWithoutZeroCostServices": 9.0,
"Tax": 10.0,
"OverallSales": 11.0,
"NumberOfTickets": 12,
"QtySales": 13.0,
"QtyReturns": 14.0,
"TotalQty": 27.0,
"TicketAvg": 0.67,
"QtyAvgPerTicket": 2.25,
"Customers": 31,
"NewCustomers": 15,
"RecurringCustomers": 16,
"CostOfSales": 17.0,
"Margin": -0.88888888888888884,
"ReportDisplayMargin": -88.888888888888886,
"SalesGoal": 18.0,
"VarianceToGoalAmount": 7.0,
"VarianceToGoalPercentage": 0.3888888888888889,
"ReportDisplayVarianceToGoalPercentage": 38.888888888888886
}
],
"Footer": {
"LocationId": 1,
"LocationName": "sample string 2",
"Date": "2024-10-18T04:39:04.5380546-04:00",
"DateFormatted": "sample string 4",
"Day": "Friday",
"SalePrice": 5.0,
"ReturnsPrice": 6.0,
"Discounts": 7.0,
"Subtotal": 8.0,
"SubtotalWithoutZeroCostServices": 9.0,
"Tax": 10.0,
"OverallSales": 11.0,
"NumberOfTickets": 12,
"QtySales": 13.0,
"QtyReturns": 14.0,
"TotalQty": 27.0,
"TicketAvg": 0.67,
"QtyAvgPerTicket": 2.25,
"Customers": 31,
"NewCustomers": 15,
"RecurringCustomers": 16,
"CostOfSales": 17.0,
"Margin": -0.88888888888888884,
"ReportDisplayMargin": -88.888888888888886,
"SalesGoal": 18.0,
"VarianceToGoalAmount": 7.0,
"VarianceToGoalPercentage": 0.3888888888888889,
"ReportDisplayVarianceToGoalPercentage": 38.888888888888886
},
"PageFooter": {
"LocationId": 1,
"LocationName": "sample string 2",
"Date": "2024-10-18T04:39:04.5380546-04:00",
"DateFormatted": "sample string 4",
"Day": "Friday",
"SalePrice": 5.0,
"ReturnsPrice": 6.0,
"Discounts": 7.0,
"Subtotal": 8.0,
"SubtotalWithoutZeroCostServices": 9.0,
"Tax": 10.0,
"OverallSales": 11.0,
"NumberOfTickets": 12,
"QtySales": 13.0,
"QtyReturns": 14.0,
"TotalQty": 27.0,
"TicketAvg": 0.67,
"QtyAvgPerTicket": 2.25,
"Customers": 31,
"NewCustomers": 15,
"RecurringCustomers": 16,
"CostOfSales": 17.0,
"Margin": -0.88888888888888884,
"ReportDisplayMargin": -88.888888888888886,
"SalesGoal": 18.0,
"VarianceToGoalAmount": 7.0,
"VarianceToGoalPercentage": 0.3888888888888889,
"ReportDisplayVarianceToGoalPercentage": 38.888888888888886
},
"PageNumber": 1,
"PageSize": 2,
"TotalRows": 3,
"TotalPages": 4
}
application/xml, text/xml
Sample:
<PagedListOfReportItemrkoGBB8F xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core">
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<TotalPages>4</TotalPages>
<TotalRows>3</TotalRows>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.DailyPerformanceReport">
<d2p1:ReportItem>
<d2p1:CostOfSales>17</d2p1:CostOfSales>
<d2p1:Date>2024-10-18T04:39:04.5380546-04:00</d2p1:Date>
<d2p1:DateFormatted>sample string 4</d2p1:DateFormatted>
<d2p1:Discounts>7</d2p1:Discounts>
<d2p1:LocationId>1</d2p1:LocationId>
<d2p1:LocationName>sample string 2</d2p1:LocationName>
<d2p1:NewCustomers>15</d2p1:NewCustomers>
<d2p1:NumberOfTickets>12</d2p1:NumberOfTickets>
<d2p1:OverallSales>11</d2p1:OverallSales>
<d2p1:QtyReturns>14</d2p1:QtyReturns>
<d2p1:QtySales>13</d2p1:QtySales>
<d2p1:RecurringCustomers>16</d2p1:RecurringCustomers>
<d2p1:ReturnsPrice>6</d2p1:ReturnsPrice>
<d2p1:SalePrice>5</d2p1:SalePrice>
<d2p1:SalesGoal>18</d2p1:SalesGoal>
<d2p1:Subtotal>8</d2p1:Subtotal>
<d2p1:SubtotalWithoutZeroCostServices>9</d2p1:SubtotalWithoutZeroCostServices>
<d2p1:Tax>10</d2p1:Tax>
</d2p1:ReportItem>
<d2p1:ReportItem>
<d2p1:CostOfSales>17</d2p1:CostOfSales>
<d2p1:Date>2024-10-18T04:39:04.5380546-04:00</d2p1:Date>
<d2p1:DateFormatted>sample string 4</d2p1:DateFormatted>
<d2p1:Discounts>7</d2p1:Discounts>
<d2p1:LocationId>1</d2p1:LocationId>
<d2p1:LocationName>sample string 2</d2p1:LocationName>
<d2p1:NewCustomers>15</d2p1:NewCustomers>
<d2p1:NumberOfTickets>12</d2p1:NumberOfTickets>
<d2p1:OverallSales>11</d2p1:OverallSales>
<d2p1:QtyReturns>14</d2p1:QtyReturns>
<d2p1:QtySales>13</d2p1:QtySales>
<d2p1:RecurringCustomers>16</d2p1:RecurringCustomers>
<d2p1:ReturnsPrice>6</d2p1:ReturnsPrice>
<d2p1:SalePrice>5</d2p1:SalePrice>
<d2p1:SalesGoal>18</d2p1:SalesGoal>
<d2p1:Subtotal>8</d2p1:Subtotal>
<d2p1:SubtotalWithoutZeroCostServices>9</d2p1:SubtotalWithoutZeroCostServices>
<d2p1:Tax>10</d2p1:Tax>
</d2p1:ReportItem>
</Data>
<Footer xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.DailyPerformanceReport">
<d2p1:CostOfSales>17</d2p1:CostOfSales>
<d2p1:Date>2024-10-18T04:39:04.5380546-04:00</d2p1:Date>
<d2p1:DateFormatted>sample string 4</d2p1:DateFormatted>
<d2p1:Discounts>7</d2p1:Discounts>
<d2p1:LocationId>1</d2p1:LocationId>
<d2p1:LocationName>sample string 2</d2p1:LocationName>
<d2p1:NewCustomers>15</d2p1:NewCustomers>
<d2p1:NumberOfTickets>12</d2p1:NumberOfTickets>
<d2p1:OverallSales>11</d2p1:OverallSales>
<d2p1:QtyReturns>14</d2p1:QtyReturns>
<d2p1:QtySales>13</d2p1:QtySales>
<d2p1:RecurringCustomers>16</d2p1:RecurringCustomers>
<d2p1:ReturnsPrice>6</d2p1:ReturnsPrice>
<d2p1:SalePrice>5</d2p1:SalePrice>
<d2p1:SalesGoal>18</d2p1:SalesGoal>
<d2p1:Subtotal>8</d2p1:Subtotal>
<d2p1:SubtotalWithoutZeroCostServices>9</d2p1:SubtotalWithoutZeroCostServices>
<d2p1:Tax>10</d2p1:Tax>
</Footer>
<PageFooter xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.DailyPerformanceReport">
<d2p1:CostOfSales>17</d2p1:CostOfSales>
<d2p1:Date>2024-10-18T04:39:04.5380546-04:00</d2p1:Date>
<d2p1:DateFormatted>sample string 4</d2p1:DateFormatted>
<d2p1:Discounts>7</d2p1:Discounts>
<d2p1:LocationId>1</d2p1:LocationId>
<d2p1:LocationName>sample string 2</d2p1:LocationName>
<d2p1:NewCustomers>15</d2p1:NewCustomers>
<d2p1:NumberOfTickets>12</d2p1:NumberOfTickets>
<d2p1:OverallSales>11</d2p1:OverallSales>
<d2p1:QtyReturns>14</d2p1:QtyReturns>
<d2p1:QtySales>13</d2p1:QtySales>
<d2p1:RecurringCustomers>16</d2p1:RecurringCustomers>
<d2p1:ReturnsPrice>6</d2p1:ReturnsPrice>
<d2p1:SalePrice>5</d2p1:SalePrice>
<d2p1:SalesGoal>18</d2p1:SalesGoal>
<d2p1:Subtotal>8</d2p1:Subtotal>
<d2p1:SubtotalWithoutZeroCostServices>9</d2p1:SubtotalWithoutZeroCostServices>
<d2p1:Tax>10</d2p1:Tax>
</PageFooter>
</PagedListOfReportItemrkoGBB8F>