GET Reporting/v1/Enterprise/GetFullTransactionItemsReport

Gets the Full Transactions 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:37:33.4568606+00:00",
  "DateTo": "2024-11-21T06:37:33.4568606+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:37:33.4568606+00:00</DateFrom>
  <DateTo>2024-11-21T06:37:33.4568606+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 SpfReportsFullTransactionItemsDto

Name	Type	Additional information
SiteName	string	None.
Session	string	None.
TransactionID	integer	None.
TransactionItemID	integer	None.
TransactionItemOptionID	integer	None.
TransactionCloseTime	date	None.
ItemTime	date	None.
TableNo	integer	None.
TableName	string	None.
Covers	integer	None.
Terminal	string	None.
OrderArea	string	None.
SalesArea	string	None.
ProductTypeID	integer	None.
ProductTypeName	string	None.
ProductGroupID	integer	None.
ProductGroupName	string	None.
ProductID	integer	None.
ProductName	string	None.
MeasureID	integer	None.
MeasureName	string	None.
PriceGroupID	integer	None.
PriceGroupName	string	None.
Quantity	decimal number	None.
UnitQuantity	decimal number	None.
TotalGross	decimal number	None.
TotalNet	decimal number	None.
TotalTax	decimal number	None.
ExpTotalGross	decimal number	None.
ExpTotalNet	decimal number	None.
FinalisedUser	string	None.
ItemOrderUser	string	None.
PLU	string	None.
CalcCost	decimal number	None.
ExternalMemberID	string	None.
CustomerName	string	None.
TransactionTenders	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SiteName": "sample string 1",
    "Session": "sample string 2",
    "TransactionID": 3,
    "TransactionItemID": 4,
    "TransactionItemOptionID": 5,
    "TransactionCloseTime": "2024-11-21T06:37:33.4568606+00:00",
    "ItemTime": "2024-11-21T06:37:33.4568606+00:00",
    "TableNo": 8,
    "TableName": "sample string 9",
    "Covers": 10,
    "Terminal": "sample string 11",
    "OrderArea": "sample string 12",
    "SalesArea": "sample string 13",
    "ProductTypeID": 14,
    "ProductTypeName": "sample string 15",
    "ProductGroupID": 16,
    "ProductGroupName": "sample string 17",
    "ProductID": 18,
    "ProductName": "sample string 19",
    "MeasureID": 20,
    "MeasureName": "sample string 21",
    "PriceGroupID": 22,
    "PriceGroupName": "sample string 23",
    "Quantity": 24.0,
    "UnitQuantity": 25.0,
    "TotalGross": 26.0,
    "TotalNet": 27.0,
    "TotalTax": 28.0,
    "ExpTotalGross": 29.0,
    "ExpTotalNet": 30.0,
    "FinalisedUser": "sample string 31",
    "ItemOrderUser": "sample string 32",
    "PLU": "sample string 33",
    "CalcCost": 34.0,
    "ExternalMemberID": "sample string 35",
    "CustomerName": "sample string 36",
    "TransactionTenders": "sample string 37"
  },
  {
    "SiteName": "sample string 1",
    "Session": "sample string 2",
    "TransactionID": 3,
    "TransactionItemID": 4,
    "TransactionItemOptionID": 5,
    "TransactionCloseTime": "2024-11-21T06:37:33.4568606+00:00",
    "ItemTime": "2024-11-21T06:37:33.4568606+00:00",
    "TableNo": 8,
    "TableName": "sample string 9",
    "Covers": 10,
    "Terminal": "sample string 11",
    "OrderArea": "sample string 12",
    "SalesArea": "sample string 13",
    "ProductTypeID": 14,
    "ProductTypeName": "sample string 15",
    "ProductGroupID": 16,
    "ProductGroupName": "sample string 17",
    "ProductID": 18,
    "ProductName": "sample string 19",
    "MeasureID": 20,
    "MeasureName": "sample string 21",
    "PriceGroupID": 22,
    "PriceGroupName": "sample string 23",
    "Quantity": 24.0,
    "UnitQuantity": 25.0,
    "TotalGross": 26.0,
    "TotalNet": 27.0,
    "TotalTax": 28.0,
    "ExpTotalGross": 29.0,
    "ExpTotalNet": 30.0,
    "FinalisedUser": "sample string 31",
    "ItemOrderUser": "sample string 32",
    "PLU": "sample string 33",
    "CalcCost": 34.0,
    "ExternalMemberID": "sample string 35",
    "CustomerName": "sample string 36",
    "TransactionTenders": "sample string 37"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsFullTransactionItemsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsFullTransactionItemsDto>
    <CalcCost>34</CalcCost>
    <Covers>10</Covers>
    <CustomerName>sample string 36</CustomerName>
    <ExpTotalGross>29</ExpTotalGross>
    <ExpTotalNet>30</ExpTotalNet>
    <ExternalMemberID>sample string 35</ExternalMemberID>
    <FinalisedUser>sample string 31</FinalisedUser>
    <ItemOrderUser>sample string 32</ItemOrderUser>
    <ItemTime>2024-11-21T06:37:33.4568606+00:00</ItemTime>
    <MeasureID>20</MeasureID>
    <MeasureName>sample string 21</MeasureName>
    <OrderArea>sample string 12</OrderArea>
    <PLU>sample string 33</PLU>
    <PriceGroupID>22</PriceGroupID>
    <PriceGroupName>sample string 23</PriceGroupName>
    <ProductGroupID>16</ProductGroupID>
    <ProductGroupName>sample string 17</ProductGroupName>
    <ProductID>18</ProductID>
    <ProductName>sample string 19</ProductName>
    <ProductTypeID>14</ProductTypeID>
    <ProductTypeName>sample string 15</ProductTypeName>
    <Quantity>24</Quantity>
    <SalesArea>sample string 13</SalesArea>
    <Session>sample string 2</Session>
    <SiteName>sample string 1</SiteName>
    <TableName>sample string 9</TableName>
    <TableNo>8</TableNo>
    <Terminal>sample string 11</Terminal>
    <TotalGross>26</TotalGross>
    <TotalNet>27</TotalNet>
    <TotalTax>28</TotalTax>
    <TransactionCloseTime>2024-11-21T06:37:33.4568606+00:00</TransactionCloseTime>
    <TransactionID>3</TransactionID>
    <TransactionItemID>4</TransactionItemID>
    <TransactionItemOptionID>5</TransactionItemOptionID>
    <TransactionTenders>sample string 37</TransactionTenders>
    <UnitQuantity>25</UnitQuantity>
  </SpfReportsFullTransactionItemsDto>
  <SpfReportsFullTransactionItemsDto>
    <CalcCost>34</CalcCost>
    <Covers>10</Covers>
    <CustomerName>sample string 36</CustomerName>
    <ExpTotalGross>29</ExpTotalGross>
    <ExpTotalNet>30</ExpTotalNet>
    <ExternalMemberID>sample string 35</ExternalMemberID>
    <FinalisedUser>sample string 31</FinalisedUser>
    <ItemOrderUser>sample string 32</ItemOrderUser>
    <ItemTime>2024-11-21T06:37:33.4568606+00:00</ItemTime>
    <MeasureID>20</MeasureID>
    <MeasureName>sample string 21</MeasureName>
    <OrderArea>sample string 12</OrderArea>
    <PLU>sample string 33</PLU>
    <PriceGroupID>22</PriceGroupID>
    <PriceGroupName>sample string 23</PriceGroupName>
    <ProductGroupID>16</ProductGroupID>
    <ProductGroupName>sample string 17</ProductGroupName>
    <ProductID>18</ProductID>
    <ProductName>sample string 19</ProductName>
    <ProductTypeID>14</ProductTypeID>
    <ProductTypeName>sample string 15</ProductTypeName>
    <Quantity>24</Quantity>
    <SalesArea>sample string 13</SalesArea>
    <Session>sample string 2</Session>
    <SiteName>sample string 1</SiteName>
    <TableName>sample string 9</TableName>
    <TableNo>8</TableNo>
    <Terminal>sample string 11</Terminal>
    <TotalGross>26</TotalGross>
    <TotalNet>27</TotalNet>
    <TotalTax>28</TotalTax>
    <TransactionCloseTime>2024-11-21T06:37:33.4568606+00:00</TransactionCloseTime>
    <TransactionID>3</TransactionID>
    <TransactionItemID>4</TransactionItemID>
    <TransactionItemOptionID>5</TransactionItemOptionID>
    <TransactionTenders>sample string 37</TransactionTenders>
    <UnitQuantity>25</UnitQuantity>
  </SpfReportsFullTransactionItemsDto>
</ArrayOfSpfReportsFullTransactionItemsDto>