GET api/report/z/v2/{businessDay}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| businessDay | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ReportDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Report | ReportV3Dto |
None. |
|
| Status |
Status for response |
RStatus |
None. |
| Desc |
description of response |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 1,
"Desc": "sample string 1",
"Report": {
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Brand": "sample string 3",
"Location": "sample string 4",
"Summary": {
"TotalSales": 1.1,
"NetSales": 2.1,
"SalesTax": 3.1,
"OrderCount": 4,
"Items": [
{
"Details": [
{
"Details": [
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
},
{
"Details": [
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
},
{
"Details": [
{
"Details": [
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
},
{
"Details": [
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Count": 1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
}
]
},
"TransactionTypes": [
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Details": [
{
"Details": [
{
"Count": 1,
"Percentage": 1.1,
"Details": [
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
},
{
"Count": 1,
"Percentage": 1.1,
"Details": [
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
},
{
"Details": [
{
"Count": 1,
"Percentage": 1.1,
"Details": [
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
},
{
"Count": 1,
"Percentage": 1.1,
"Details": [
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
},
{
"Percentage": 1.1,
"Title": "sample string 2",
"AltTitle": "sample string 3",
"Amount": 4.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
}
],
"Title": "sample string 1",
"AltTitle": "sample string 2",
"Amount": 3.1
}
]
}
}
text/xml
Sample:
<ReportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.Response">
<Desc>sample string 1</Desc>
<Status>Success</Status>
<Report>
<AltTitle>sample string 2</AltTitle>
<BaseUTC>5</BaseUTC>
<Brand>sample string 3</Brand>
<Details>
<ReportDetail>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportDetailChild>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Count>1</Count>
<Details>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
</Details>
<OTID>1</OTID>
<Percentage>1.1</Percentage>
</ReportDetailChild>
<ReportDetailChild>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Count>1</Count>
<Details>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
</Details>
<OTID>1</OTID>
<Percentage>1.1</Percentage>
</ReportDetailChild>
</Details>
</ReportDetail>
<ReportDetail>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportDetailChild>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Count>1</Count>
<Details>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
</Details>
<OTID>1</OTID>
<Percentage>1.1</Percentage>
</ReportDetailChild>
<ReportDetailChild>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Count>1</Count>
<Details>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
</Details>
<OTID>1</OTID>
<Percentage>1.1</Percentage>
</ReportDetailChild>
</Details>
</ReportDetail>
</Details>
<Location>sample string 4</Location>
<Summary>
<Items>
<ReportSummaryItem>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportSummaryItemDetail>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
</Details>
</ReportSummaryItemDetail>
<ReportSummaryItemDetail>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
</Details>
</ReportSummaryItemDetail>
</Details>
</ReportSummaryItem>
<ReportSummaryItem>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportSummaryItemDetail>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
</Details>
</ReportSummaryItemDetail>
<ReportSummaryItemDetail>
<AltTitle>sample string 2</AltTitle>
<Amount>3.1</Amount>
<Title>sample string 1</Title>
<Details>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
<ReportDetailCount>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Count>1</Count>
</ReportDetailCount>
</Details>
</ReportSummaryItemDetail>
</Details>
</ReportSummaryItem>
</Items>
<NetSales>2.1</NetSales>
<OrderCount>4</OrderCount>
<SalesTax>3.1</SalesTax>
<TotalSales>1.1</TotalSales>
</Summary>
<Title>sample string 1</Title>
<TransactionTypes>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
<ReportDetailPercentage>
<AltTitle>sample string 3</AltTitle>
<Amount>4.1</Amount>
<Title>sample string 2</Title>
<Percentage>1.1</Percentage>
</ReportDetailPercentage>
</TransactionTypes>
</Report>
</ReportDto>