GET Reporting/v1/Enterprise/GetWastageReport

Gets the Wastage Report report data for given sites.

Request Information

URI Parameters

Name	Type	Description	Additional information
RequestingSiteID	integer	SiteID which is requesting report	None.
ProductTypeIDs	Collection of integer	Optional: will refine report by given product type IDs, if empty will not refine the report	None.
ProductGroupIDs	Collection of integer	Optional: will refine report by given product group IDs, if empty will not refine the report	None.
SiteIDs	Collection of integer	Site IDs which the report will be run on	None.
DateUtcFrom	date	Date which the report will start from	None.
DateUtcTo	date	Date which the report will end till	None.

Body Parameters

ReportingRequestCommand

Name	Type	Description	Additional information
RequestingSiteID	integer	SiteID which is requesting report	None.
ProductTypeIDs	Collection of integer	Optional: will refine report by given product type IDs, if empty will not refine the report	None.
ProductGroupIDs	Collection of integer	Optional: will refine report by given product group IDs, if empty will not refine the report	None.
SiteIDs	Collection of integer	Site IDs which the report will be run on	None.
DateUtcFrom	date	Date which the report will start from	None.
DateUtcTo	date	Date which the report will end till	None.

Request Formats

application/json, text/json

Sample:

{
  "RequestingSiteID": 1,
  "ProductTypeIDs": [
    1,
    2
  ],
  "ProductGroupIDs": [
    1,
    2
  ],
  "SiteIDs": [
    1,
    2
  ],
  "DateUtcFrom": "2024-11-21T06:23:23.9672607+00:00",
  "DateUtcTo": "2024-11-21T06:23:23.9672607+00:00"
}

application/xml, text/xml

Sample:

<ReportingRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
  <DateUtcFrom>2024-11-21T06:23:23.9672607+00:00</DateUtcFrom>
  <DateUtcTo>2024-11-21T06:23:23.9672607+00:00</DateUtcTo>
  <ProductGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductGroupIDs>
  <ProductTypeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductTypeIDs>
  <RequestingSiteID>1</RequestingSiteID>
  <SiteIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SiteIDs>
</ReportingRequestCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SpfReportsWastageNewDto

Name	Type	Additional information
SiteName	string	None.
SalesArea	string	None.
DateTimeClosed	date	None.
TransactionID	integer	None.
ProductType	string	None.
ProductGroup	string	None.
Product	string	None.
Measure	string	None.
ReasonName	string	None.
UserName	string	None.
AuthUserName	string	None.
TotalGross	decimal number	None.
TotalNet	decimal number	None.
CalcCost	decimal number	None.
Quantity	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SiteName": "sample string 1",
    "SalesArea": "sample string 2",
    "DateTimeClosed": "2024-11-21T06:23:23.9672607+00:00",
    "TransactionID": 1,
    "ProductType": "sample string 3",
    "ProductGroup": "sample string 4",
    "Product": "sample string 5",
    "Measure": "sample string 6",
    "ReasonName": "sample string 7",
    "UserName": "sample string 8",
    "AuthUserName": "sample string 9",
    "TotalGross": 1.0,
    "TotalNet": 1.0,
    "CalcCost": 1.0,
    "Quantity": 1.0
  },
  {
    "SiteName": "sample string 1",
    "SalesArea": "sample string 2",
    "DateTimeClosed": "2024-11-21T06:23:23.9672607+00:00",
    "TransactionID": 1,
    "ProductType": "sample string 3",
    "ProductGroup": "sample string 4",
    "Product": "sample string 5",
    "Measure": "sample string 6",
    "ReasonName": "sample string 7",
    "UserName": "sample string 8",
    "AuthUserName": "sample string 9",
    "TotalGross": 1.0,
    "TotalNet": 1.0,
    "CalcCost": 1.0,
    "Quantity": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsWastageNewDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsWastageNewDto>
    <AuthUserName>sample string 9</AuthUserName>
    <CalcCost>1</CalcCost>
    <DateTimeClosed>2024-11-21T06:23:23.9672607+00:00</DateTimeClosed>
    <Measure>sample string 6</Measure>
    <Product>sample string 5</Product>
    <ProductGroup>sample string 4</ProductGroup>
    <ProductType>sample string 3</ProductType>
    <Quantity>1</Quantity>
    <ReasonName>sample string 7</ReasonName>
    <SalesArea>sample string 2</SalesArea>
    <SiteName>sample string 1</SiteName>
    <TotalGross>1</TotalGross>
    <TotalNet>1</TotalNet>
    <TransactionID>1</TransactionID>
    <UserName>sample string 8</UserName>
  </SpfReportsWastageNewDto>
  <SpfReportsWastageNewDto>
    <AuthUserName>sample string 9</AuthUserName>
    <CalcCost>1</CalcCost>
    <DateTimeClosed>2024-11-21T06:23:23.9672607+00:00</DateTimeClosed>
    <Measure>sample string 6</Measure>
    <Product>sample string 5</Product>
    <ProductGroup>sample string 4</ProductGroup>
    <ProductType>sample string 3</ProductType>
    <Quantity>1</Quantity>
    <ReasonName>sample string 7</ReasonName>
    <SalesArea>sample string 2</SalesArea>
    <SiteName>sample string 1</SiteName>
    <TotalGross>1</TotalGross>
    <TotalNet>1</TotalNet>
    <TransactionID>1</TransactionID>
    <UserName>sample string 8</UserName>
  </SpfReportsWastageNewDto>
</ArrayOfSpfReportsWastageNewDto>