GET Reporting/v1/Enterprise/GetDiscountReport

Gets the Discounts 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:59.2439283+00:00",
  "DateTo": "2024-11-21T06:23:59.2439283+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:59.2439283+00:00</DateFrom>
  <DateTo>2024-11-21T06:23:59.2439283+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 DiscountReportDto

Name	Type	Description	Additional information
DataSource1	Collection of SpfReportsDiscountsBaseDto		None.
DataSource2	Collection of SpfReportsDiscountsSummaryDto		None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DataSource1": [
      {
        "WSTransactionItemID": 1,
        "SiteName": "sample string 2",
        "SiteID": 3,
        "CostCentre": "sample string 4",
        "SalesArea": "sample string 5",
        "ProductTypeName": "sample string 6",
        "ProductGroupName": "sample string 7",
        "ProductName": "sample string 8",
        "PriceGroupName": "sample string 9",
        "TableNo": 10,
        "Terminal": "sample string 11",
        "TransactionID": 12,
        "DateTime": "2024-11-21T06:23:59.2439283+00:00",
        "TotalSales": 14.0,
        "ExpTotalSales": 15.0,
        "CostOfSales": 16.0,
        "CompSales": 17.0,
        "UnitQuantity": 18,
        "Reason": "sample string 19",
        "ParentReason": "sample string 20",
        "AuthUser": "sample string 21",
        "UserName": "sample string 22",
        "CustomerName": "sample string 23"
      },
      {
        "WSTransactionItemID": 1,
        "SiteName": "sample string 2",
        "SiteID": 3,
        "CostCentre": "sample string 4",
        "SalesArea": "sample string 5",
        "ProductTypeName": "sample string 6",
        "ProductGroupName": "sample string 7",
        "ProductName": "sample string 8",
        "PriceGroupName": "sample string 9",
        "TableNo": 10,
        "Terminal": "sample string 11",
        "TransactionID": 12,
        "DateTime": "2024-11-21T06:23:59.2439283+00:00",
        "TotalSales": 14.0,
        "ExpTotalSales": 15.0,
        "CostOfSales": 16.0,
        "CompSales": 17.0,
        "UnitQuantity": 18,
        "Reason": "sample string 19",
        "ParentReason": "sample string 20",
        "AuthUser": "sample string 21",
        "UserName": "sample string 22",
        "CustomerName": "sample string 23"
      }
    ],
    "DataSource2": [
      {
        "ProductTypeName": "sample string 1",
        "Reason": "sample string 2",
        "ParentReason": "sample string 3",
        "Total": 1.0,
        "Quantity": 1,
        "PC": 1.0
      },
      {
        "ProductTypeName": "sample string 1",
        "Reason": "sample string 2",
        "ParentReason": "sample string 3",
        "Total": 1.0,
        "Quantity": 1,
        "PC": 1.0
      }
    ]
  },
  {
    "DataSource1": [
      {
        "WSTransactionItemID": 1,
        "SiteName": "sample string 2",
        "SiteID": 3,
        "CostCentre": "sample string 4",
        "SalesArea": "sample string 5",
        "ProductTypeName": "sample string 6",
        "ProductGroupName": "sample string 7",
        "ProductName": "sample string 8",
        "PriceGroupName": "sample string 9",
        "TableNo": 10,
        "Terminal": "sample string 11",
        "TransactionID": 12,
        "DateTime": "2024-11-21T06:23:59.2439283+00:00",
        "TotalSales": 14.0,
        "ExpTotalSales": 15.0,
        "CostOfSales": 16.0,
        "CompSales": 17.0,
        "UnitQuantity": 18,
        "Reason": "sample string 19",
        "ParentReason": "sample string 20",
        "AuthUser": "sample string 21",
        "UserName": "sample string 22",
        "CustomerName": "sample string 23"
      },
      {
        "WSTransactionItemID": 1,
        "SiteName": "sample string 2",
        "SiteID": 3,
        "CostCentre": "sample string 4",
        "SalesArea": "sample string 5",
        "ProductTypeName": "sample string 6",
        "ProductGroupName": "sample string 7",
        "ProductName": "sample string 8",
        "PriceGroupName": "sample string 9",
        "TableNo": 10,
        "Terminal": "sample string 11",
        "TransactionID": 12,
        "DateTime": "2024-11-21T06:23:59.2439283+00:00",
        "TotalSales": 14.0,
        "ExpTotalSales": 15.0,
        "CostOfSales": 16.0,
        "CompSales": 17.0,
        "UnitQuantity": 18,
        "Reason": "sample string 19",
        "ParentReason": "sample string 20",
        "AuthUser": "sample string 21",
        "UserName": "sample string 22",
        "CustomerName": "sample string 23"
      }
    ],
    "DataSource2": [
      {
        "ProductTypeName": "sample string 1",
        "Reason": "sample string 2",
        "ParentReason": "sample string 3",
        "Total": 1.0,
        "Quantity": 1,
        "PC": 1.0
      },
      {
        "ProductTypeName": "sample string 1",
        "Reason": "sample string 2",
        "ParentReason": "sample string 3",
        "Total": 1.0,
        "Quantity": 1,
        "PC": 1.0
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfDiscountReportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.Reporting">
  <DiscountReportDto>
    <DataSource1 xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
      <d3p1:SpfReportsDiscountsBaseDto>
        <d3p1:AuthUser>sample string 21</d3p1:AuthUser>
        <d3p1:CompSales>17</d3p1:CompSales>
        <d3p1:CostCentre>sample string 4</d3p1:CostCentre>
        <d3p1:CostOfSales>16</d3p1:CostOfSales>
        <d3p1:CustomerName>sample string 23</d3p1:CustomerName>
        <d3p1:DateTime>2024-11-21T06:23:59.2439283+00:00</d3p1:DateTime>
        <d3p1:ExpTotalSales>15</d3p1:ExpTotalSales>
        <d3p1:ParentReason>sample string 20</d3p1:ParentReason>
        <d3p1:PriceGroupName>sample string 9</d3p1:PriceGroupName>
        <d3p1:ProductGroupName>sample string 7</d3p1:ProductGroupName>
        <d3p1:ProductName>sample string 8</d3p1:ProductName>
        <d3p1:ProductTypeName>sample string 6</d3p1:ProductTypeName>
        <d3p1:Reason>sample string 19</d3p1:Reason>
        <d3p1:SalesArea>sample string 5</d3p1:SalesArea>
        <d3p1:SiteID>3</d3p1:SiteID>
        <d3p1:SiteName>sample string 2</d3p1:SiteName>
        <d3p1:TableNo>10</d3p1:TableNo>
        <d3p1:Terminal>sample string 11</d3p1:Terminal>
        <d3p1:TotalSales>14</d3p1:TotalSales>
        <d3p1:TransactionID>12</d3p1:TransactionID>
        <d3p1:UnitQuantity>18</d3p1:UnitQuantity>
        <d3p1:UserName>sample string 22</d3p1:UserName>
        <d3p1:WSTransactionItemID>1</d3p1:WSTransactionItemID>
      </d3p1:SpfReportsDiscountsBaseDto>
      <d3p1:SpfReportsDiscountsBaseDto>
        <d3p1:AuthUser>sample string 21</d3p1:AuthUser>
        <d3p1:CompSales>17</d3p1:CompSales>
        <d3p1:CostCentre>sample string 4</d3p1:CostCentre>
        <d3p1:CostOfSales>16</d3p1:CostOfSales>
        <d3p1:CustomerName>sample string 23</d3p1:CustomerName>
        <d3p1:DateTime>2024-11-21T06:23:59.2439283+00:00</d3p1:DateTime>
        <d3p1:ExpTotalSales>15</d3p1:ExpTotalSales>
        <d3p1:ParentReason>sample string 20</d3p1:ParentReason>
        <d3p1:PriceGroupName>sample string 9</d3p1:PriceGroupName>
        <d3p1:ProductGroupName>sample string 7</d3p1:ProductGroupName>
        <d3p1:ProductName>sample string 8</d3p1:ProductName>
        <d3p1:ProductTypeName>sample string 6</d3p1:ProductTypeName>
        <d3p1:Reason>sample string 19</d3p1:Reason>
        <d3p1:SalesArea>sample string 5</d3p1:SalesArea>
        <d3p1:SiteID>3</d3p1:SiteID>
        <d3p1:SiteName>sample string 2</d3p1:SiteName>
        <d3p1:TableNo>10</d3p1:TableNo>
        <d3p1:Terminal>sample string 11</d3p1:Terminal>
        <d3p1:TotalSales>14</d3p1:TotalSales>
        <d3p1:TransactionID>12</d3p1:TransactionID>
        <d3p1:UnitQuantity>18</d3p1:UnitQuantity>
        <d3p1:UserName>sample string 22</d3p1:UserName>
        <d3p1:WSTransactionItemID>1</d3p1:WSTransactionItemID>
      </d3p1:SpfReportsDiscountsBaseDto>
    </DataSource1>
    <DataSource2 xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
      <d3p1:SpfReportsDiscountsSummaryDto>
        <d3p1:PC>1</d3p1:PC>
        <d3p1:ParentReason>sample string 3</d3p1:ParentReason>
        <d3p1:ProductTypeName>sample string 1</d3p1:ProductTypeName>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:Reason>sample string 2</d3p1:Reason>
        <d3p1:Total>1</d3p1:Total>
      </d3p1:SpfReportsDiscountsSummaryDto>
      <d3p1:SpfReportsDiscountsSummaryDto>
        <d3p1:PC>1</d3p1:PC>
        <d3p1:ParentReason>sample string 3</d3p1:ParentReason>
        <d3p1:ProductTypeName>sample string 1</d3p1:ProductTypeName>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:Reason>sample string 2</d3p1:Reason>
        <d3p1:Total>1</d3p1:Total>
      </d3p1:SpfReportsDiscountsSummaryDto>
    </DataSource2>
  </DiscountReportDto>
  <DiscountReportDto>
    <DataSource1 xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
      <d3p1:SpfReportsDiscountsBaseDto>
        <d3p1:AuthUser>sample string 21</d3p1:AuthUser>
        <d3p1:CompSales>17</d3p1:CompSales>
        <d3p1:CostCentre>sample string 4</d3p1:CostCentre>
        <d3p1:CostOfSales>16</d3p1:CostOfSales>
        <d3p1:CustomerName>sample string 23</d3p1:CustomerName>
        <d3p1:DateTime>2024-11-21T06:23:59.2439283+00:00</d3p1:DateTime>
        <d3p1:ExpTotalSales>15</d3p1:ExpTotalSales>
        <d3p1:ParentReason>sample string 20</d3p1:ParentReason>
        <d3p1:PriceGroupName>sample string 9</d3p1:PriceGroupName>
        <d3p1:ProductGroupName>sample string 7</d3p1:ProductGroupName>
        <d3p1:ProductName>sample string 8</d3p1:ProductName>
        <d3p1:ProductTypeName>sample string 6</d3p1:ProductTypeName>
        <d3p1:Reason>sample string 19</d3p1:Reason>
        <d3p1:SalesArea>sample string 5</d3p1:SalesArea>
        <d3p1:SiteID>3</d3p1:SiteID>
        <d3p1:SiteName>sample string 2</d3p1:SiteName>
        <d3p1:TableNo>10</d3p1:TableNo>
        <d3p1:Terminal>sample string 11</d3p1:Terminal>
        <d3p1:TotalSales>14</d3p1:TotalSales>
        <d3p1:TransactionID>12</d3p1:TransactionID>
        <d3p1:UnitQuantity>18</d3p1:UnitQuantity>
        <d3p1:UserName>sample string 22</d3p1:UserName>
        <d3p1:WSTransactionItemID>1</d3p1:WSTransactionItemID>
      </d3p1:SpfReportsDiscountsBaseDto>
      <d3p1:SpfReportsDiscountsBaseDto>
        <d3p1:AuthUser>sample string 21</d3p1:AuthUser>
        <d3p1:CompSales>17</d3p1:CompSales>
        <d3p1:CostCentre>sample string 4</d3p1:CostCentre>
        <d3p1:CostOfSales>16</d3p1:CostOfSales>
        <d3p1:CustomerName>sample string 23</d3p1:CustomerName>
        <d3p1:DateTime>2024-11-21T06:23:59.2439283+00:00</d3p1:DateTime>
        <d3p1:ExpTotalSales>15</d3p1:ExpTotalSales>
        <d3p1:ParentReason>sample string 20</d3p1:ParentReason>
        <d3p1:PriceGroupName>sample string 9</d3p1:PriceGroupName>
        <d3p1:ProductGroupName>sample string 7</d3p1:ProductGroupName>
        <d3p1:ProductName>sample string 8</d3p1:ProductName>
        <d3p1:ProductTypeName>sample string 6</d3p1:ProductTypeName>
        <d3p1:Reason>sample string 19</d3p1:Reason>
        <d3p1:SalesArea>sample string 5</d3p1:SalesArea>
        <d3p1:SiteID>3</d3p1:SiteID>
        <d3p1:SiteName>sample string 2</d3p1:SiteName>
        <d3p1:TableNo>10</d3p1:TableNo>
        <d3p1:Terminal>sample string 11</d3p1:Terminal>
        <d3p1:TotalSales>14</d3p1:TotalSales>
        <d3p1:TransactionID>12</d3p1:TransactionID>
        <d3p1:UnitQuantity>18</d3p1:UnitQuantity>
        <d3p1:UserName>sample string 22</d3p1:UserName>
        <d3p1:WSTransactionItemID>1</d3p1:WSTransactionItemID>
      </d3p1:SpfReportsDiscountsBaseDto>
    </DataSource1>
    <DataSource2 xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
      <d3p1:SpfReportsDiscountsSummaryDto>
        <d3p1:PC>1</d3p1:PC>
        <d3p1:ParentReason>sample string 3</d3p1:ParentReason>
        <d3p1:ProductTypeName>sample string 1</d3p1:ProductTypeName>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:Reason>sample string 2</d3p1:Reason>
        <d3p1:Total>1</d3p1:Total>
      </d3p1:SpfReportsDiscountsSummaryDto>
      <d3p1:SpfReportsDiscountsSummaryDto>
        <d3p1:PC>1</d3p1:PC>
        <d3p1:ParentReason>sample string 3</d3p1:ParentReason>
        <d3p1:ProductTypeName>sample string 1</d3p1:ProductTypeName>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:Reason>sample string 2</d3p1:Reason>
        <d3p1:Total>1</d3p1:Total>
      </d3p1:SpfReportsDiscountsSummaryDto>
    </DataSource2>
  </DiscountReportDto>
</ArrayOfDiscountReportDto>