GET Reporting/v1/Enterprise/GetTradingSummaryReport

Gets the Trading Summary Report By Day 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:24:35.0015012+00:00",
  "DateTo": "2024-11-21T06:24:35.0015012+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:24:35.0015012+00:00</DateFrom>
  <DateTo>2024-11-21T06:24:35.0015012+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 SpfReportsTradingSummaryViewDto

Name	Type	Additional information
LineDescription	string	None.
ProductTypeName	string	None.
TotalGross	decimal number	None.
TotalNet	decimal number	None.
TotalVAT	decimal number	None.
TotalComp	decimal number	None.
TotalPromo	decimal number	None.
TotalWastage	decimal number	None.
TotalRefund	decimal number	None.
VouchersSold	decimal number	None.
CreditSurcharge	decimal number	None.
TotalCRMTopUp	decimal number	None.
TotalCRMRefund	decimal number	None.
TotalCRMRefundQty	integer	None.
TotalDepositTaken	decimal number	None.
TotalCashOut	decimal number	None.
TotalGratuity	decimal number	None.
TotalServiceCharge	decimal number	None.
InclSC	decimal number	None.
TotalCoverCharge	decimal number	None.
TotalTransactions	integer	None.
TotalCovers	integer	None.
SPH	decimal number	None.
SPT	decimal number	None.
TenderType	string	None.
Amount	decimal number	None.
IsCashOut	integer	None.
SalesTransactionsCount	integer	None.
CashToBank	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LineDescription": "sample string 1",
    "ProductTypeName": "sample string 2",
    "TotalGross": 1.0,
    "TotalNet": 1.0,
    "TotalVAT": 1.0,
    "TotalComp": 1.0,
    "TotalPromo": 1.0,
    "TotalWastage": 1.0,
    "TotalRefund": 1.0,
    "VouchersSold": 1.0,
    "CreditSurcharge": 1.0,
    "TotalCRMTopUp": 1.0,
    "TotalCRMRefund": 1.0,
    "TotalCRMRefundQty": 1,
    "TotalDepositTaken": 1.0,
    "TotalCashOut": 1.0,
    "TotalGratuity": 1.0,
    "TotalServiceCharge": 1.0,
    "InclSC": 1.0,
    "TotalCoverCharge": 1.0,
    "TotalTransactions": 1,
    "TotalCovers": 1,
    "SPH": 1.0,
    "SPT": 1.0,
    "TenderType": "sample string 3",
    "Amount": 1.0,
    "IsCashOut": 1,
    "SalesTransactionsCount": 1,
    "CashToBank": 1.0
  },
  {
    "LineDescription": "sample string 1",
    "ProductTypeName": "sample string 2",
    "TotalGross": 1.0,
    "TotalNet": 1.0,
    "TotalVAT": 1.0,
    "TotalComp": 1.0,
    "TotalPromo": 1.0,
    "TotalWastage": 1.0,
    "TotalRefund": 1.0,
    "VouchersSold": 1.0,
    "CreditSurcharge": 1.0,
    "TotalCRMTopUp": 1.0,
    "TotalCRMRefund": 1.0,
    "TotalCRMRefundQty": 1,
    "TotalDepositTaken": 1.0,
    "TotalCashOut": 1.0,
    "TotalGratuity": 1.0,
    "TotalServiceCharge": 1.0,
    "InclSC": 1.0,
    "TotalCoverCharge": 1.0,
    "TotalTransactions": 1,
    "TotalCovers": 1,
    "SPH": 1.0,
    "SPT": 1.0,
    "TenderType": "sample string 3",
    "Amount": 1.0,
    "IsCashOut": 1,
    "SalesTransactionsCount": 1,
    "CashToBank": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsTradingSummaryViewDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsTradingSummaryViewDto>
    <Amount>1</Amount>
    <CashToBank>1</CashToBank>
    <CreditSurcharge>1</CreditSurcharge>
    <InclSC>1</InclSC>
    <IsCashOut>1</IsCashOut>
    <LineDescription>sample string 1</LineDescription>
    <ProductTypeName>sample string 2</ProductTypeName>
    <SPH>1</SPH>
    <SPT>1</SPT>
    <SalesTransactionsCount>1</SalesTransactionsCount>
    <TenderType>sample string 3</TenderType>
    <TotalCRMRefund>1</TotalCRMRefund>
    <TotalCRMRefundQty>1</TotalCRMRefundQty>
    <TotalCRMTopUp>1</TotalCRMTopUp>
    <TotalCashOut>1</TotalCashOut>
    <TotalComp>1</TotalComp>
    <TotalCoverCharge>1</TotalCoverCharge>
    <TotalCovers>1</TotalCovers>
    <TotalDepositTaken>1</TotalDepositTaken>
    <TotalGratuity>1</TotalGratuity>
    <TotalGross>1</TotalGross>
    <TotalNet>1</TotalNet>
    <TotalPromo>1</TotalPromo>
    <TotalRefund>1</TotalRefund>
    <TotalServiceCharge>1</TotalServiceCharge>
    <TotalTransactions>1</TotalTransactions>
    <TotalVAT>1</TotalVAT>
    <TotalWastage>1</TotalWastage>
    <VouchersSold>1</VouchersSold>
  </SpfReportsTradingSummaryViewDto>
  <SpfReportsTradingSummaryViewDto>
    <Amount>1</Amount>
    <CashToBank>1</CashToBank>
    <CreditSurcharge>1</CreditSurcharge>
    <InclSC>1</InclSC>
    <IsCashOut>1</IsCashOut>
    <LineDescription>sample string 1</LineDescription>
    <ProductTypeName>sample string 2</ProductTypeName>
    <SPH>1</SPH>
    <SPT>1</SPT>
    <SalesTransactionsCount>1</SalesTransactionsCount>
    <TenderType>sample string 3</TenderType>
    <TotalCRMRefund>1</TotalCRMRefund>
    <TotalCRMRefundQty>1</TotalCRMRefundQty>
    <TotalCRMTopUp>1</TotalCRMTopUp>
    <TotalCashOut>1</TotalCashOut>
    <TotalComp>1</TotalComp>
    <TotalCoverCharge>1</TotalCoverCharge>
    <TotalCovers>1</TotalCovers>
    <TotalDepositTaken>1</TotalDepositTaken>
    <TotalGratuity>1</TotalGratuity>
    <TotalGross>1</TotalGross>
    <TotalNet>1</TotalNet>
    <TotalPromo>1</TotalPromo>
    <TotalRefund>1</TotalRefund>
    <TotalServiceCharge>1</TotalServiceCharge>
    <TotalTransactions>1</TotalTransactions>
    <TotalVAT>1</TotalVAT>
    <TotalWastage>1</TotalWastage>
    <VouchersSold>1</VouchersSold>
  </SpfReportsTradingSummaryViewDto>
</ArrayOfSpfReportsTradingSummaryViewDto>