GET Reporting/v1/Enterprise/GetFullTransactionsReport

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:23:25.5193107+00:00",
  "DateTo": "2024-11-21T06:23:25.5193107+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:23:25.5193107+00:00</DateFrom>
  <DateTo>2024-11-21T06:23:25.5193107+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 SpfReportsFullTransactionsDto

Name	Type	Additional information
SiteName	string	None.
SalesArea	string	None.
TransactionID	integer	None.
TransactionOpened	date	None.
TransactionClosed	date	None.
UserClosedBy	string	None.
TableNo	integer	None.
Covers	integer	None.
TenderType	string	None.
ThirdPartyReference	string	None.
Amount	decimal number	None.
CustomerName	string	None.
ExternalMembershipID	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SiteName": "sample string 1",
    "SalesArea": "sample string 2",
    "TransactionID": 3,
    "TransactionOpened": "2024-11-21T06:23:25.5350252+00:00",
    "TransactionClosed": "2024-11-21T06:23:25.5350252+00:00",
    "UserClosedBy": "sample string 6",
    "TableNo": 7,
    "Covers": 1,
    "TenderType": "sample string 8",
    "ThirdPartyReference": "sample string 9",
    "Amount": 1.0,
    "CustomerName": "sample string 10",
    "ExternalMembershipID": "sample string 11"
  },
  {
    "SiteName": "sample string 1",
    "SalesArea": "sample string 2",
    "TransactionID": 3,
    "TransactionOpened": "2024-11-21T06:23:25.5350252+00:00",
    "TransactionClosed": "2024-11-21T06:23:25.5350252+00:00",
    "UserClosedBy": "sample string 6",
    "TableNo": 7,
    "Covers": 1,
    "TenderType": "sample string 8",
    "ThirdPartyReference": "sample string 9",
    "Amount": 1.0,
    "CustomerName": "sample string 10",
    "ExternalMembershipID": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsFullTransactionsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsFullTransactionsDto>
    <Amount>1</Amount>
    <Covers>1</Covers>
    <CustomerName>sample string 10</CustomerName>
    <ExternalMembershipID>sample string 11</ExternalMembershipID>
    <SalesArea>sample string 2</SalesArea>
    <SiteName>sample string 1</SiteName>
    <TableNo>7</TableNo>
    <TenderType>sample string 8</TenderType>
    <ThirdPartyReference>sample string 9</ThirdPartyReference>
    <TransactionClosed>2024-11-21T06:23:25.5350252+00:00</TransactionClosed>
    <TransactionID>3</TransactionID>
    <TransactionOpened>2024-11-21T06:23:25.5350252+00:00</TransactionOpened>
    <UserClosedBy>sample string 6</UserClosedBy>
  </SpfReportsFullTransactionsDto>
  <SpfReportsFullTransactionsDto>
    <Amount>1</Amount>
    <Covers>1</Covers>
    <CustomerName>sample string 10</CustomerName>
    <ExternalMembershipID>sample string 11</ExternalMembershipID>
    <SalesArea>sample string 2</SalesArea>
    <SiteName>sample string 1</SiteName>
    <TableNo>7</TableNo>
    <TenderType>sample string 8</TenderType>
    <ThirdPartyReference>sample string 9</ThirdPartyReference>
    <TransactionClosed>2024-11-21T06:23:25.5350252+00:00</TransactionClosed>
    <TransactionID>3</TransactionID>
    <TransactionOpened>2024-11-21T06:23:25.5350252+00:00</TransactionOpened>
    <UserClosedBy>sample string 6</UserClosedBy>
  </SpfReportsFullTransactionsDto>
</ArrayOfSpfReportsFullTransactionsDto>