GET Reporting/v1/Stock/GetWastageReport

Gets the Wastage 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:26:05.2688881+00:00",
  "DateUtcTo": "2024-11-21T06:26:05.2688881+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:26:05.2688881+00:00</DateUtcFrom>
  <DateUtcTo>2024-11-21T06:26:05.2688881+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 WastageReportItemDto

Name	Type	Additional information
SiteID	integer	None.
SiteName	string	None.
LocalTimeZoneID	string	None.
WastageID	integer	None.
Wastage	string	None.
WastageType	string	None.
WastageDateUtc	date	None.
WastageLocation	string	None.
ProductType	string	None.
ProductGroup	string	None.
Item	string	None.
Measure	string	None.
Unit	string	None.
UnitQtyWasted	decimal number	None.
NetCost	decimal number	None.
Reason	string	None.
WastedBy	string	None.
WastageDate	date	None.
PageSize	integer	None.
TotalCount	integer	None.
HasMorePages	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SiteID": 1,
    "SiteName": "sample string 2",
    "LocalTimeZoneID": "sample string 3",
    "WastageID": 4,
    "Wastage": "sample string 5",
    "WastageType": "sample string 6",
    "WastageDateUtc": "2024-11-21T06:26:05.2784408+00:00",
    "WastageLocation": "sample string 8",
    "ProductType": "sample string 9",
    "ProductGroup": "sample string 10",
    "Item": "sample string 11",
    "Measure": "sample string 12",
    "Unit": "sample string 13",
    "UnitQtyWasted": 14.0,
    "NetCost": 15.0,
    "Reason": "sample string 16",
    "WastedBy": "sample string 17",
    "WastageDate": "2024-11-21T06:26:05.2784408+00:00",
    "PageSize": 18,
    "TotalCount": 19,
    "HasMorePages": true
  },
  {
    "SiteID": 1,
    "SiteName": "sample string 2",
    "LocalTimeZoneID": "sample string 3",
    "WastageID": 4,
    "Wastage": "sample string 5",
    "WastageType": "sample string 6",
    "WastageDateUtc": "2024-11-21T06:26:05.2784408+00:00",
    "WastageLocation": "sample string 8",
    "ProductType": "sample string 9",
    "ProductGroup": "sample string 10",
    "Item": "sample string 11",
    "Measure": "sample string 12",
    "Unit": "sample string 13",
    "UnitQtyWasted": 14.0,
    "NetCost": 15.0,
    "Reason": "sample string 16",
    "WastedBy": "sample string 17",
    "WastageDate": "2024-11-21T06:26:05.2784408+00:00",
    "PageSize": 18,
    "TotalCount": 19,
    "HasMorePages": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfWastageReportItemDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Reports.Dto">
  <WastageReportItemDto>
    <_x003C_Item_x003E_k__BackingField>sample string 11</_x003C_Item_x003E_k__BackingField>
    <_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 3</_x003C_LocalTimeZoneID_x003E_k__BackingField>
    <_x003C_Measure_x003E_k__BackingField>sample string 12</_x003C_Measure_x003E_k__BackingField>
    <_x003C_NetCost_x003E_k__BackingField>15</_x003C_NetCost_x003E_k__BackingField>
    <_x003C_PageSize_x003E_k__BackingField>18</_x003C_PageSize_x003E_k__BackingField>
    <_x003C_ProductGroup_x003E_k__BackingField>sample string 10</_x003C_ProductGroup_x003E_k__BackingField>
    <_x003C_ProductType_x003E_k__BackingField>sample string 9</_x003C_ProductType_x003E_k__BackingField>
    <_x003C_Reason_x003E_k__BackingField>sample string 16</_x003C_Reason_x003E_k__BackingField>
    <_x003C_SiteID_x003E_k__BackingField>1</_x003C_SiteID_x003E_k__BackingField>
    <_x003C_SiteName_x003E_k__BackingField>sample string 2</_x003C_SiteName_x003E_k__BackingField>
    <_x003C_TotalCount_x003E_k__BackingField>19</_x003C_TotalCount_x003E_k__BackingField>
    <_x003C_UnitQtyWasted_x003E_k__BackingField>14</_x003C_UnitQtyWasted_x003E_k__BackingField>
    <_x003C_Unit_x003E_k__BackingField>sample string 13</_x003C_Unit_x003E_k__BackingField>
    <_x003C_WastageDateUtc_x003E_k__BackingField>2024-11-21T06:26:05.2784408+00:00</_x003C_WastageDateUtc_x003E_k__BackingField>
    <_x003C_WastageID_x003E_k__BackingField>4</_x003C_WastageID_x003E_k__BackingField>
    <_x003C_WastageLocation_x003E_k__BackingField>sample string 8</_x003C_WastageLocation_x003E_k__BackingField>
    <_x003C_WastageType_x003E_k__BackingField>sample string 6</_x003C_WastageType_x003E_k__BackingField>
    <_x003C_Wastage_x003E_k__BackingField>sample string 5</_x003C_Wastage_x003E_k__BackingField>
    <_x003C_WastedBy_x003E_k__BackingField>sample string 17</_x003C_WastedBy_x003E_k__BackingField>
  </WastageReportItemDto>
  <WastageReportItemDto>
    <_x003C_Item_x003E_k__BackingField>sample string 11</_x003C_Item_x003E_k__BackingField>
    <_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 3</_x003C_LocalTimeZoneID_x003E_k__BackingField>
    <_x003C_Measure_x003E_k__BackingField>sample string 12</_x003C_Measure_x003E_k__BackingField>
    <_x003C_NetCost_x003E_k__BackingField>15</_x003C_NetCost_x003E_k__BackingField>
    <_x003C_PageSize_x003E_k__BackingField>18</_x003C_PageSize_x003E_k__BackingField>
    <_x003C_ProductGroup_x003E_k__BackingField>sample string 10</_x003C_ProductGroup_x003E_k__BackingField>
    <_x003C_ProductType_x003E_k__BackingField>sample string 9</_x003C_ProductType_x003E_k__BackingField>
    <_x003C_Reason_x003E_k__BackingField>sample string 16</_x003C_Reason_x003E_k__BackingField>
    <_x003C_SiteID_x003E_k__BackingField>1</_x003C_SiteID_x003E_k__BackingField>
    <_x003C_SiteName_x003E_k__BackingField>sample string 2</_x003C_SiteName_x003E_k__BackingField>
    <_x003C_TotalCount_x003E_k__BackingField>19</_x003C_TotalCount_x003E_k__BackingField>
    <_x003C_UnitQtyWasted_x003E_k__BackingField>14</_x003C_UnitQtyWasted_x003E_k__BackingField>
    <_x003C_Unit_x003E_k__BackingField>sample string 13</_x003C_Unit_x003E_k__BackingField>
    <_x003C_WastageDateUtc_x003E_k__BackingField>2024-11-21T06:26:05.2784408+00:00</_x003C_WastageDateUtc_x003E_k__BackingField>
    <_x003C_WastageID_x003E_k__BackingField>4</_x003C_WastageID_x003E_k__BackingField>
    <_x003C_WastageLocation_x003E_k__BackingField>sample string 8</_x003C_WastageLocation_x003E_k__BackingField>
    <_x003C_WastageType_x003E_k__BackingField>sample string 6</_x003C_WastageType_x003E_k__BackingField>
    <_x003C_Wastage_x003E_k__BackingField>sample string 5</_x003C_Wastage_x003E_k__BackingField>
    <_x003C_WastedBy_x003E_k__BackingField>sample string 17</_x003C_WastedBy_x003E_k__BackingField>
  </WastageReportItemDto>
</ArrayOfWastageReportItemDto>