GET Reporting/v1/Stock/GetSupplierPurchasesReport

Gets the Supplier Purchases report data for given sites and suppliers.

Request Information

URI Parameters

Name	Type	Description	Additional information
RequestingSiteID	integer	SiteID which is requesting report	None.
SiteIDs	Collection of integer	Site IDs which the report will be run on	None.
DateUtcFrom	date	Date which the report will search for purchase orders from	None.
DateUtcTo	date	Date which the report will search for purchase orders to	None.
ProductTypeIDs	Collection of integer	Optional: will refine report by given product type IDs, if empty will run for all product types	None.
ProductGroupIDs	Collection of integer	Optional: will refine report by given product group IDs, if empty wil run for all product groups	None.
SupplierIDs	Collection of integer	Optional: Supplier IDs which report will be ran for, if empty will run for all suppliers	None.
StockLocationIDs	Collection of integer	Optional: Stock Location IDs which report will be ran for, if empty will run for all suppliers	None.

Body Parameters

ReportingSupplierRequestCommand

Name	Type	Description	Additional information
RequestingSiteID	integer	SiteID which is requesting report	None.
SiteIDs	Collection of integer	Site IDs which the report will be run on	None.
DateUtcFrom	date	Date which the report will search for purchase orders from	None.
DateUtcTo	date	Date which the report will search for purchase orders to	None.
ProductTypeIDs	Collection of integer	Optional: will refine report by given product type IDs, if empty will run for all product types	None.
ProductGroupIDs	Collection of integer	Optional: will refine report by given product group IDs, if empty wil run for all product groups	None.
SupplierIDs	Collection of integer	Optional: Supplier IDs which report will be ran for, if empty will run for all suppliers	None.
StockLocationIDs	Collection of integer	Optional: Stock Location IDs which report will be ran for, if empty will run for all suppliers	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ReportingSupplierRequestCommand 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:54.8574774+00:00</DateUtcFrom>
  <DateUtcTo>2024-11-21T06:23:54.8574774+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>
  <StockLocationIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StockLocationIDs>
  <SupplierIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SupplierIDs>
</ReportingSupplierRequestCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SupplierPurchasesReportItemDto

