GET Reporting/v1/Enterprise/GetGratuityByUserReport

Gets the Gratuity 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:39:28.3068856+00:00",
  "DateTo": "2024-11-21T06:39:28.3068856+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:39:28.3068856+00:00</DateFrom>
  <DateTo>2024-11-21T06:39:28.3068856+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 SpfReportsGratuityByUserDto

Name	Type	Additional information
SiteName	string	None.
Name	string	None.
UserID	integer	None.
EmployeeID	string	None.
TransactionID	integer	None.
Terminal	string	None.
DateTimeClosed	date	None.
SalesArea	string	None.
Session	string	None.
Covers	integer	None.
TableNo	integer	None.
GratuityGross	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SiteName": "sample string 1",
    "Name": "sample string 2",
    "UserID": 3,
    "EmployeeID": "sample string 4",
    "TransactionID": 5,
    "Terminal": "sample string 6",
    "DateTimeClosed": "2024-11-21T06:39:28.3068856+00:00",
    "SalesArea": "sample string 8",
    "Session": "sample string 9",
    "Covers": 10,
    "TableNo": 11,
    "GratuityGross": 1.0
  },
  {
    "SiteName": "sample string 1",
    "Name": "sample string 2",
    "UserID": 3,
    "EmployeeID": "sample string 4",
    "TransactionID": 5,
    "Terminal": "sample string 6",
    "DateTimeClosed": "2024-11-21T06:39:28.3068856+00:00",
    "SalesArea": "sample string 8",
    "Session": "sample string 9",
    "Covers": 10,
    "TableNo": 11,
    "GratuityGross": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsGratuityByUserDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsGratuityByUserDto>
    <Covers>10</Covers>
    <DateTimeClosed>2024-11-21T06:39:28.3068856+00:00</DateTimeClosed>
    <EmployeeID>sample string 4</EmployeeID>
    <GratuityGross>1</GratuityGross>
    <Name>sample string 2</Name>
    <SalesArea>sample string 8</SalesArea>
    <Session>sample string 9</Session>
    <SiteName>sample string 1</SiteName>
    <TableNo>11</TableNo>
    <Terminal>sample string 6</Terminal>
    <TransactionID>5</TransactionID>
    <UserID>3</UserID>
  </SpfReportsGratuityByUserDto>
  <SpfReportsGratuityByUserDto>
    <Covers>10</Covers>
    <DateTimeClosed>2024-11-21T06:39:28.3068856+00:00</DateTimeClosed>
    <EmployeeID>sample string 4</EmployeeID>
    <GratuityGross>1</GratuityGross>
    <Name>sample string 2</Name>
    <SalesArea>sample string 8</SalesArea>
    <Session>sample string 9</Session>
    <SiteName>sample string 1</SiteName>
    <TableNo>11</TableNo>
    <Terminal>sample string 6</Terminal>
    <TransactionID>5</TransactionID>
    <UserID>3</UserID>
  </SpfReportsGratuityByUserDto>
</ArrayOfSpfReportsGratuityByUserDto>