GET Reporting/v1/Enterprise/GetFullSalesBreakdownReportByDay
Gets the Full Sales Breakdown Report By Day report data for given sites.
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteIDs | Collection of integer |
Site IDs which the report will be run on |
None. |
| ProductTypeIDs | Collection of integer |
Optional: will refine report by given product type IDs, if empty will not refine the report |
None. |
| DateFrom | date |
Date which the report will start from |
None. |
| DateTo | date |
Date which the report will end till |
None. |
| StartTime | time interval |
Start time the report will look for sales in a day. Provide Null to return all data in each day. |
None. |
| EndTime | time interval |
End time the report will look for sales in a day. Provide Null to return all data in each day. |
None. |
Body Parameters
ReportingSalesRequestCommand| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteIDs | Collection of integer |
Site IDs which the report will be run on |
None. |
| ProductTypeIDs | Collection of integer |
Optional: will refine report by given product type IDs, if empty will not refine the report |
None. |
| DateFrom | date |
Date which the report will start from |
None. |
| DateTo | date |
Date which the report will end till |
None. |
| StartTime | time interval |
Start time the report will look for sales in a day. Provide Null to return all data in each day. |
None. |
| EndTime | time interval |
End time the report will look for sales in a day. Provide Null to return all data in each day. |
None. |
Request Formats
application/json, text/json
{
"SiteIDs": [
1,
2
],
"ProductTypeIDs": [
1,
2
],
"DateFrom": "2025-11-07T23:49:07.858542",
"DateTo": "2025-11-07T23:49:07.858542",
"StartTime": "00:00:00.1234567",
"EndTime": "00:00:00.1234567"
}
application/xml, text/xml
<ReportingSalesRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
<DateFrom>2025-11-07T23:49:07.858542</DateFrom>
<DateTo>2025-11-07T23:49:07.858542</DateTo>
<EndTime>PT0.1234567S</EndTime>
<ProductTypeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ProductTypeIDs>
<SiteIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</SiteIDs>
<StartTime>PT0.1234567S</StartTime>
</ReportingSalesRequestCommand>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Collection of SpfReportsFullSalesByDayDto| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteName | string |
None. |
|
| SiteID | integer |
None. |
|
| Date | string |
None. |
|
| WeekNo | integer |
None. |
|
| ProductID | integer |
None. |
|
| MeasureID | integer |
None. |
|
| Quantity | decimal number |
None. |
|
| AvgCost | decimal number |
None. |
|
| TotalCost | decimal number |
None. |
|
| ExpNet | decimal number |
None. |
|
| ActNet | decimal number |
None. |
|
| ExpGross | decimal number |
None. |
|
| ActGross | decimal number |
None. |
|
| ActTax | decimal number |
None. |
|
| Variance | decimal number |
None. |
|
| GP | decimal number |
None. |
|
| SalesPC | decimal number |
None. |
|
| Price | decimal number |
None. |
|
| Covers | integer |
None. |
|
| TotalCovers | integer |
None. |
|
| TotalTransactions | integer |
None. |
|
| ProductName | string |
None. |
|
| ProductGroupName | string |
None. |
|
| ProductTypeName | string |
None. |
|
| MeasureName | string |
None. |
Response Formats
application/json, text/json
[
{
"SiteName": "sample string 1",
"SiteID": 1,
"Date": "sample string 2",
"WeekNo": 1,
"ProductID": 1,
"MeasureID": 1,
"Quantity": 1.0,
"AvgCost": 1.0,
"TotalCost": 1.0,
"ExpNet": 1.0,
"ActNet": 1.0,
"ExpGross": 1.0,
"ActGross": 1.0,
"ActTax": 1.0,
"Variance": 1.0,
"GP": 1.0,
"SalesPC": 1.1,
"Price": 1.0,
"Covers": 1,
"TotalCovers": 1,
"TotalTransactions": 1,
"ProductName": "sample string 3",
"ProductGroupName": "sample string 4",
"ProductTypeName": "sample string 5",
"MeasureName": "sample string 6"
},
{
"SiteName": "sample string 1",
"SiteID": 1,
"Date": "sample string 2",
"WeekNo": 1,
"ProductID": 1,
"MeasureID": 1,
"Quantity": 1.0,
"AvgCost": 1.0,
"TotalCost": 1.0,
"ExpNet": 1.0,
"ActNet": 1.0,
"ExpGross": 1.0,
"ActGross": 1.0,
"ActTax": 1.0,
"Variance": 1.0,
"GP": 1.0,
"SalesPC": 1.1,
"Price": 1.0,
"Covers": 1,
"TotalCovers": 1,
"TotalTransactions": 1,
"ProductName": "sample string 3",
"ProductGroupName": "sample string 4",
"ProductTypeName": "sample string 5",
"MeasureName": "sample string 6"
}
]
application/xml, text/xml
<ArrayOfSpfReportsFullSalesByDayDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
<SpfReportsFullSalesByDayDto>
<ActGross>1</ActGross>
<ActNet>1</ActNet>
<ActTax>1</ActTax>
<AvgCost>1</AvgCost>
<Covers>1</Covers>
<Date>sample string 2</Date>
<ExpGross>1</ExpGross>
<ExpNet>1</ExpNet>
<GP>1</GP>
<MeasureID>1</MeasureID>
<MeasureName>sample string 6</MeasureName>
<Price>1</Price>
<ProductGroupName>sample string 4</ProductGroupName>
<ProductID>1</ProductID>
<ProductName>sample string 3</ProductName>
<ProductTypeName>sample string 5</ProductTypeName>
<Quantity>1</Quantity>
<SalesPC>1.1</SalesPC>
<SiteID>1</SiteID>
<SiteName>sample string 1</SiteName>
<TotalCost>1</TotalCost>
<TotalCovers>1</TotalCovers>
<TotalTransactions>1</TotalTransactions>
<Variance>1</Variance>
<WeekNo>1</WeekNo>
</SpfReportsFullSalesByDayDto>
<SpfReportsFullSalesByDayDto>
<ActGross>1</ActGross>
<ActNet>1</ActNet>
<ActTax>1</ActTax>
<AvgCost>1</AvgCost>
<Covers>1</Covers>
<Date>sample string 2</Date>
<ExpGross>1</ExpGross>
<ExpNet>1</ExpNet>
<GP>1</GP>
<MeasureID>1</MeasureID>
<MeasureName>sample string 6</MeasureName>
<Price>1</Price>
<ProductGroupName>sample string 4</ProductGroupName>
<ProductID>1</ProductID>
<ProductName>sample string 3</ProductName>
<ProductTypeName>sample string 5</ProductTypeName>
<Quantity>1</Quantity>
<SalesPC>1.1</SalesPC>
<SiteID>1</SiteID>
<SiteName>sample string 1</SiteName>
<TotalCost>1</TotalCost>
<TotalCovers>1</TotalCovers>
<TotalTransactions>1</TotalTransactions>
<Variance>1</Variance>
<WeekNo>1</WeekNo>
</SpfReportsFullSalesByDayDto>
</ArrayOfSpfReportsFullSalesByDayDto>