GET Reporting/v1/Enterprise/GetTenderBreakdownByUserReport

Gets the Tender Breakdown By User 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:28.6395311+00:00",
  "DateTo": "2024-11-21T06:23:28.6395311+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:28.6395311+00:00</DateFrom>
  <DateTo>2024-11-21T06:23:28.6395311+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 SpfReportsTenderbyTransactionsNewDto

Name	Type	Additional information
TransactionID	integer	None.
SiteName	string	None.
SiteID	integer	None.
SubSiteID	integer	None.
Amount	decimal number	None.
TenderType	string	None.
DateTimeClosed	date	None.
GrossValue	decimal number	None.
NetValue	decimal number	None.
TotalVAT	decimal number	None.
TableNumber	integer	None.
ServiceCharge	decimal number	None.
CoverCharge	decimal number	None.
Terminal	string	None.
UserName	string	None.
Deposit	decimal number	None.
Covers	integer	None.
NeptuneBookingID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "TransactionID": 1,
    "SiteName": "sample string 1",
    "SiteID": 2,
    "SubSiteID": 3,
    "Amount": 1.0,
    "TenderType": "sample string 4",
    "DateTimeClosed": "2024-11-21T06:23:28.6395311+00:00",
    "GrossValue": 1.0,
    "NetValue": 1.0,
    "TotalVAT": 1.0,
    "TableNumber": 6,
    "ServiceCharge": 1.0,
    "CoverCharge": 1.0,
    "Terminal": "sample string 7",
    "UserName": "sample string 8",
    "Deposit": 1.0,
    "Covers": 9,
    "NeptuneBookingID": 10
  },
  {
    "TransactionID": 1,
    "SiteName": "sample string 1",
    "SiteID": 2,
    "SubSiteID": 3,
    "Amount": 1.0,
    "TenderType": "sample string 4",
    "DateTimeClosed": "2024-11-21T06:23:28.6395311+00:00",
    "GrossValue": 1.0,
    "NetValue": 1.0,
    "TotalVAT": 1.0,
    "TableNumber": 6,
    "ServiceCharge": 1.0,
    "CoverCharge": 1.0,
    "Terminal": "sample string 7",
    "UserName": "sample string 8",
    "Deposit": 1.0,
    "Covers": 9,
    "NeptuneBookingID": 10
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsTenderbyTransactionsNewDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsTenderbyTransactionsNewDto>
    <Amount>1</Amount>
    <CoverCharge>1</CoverCharge>
    <Covers>9</Covers>
    <DateTimeClosed>2024-11-21T06:23:28.6395311+00:00</DateTimeClosed>
    <Deposit>1</Deposit>
    <GrossValue>1</GrossValue>
    <NeptuneBookingID>10</NeptuneBookingID>
    <NetValue>1</NetValue>
    <ServiceCharge>1</ServiceCharge>
    <SiteID>2</SiteID>
    <SiteName>sample string 1</SiteName>
    <SubSiteID>3</SubSiteID>
    <TableNumber>6</TableNumber>
    <TenderType>sample string 4</TenderType>
    <Terminal>sample string 7</Terminal>
    <TotalVAT>1</TotalVAT>
    <TransactionID>1</TransactionID>
    <UserName>sample string 8</UserName>
  </SpfReportsTenderbyTransactionsNewDto>
  <SpfReportsTenderbyTransactionsNewDto>
    <Amount>1</Amount>
    <CoverCharge>1</CoverCharge>
    <Covers>9</Covers>
    <DateTimeClosed>2024-11-21T06:23:28.6395311+00:00</DateTimeClosed>
    <Deposit>1</Deposit>
    <GrossValue>1</GrossValue>
    <NeptuneBookingID>10</NeptuneBookingID>
    <NetValue>1</NetValue>
    <ServiceCharge>1</ServiceCharge>
    <SiteID>2</SiteID>
    <SiteName>sample string 1</SiteName>
    <SubSiteID>3</SubSiteID>
    <TableNumber>6</TableNumber>
    <TenderType>sample string 4</TenderType>
    <Terminal>sample string 7</Terminal>
    <TotalVAT>1</TotalVAT>
    <TransactionID>1</TransactionID>
    <UserName>sample string 8</UserName>
  </SpfReportsTenderbyTransactionsNewDto>
</ArrayOfSpfReportsTenderbyTransactionsNewDto>