GET Reporting/v1/Enterprise/GetVoidsReport

Gets the Discounts 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.
DateFrom	date	Date which the report will start from	None.
DateTo	date	Date which the report will end till	None.
StartTime	time interval		None.
EndTime	time interval		None.

Body Parameters

ReportingEnterpriseRequestCommand

Name	Type	Description	Additional information
SiteIDs	Collection of integer	Site IDs which the report will be run on	None.
DateFrom	date	Date which the report will start from	None.
DateTo	date	Date which the report will end till	None.
StartTime	time interval		None.
EndTime	time interval		None.

Request Formats

application/json, text/json

Sample:

{
  "SiteIDs": [
    1,
    2
  ],
  "DateFrom": "2024-11-21T06:26:36.3214877+00:00",
  "DateTo": "2024-11-21T06:26:36.3214877+00:00",
  "StartTime": "00:00:00.1234567",
  "EndTime": "00:00:00.1234567"
}

application/xml, text/xml

Sample:

<ReportingEnterpriseRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
  <DateFrom>2024-11-21T06:26:36.3214877+00:00</DateFrom>
  <DateTo>2024-11-21T06:26:36.3214877+00:00</DateTo>
  <EndTime>PT0.1234567S</EndTime>
  <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>
</ReportingEnterpriseRequestCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SpfReportsVoidsDto

Name	Type	Additional information
SiteID	integer	None.
SubSiteID	integer	None.
SiteName	string	None.
UserName	string	None.
AuthUserName	string	None.
TransactionID	integer	None.
TransactionItemID	integer	None.
Quantity	decimal number	None.
TotalValue	decimal number	None.
ItemText	string	None.
Measure	string	None.
DateTime	date	None.
LastDateTime	date	None.
Terminal	string	None.
TableForKitchen	string	None.
TransactionVoid	boolean	None.
Reason	string	None.
Produced	string	None.
TotalSales	decimal number	None.
CalcCost	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SiteID": 1,
    "SubSiteID": 1,
    "SiteName": "sample string 1",
    "UserName": "sample string 2",
    "AuthUserName": "sample string 3",
    "TransactionID": 1,
    "TransactionItemID": 1,
    "Quantity": 1.0,
    "TotalValue": 1.0,
    "ItemText": "sample string 4",
    "Measure": "sample string 5",
    "DateTime": "2024-11-21T06:26:36.3214877+00:00",
    "LastDateTime": "2024-11-21T06:26:36.3214877+00:00",
    "Terminal": "sample string 6",
    "TableForKitchen": "sample string 7",
    "TransactionVoid": true,
    "Reason": "sample string 8",
    "Produced": "sample string 9",
    "TotalSales": 1.0,
    "CalcCost": 1.0
  },
  {
    "SiteID": 1,
    "SubSiteID": 1,
    "SiteName": "sample string 1",
    "UserName": "sample string 2",
    "AuthUserName": "sample string 3",
    "TransactionID": 1,
    "TransactionItemID": 1,
    "Quantity": 1.0,
    "TotalValue": 1.0,
    "ItemText": "sample string 4",
    "Measure": "sample string 5",
    "DateTime": "2024-11-21T06:26:36.3214877+00:00",
    "LastDateTime": "2024-11-21T06:26:36.3214877+00:00",
    "Terminal": "sample string 6",
    "TableForKitchen": "sample string 7",
    "TransactionVoid": true,
    "Reason": "sample string 8",
    "Produced": "sample string 9",
    "TotalSales": 1.0,
    "CalcCost": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsVoidsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsVoidsDto>
    <AuthUserName>sample string 3</AuthUserName>
    <CalcCost>1</CalcCost>
    <DateTime>2024-11-21T06:26:36.3214877+00:00</DateTime>
    <ItemText>sample string 4</ItemText>
    <LastDateTime>2024-11-21T06:26:36.3214877+00:00</LastDateTime>
    <Measure>sample string 5</Measure>
    <Produced>sample string 9</Produced>
    <Quantity>1</Quantity>
    <Reason>sample string 8</Reason>
    <SiteID>1</SiteID>
    <SiteName>sample string 1</SiteName>
    <SubSiteID>1</SubSiteID>
    <TableForKitchen>sample string 7</TableForKitchen>
    <Terminal>sample string 6</Terminal>
    <TotalSales>1</TotalSales>
    <TotalValue>1</TotalValue>
    <TransactionID>1</TransactionID>
    <TransactionItemID>1</TransactionItemID>
    <TransactionVoid>true</TransactionVoid>
    <UserName>sample string 2</UserName>
  </SpfReportsVoidsDto>
  <SpfReportsVoidsDto>
    <AuthUserName>sample string 3</AuthUserName>
    <CalcCost>1</CalcCost>
    <DateTime>2024-11-21T06:26:36.3214877+00:00</DateTime>
    <ItemText>sample string 4</ItemText>
    <LastDateTime>2024-11-21T06:26:36.3214877+00:00</LastDateTime>
    <Measure>sample string 5</Measure>
    <Produced>sample string 9</Produced>
    <Quantity>1</Quantity>
    <Reason>sample string 8</Reason>
    <SiteID>1</SiteID>
    <SiteName>sample string 1</SiteName>
    <SubSiteID>1</SubSiteID>
    <TableForKitchen>sample string 7</TableForKitchen>
    <Terminal>sample string 6</Terminal>
    <TotalSales>1</TotalSales>
    <TotalValue>1</TotalValue>
    <TransactionID>1</TransactionID>
    <TransactionItemID>1</TransactionItemID>
    <TransactionVoid>true</TransactionVoid>
    <UserName>sample string 2</UserName>
  </SpfReportsVoidsDto>
</ArrayOfSpfReportsVoidsDto>