Name	Type	Additional information
SiteID	integer	None.
SiteName	string	None.
LocalTimeZoneID	string	None.
PurchaseOrderNumber	string	None.
Supplier	string	None.
RecordedDelivery	boolean	None.
DeliveryDateUtc	date	None.
NetDeliveryCharge	decimal number	None.
DeliveryChargeTaxValue	decimal number	None.
GrossDeliveryCharge	decimal number	None.
NetExtraCharge	decimal number	None.
Product	string	None.
ProductCode	string	None.
ProductType	string	None.
ProductGroup	string	None.
PurchaseUnit	string	None.
PurchaseUnitQty	decimal number	None.
OrderQty	decimal number	None.
OrderNetUnitPrice	decimal number	None.
OrderLineSubtotal	decimal number	None.
DeliveredQty	decimal number	None.
DeliveryNetUnitPrice	decimal number	None.
DeliveryLineSubtotal	decimal number	None.
DeliveryLineTaxValue	decimal number	None.
DeliveryLineTotal	decimal number	None.
RowNumber	integer	None.
DeliveryDate	date	None.
PageSize	integer	None.
TotalCount	integer	None.
HasMorePages	boolean	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<ArrayOfSupplierPurchasesReportItemDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Reports.Dto">
  <SupplierPurchasesReportItemDto>
    <_x003C_DeliveredQty_x003E_k__BackingField>20</_x003C_DeliveredQty_x003E_k__BackingField>
    <_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>9</_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>
    <_x003C_DeliveryDateUtc_x003E_k__BackingField>2024-11-21T06:23:54.8574774+00:00</_x003C_DeliveryDateUtc_x003E_k__BackingField>
    <_x003C_DeliveryLineSubtotal_x003E_k__BackingField>22</_x003C_DeliveryLineSubtotal_x003E_k__BackingField>
    <_x003C_DeliveryLineTaxValue_x003E_k__BackingField>23</_x003C_DeliveryLineTaxValue_x003E_k__BackingField>
    <_x003C_DeliveryLineTotal_x003E_k__BackingField>24</_x003C_DeliveryLineTotal_x003E_k__BackingField>
    <_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>21</_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>
    <_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 3</_x003C_LocalTimeZoneID_x003E_k__BackingField>
    <_x003C_NetDeliveryCharge_x003E_k__BackingField>8</_x003C_NetDeliveryCharge_x003E_k__BackingField>
    <_x003C_NetExtraCharge_x003E_k__BackingField>10</_x003C_NetExtraCharge_x003E_k__BackingField>
    <_x003C_OrderLineSubtotal_x003E_k__BackingField>19</_x003C_OrderLineSubtotal_x003E_k__BackingField>
    <_x003C_OrderNetUnitPrice_x003E_k__BackingField>18</_x003C_OrderNetUnitPrice_x003E_k__BackingField>
    <_x003C_OrderQty_x003E_k__BackingField>17</_x003C_OrderQty_x003E_k__BackingField>
    <_x003C_PageSize_x003E_k__BackingField>26</_x003C_PageSize_x003E_k__BackingField>
    <_x003C_ProductCode_x003E_k__BackingField>sample string 12</_x003C_ProductCode_x003E_k__BackingField>
    <_x003C_ProductGroup_x003E_k__BackingField>sample string 14</_x003C_ProductGroup_x003E_k__BackingField>
    <_x003C_ProductType_x003E_k__BackingField>sample string 13</_x003C_ProductType_x003E_k__BackingField>
    <_x003C_Product_x003E_k__BackingField>sample string 11</_x003C_Product_x003E_k__BackingField>
    <_x003C_PurchaseOrderNumber_x003E_k__BackingField>sample string 4</_x003C_PurchaseOrderNumber_x003E_k__BackingField>
    <_x003C_PurchaseUnitQty_x003E_k__BackingField>16</_x003C_PurchaseUnitQty_x003E_k__BackingField>
    <_x003C_PurchaseUnit_x003E_k__BackingField>sample string 15</_x003C_PurchaseUnit_x003E_k__BackingField>
    <_x003C_RecordedDelivery_x003E_k__BackingField>true</_x003C_RecordedDelivery_x003E_k__BackingField>
    <_x003C_RowNumber_x003E_k__BackingField>25</_x003C_RowNumber_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_Supplier_x003E_k__BackingField>sample string 5</_x003C_Supplier_x003E_k__BackingField>
    <_x003C_TotalCount_x003E_k__BackingField>27</_x003C_TotalCount_x003E_k__BackingField>
  </SupplierPurchasesReportItemDto>
  <SupplierPurchasesReportItemDto>
    <_x003C_DeliveredQty_x003E_k__BackingField>20</_x003C_DeliveredQty_x003E_k__BackingField>
    <_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>9</_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>
    <_x003C_DeliveryDateUtc_x003E_k__BackingField>2024-11-21T06:23:54.8574774+00:00</_x003C_DeliveryDateUtc_x003E_k__BackingField>
    <_x003C_DeliveryLineSubtotal_x003E_k__BackingField>22</_x003C_DeliveryLineSubtotal_x003E_k__BackingField>
    <_x003C_DeliveryLineTaxValue_x003E_k__BackingField>23</_x003C_DeliveryLineTaxValue_x003E_k__BackingField>
    <_x003C_DeliveryLineTotal_x003E_k__BackingField>24</_x003C_DeliveryLineTotal_x003E_k__BackingField>
    <_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>21</_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>
    <_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 3</_x003C_LocalTimeZoneID_x003E_k__BackingField>
    <_x003C_NetDeliveryCharge_x003E_k__BackingField>8</_x003C_NetDeliveryCharge_x003E_k__BackingField>
    <_x003C_NetExtraCharge_x003E_k__BackingField>10</_x003C_NetExtraCharge_x003E_k__BackingField>
    <_x003C_OrderLineSubtotal_x003E_k__BackingField>19</_x003C_OrderLineSubtotal_x003E_k__BackingField>
    <_x003C_OrderNetUnitPrice_x003E_k__BackingField>18</_x003C_OrderNetUnitPrice_x003E_k__BackingField>
    <_x003C_OrderQty_x003E_k__BackingField>17</_x003C_OrderQty_x003E_k__BackingField>
    <_x003C_PageSize_x003E_k__BackingField>26</_x003C_PageSize_x003E_k__BackingField>
    <_x003C_ProductCode_x003E_k__BackingField>sample string 12</_x003C_ProductCode_x003E_k__BackingField>
    <_x003C_ProductGroup_x003E_k__BackingField>sample string 14</_x003C_ProductGroup_x003E_k__BackingField>
    <_x003C_ProductType_x003E_k__BackingField>sample string 13</_x003C_ProductType_x003E_k__BackingField>
    <_x003C_Product_x003E_k__BackingField>sample string 11</_x003C_Product_x003E_k__BackingField>
    <_x003C_PurchaseOrderNumber_x003E_k__BackingField>sample string 4</_x003C_PurchaseOrderNumber_x003E_k__BackingField>
    <_x003C_PurchaseUnitQty_x003E_k__BackingField>16</_x003C_PurchaseUnitQty_x003E_k__BackingField>
    <_x003C_PurchaseUnit_x003E_k__BackingField>sample string 15</_x003C_PurchaseUnit_x003E_k__BackingField>
    <_x003C_RecordedDelivery_x003E_k__BackingField>true</_x003C_RecordedDelivery_x003E_k__BackingField>
    <_x003C_RowNumber_x003E_k__BackingField>25</_x003C_RowNumber_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_Supplier_x003E_k__BackingField>sample string 5</_x003C_Supplier_x003E_k__BackingField>
    <_x003C_TotalCount_x003E_k__BackingField>27</_x003C_TotalCount_x003E_k__BackingField>
  </SupplierPurchasesReportItemDto>
</ArrayOfSupplierPurchasesReportItemDto>