GET Reporting/v1/Stock/GetPurchaseOrdersReport
Gets the Purchase Orders report data for given sites.
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. |
| PurchaseOrderID | integer |
Optional: Purchase Order ID which report will be ran for, use this to target a specific purchase order. |
None. |
Body Parameters
ReportingPurchaseOrderRequestCommand| 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. |
| PurchaseOrderID | integer |
Optional: Purchase Order ID which report will be ran for, use this to target a specific purchase order. |
None. |
Request Formats
application/json, text/json
{
"RequestingSiteID": 1,
"SiteIDs": [
1,
2
],
"DateUtcFrom": "2025-10-29T20:27:25.8489225",
"DateUtcTo": "2025-10-29T20:27:25.8489225",
"ProductTypeIDs": [
1,
2
],
"ProductGroupIDs": [
1,
2
],
"SupplierIDs": [
1,
2
],
"StockLocationIDs": [
1,
2
],
"PurchaseOrderID": 1
}
application/xml, text/xml
<ReportingPurchaseOrderRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
<DateUtcFrom>2025-10-29T20:27:25.8489225</DateUtcFrom>
<DateUtcTo>2025-10-29T20:27:25.8489225</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>
<PurchaseOrderID>1</PurchaseOrderID>
<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>
</ReportingPurchaseOrderRequestCommand>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Collection of PurchaseOrdersReportItemDto| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
None. |
|
| SiteName | string |
None. |
|
| LocalTimeZoneID | string |
None. |
|
| PurchaseOrderNumber | string |
None. |
|
| InvoiceNr | string |
None. |
|
| Status | string |
None. |
|
| Supplier | string |
None. |
|
| SupplierID | integer |
None. |
|
| RecordedDelivery | boolean |
None. |
|
| CreateDateUtc | string |
None. |
|
| NetDeliveryCharge | decimal number |
None. |
|
| DeliveryChargeTaxValue | decimal number |
None. |
|
| GrossDeliveryCharge | decimal number |
None. |
|
| NetExtraCharge | decimal number |
None. |
|
| Product | string |
None. |
|
| ProductTypeID | integer |
None. |
|
| ProductTypeName | string |
None. |
|
| ProductGroupID | integer |
None. |
|
| ProductGroupName | string |
None. |
|
| StockLocationID | integer |
None. |
|
| StockLocationName | string |
None. |
|
| ProductCode | string |
None. |
|
| PurchaseUnit | string |
None. |
|
| PurchaseUnitQty | decimal number |
None. |
|
| TaxRate | decimal number |
None. |
|
| TaxType | string |
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. |
|
| CreateDate | string |
None. |
|
| PageSize | integer |
None. |
|
| TotalCount | integer |
None. |
|
| ActualDeliveryDateUtc | string |
None. |
|
| ApprovalDateUtc | string |
None. |
|
| CompleteDateUtc | string |
None. |
|
| LastModifiedUtc | string |
None. |
|
| LastModifiedBy | string |
None. |
|
| HasMorePages | boolean |
None. |
Response Formats
application/json, text/json
[
{
"SiteID": 1,
"SiteName": "sample string 2",
"LocalTimeZoneID": "sample string 3",
"PurchaseOrderNumber": "sample string 4",
"InvoiceNr": "sample string 5",
"Status": "sample string 6",
"Supplier": "sample string 7",
"SupplierID": 8,
"RecordedDelivery": true,
"CreateDateUtc": "sample string 10",
"NetDeliveryCharge": 11.0,
"DeliveryChargeTaxValue": 12.0,
"GrossDeliveryCharge": 13.0,
"NetExtraCharge": 14.0,
"Product": "sample string 15",
"ProductTypeID": 16,
"ProductTypeName": "sample string 17",
"ProductGroupID": 18,
"ProductGroupName": "sample string 19",
"StockLocationID": 20,
"StockLocationName": "sample string 21",
"ProductCode": "sample string 22",
"PurchaseUnit": "sample string 23",
"PurchaseUnitQty": 24.0,
"TaxRate": 25.0,
"TaxType": "sample string 26",
"OrderQty": 27.0,
"OrderNetUnitPrice": 28.0,
"OrderLineSubtotal": 29.0,
"DeliveredQty": 30.0,
"DeliveryNetUnitPrice": 31.0,
"DeliveryLineSubtotal": 32.0,
"DeliveryLineTaxValue": 33.0,
"DeliveryLineTotal": 34.0,
"RowNumber": 35,
"CreateDate": "sample string 36",
"PageSize": 37,
"TotalCount": 38,
"ActualDeliveryDateUtc": "sample string 39",
"ApprovalDateUtc": "sample string 40",
"CompleteDateUtc": "sample string 41",
"LastModifiedUtc": "sample string 42",
"LastModifiedBy": "sample string 43",
"HasMorePages": true
},
{
"SiteID": 1,
"SiteName": "sample string 2",
"LocalTimeZoneID": "sample string 3",
"PurchaseOrderNumber": "sample string 4",
"InvoiceNr": "sample string 5",
"Status": "sample string 6",
"Supplier": "sample string 7",
"SupplierID": 8,
"RecordedDelivery": true,
"CreateDateUtc": "sample string 10",
"NetDeliveryCharge": 11.0,
"DeliveryChargeTaxValue": 12.0,
"GrossDeliveryCharge": 13.0,
"NetExtraCharge": 14.0,
"Product": "sample string 15",
"ProductTypeID": 16,
"ProductTypeName": "sample string 17",
"ProductGroupID": 18,
"ProductGroupName": "sample string 19",
"StockLocationID": 20,
"StockLocationName": "sample string 21",
"ProductCode": "sample string 22",
"PurchaseUnit": "sample string 23",
"PurchaseUnitQty": 24.0,
"TaxRate": 25.0,
"TaxType": "sample string 26",
"OrderQty": 27.0,
"OrderNetUnitPrice": 28.0,
"OrderLineSubtotal": 29.0,
"DeliveredQty": 30.0,
"DeliveryNetUnitPrice": 31.0,
"DeliveryLineSubtotal": 32.0,
"DeliveryLineTaxValue": 33.0,
"DeliveryLineTotal": 34.0,
"RowNumber": 35,
"CreateDate": "sample string 36",
"PageSize": 37,
"TotalCount": 38,
"ActualDeliveryDateUtc": "sample string 39",
"ApprovalDateUtc": "sample string 40",
"CompleteDateUtc": "sample string 41",
"LastModifiedUtc": "sample string 42",
"LastModifiedBy": "sample string 43",
"HasMorePages": true
}
]
application/xml, text/xml
<ArrayOfPurchaseOrdersReportItemDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.Reporting">
<PurchaseOrdersReportItemDto>
<_x003C_ActualDeliveryDateUtc_x003E_k__BackingField>sample string 39</_x003C_ActualDeliveryDateUtc_x003E_k__BackingField>
<_x003C_ApprovalDateUtc_x003E_k__BackingField>sample string 40</_x003C_ApprovalDateUtc_x003E_k__BackingField>
<_x003C_CompleteDateUtc_x003E_k__BackingField>sample string 41</_x003C_CompleteDateUtc_x003E_k__BackingField>
<_x003C_CreateDateUtc_x003E_k__BackingField>sample string 10</_x003C_CreateDateUtc_x003E_k__BackingField>
<_x003C_CreateDate_x003E_k__BackingField>sample string 36</_x003C_CreateDate_x003E_k__BackingField>
<_x003C_DeliveredQty_x003E_k__BackingField>30</_x003C_DeliveredQty_x003E_k__BackingField>
<_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>12</_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>
<_x003C_DeliveryLineSubtotal_x003E_k__BackingField>32</_x003C_DeliveryLineSubtotal_x003E_k__BackingField>
<_x003C_DeliveryLineTaxValue_x003E_k__BackingField>33</_x003C_DeliveryLineTaxValue_x003E_k__BackingField>
<_x003C_DeliveryLineTotal_x003E_k__BackingField>34</_x003C_DeliveryLineTotal_x003E_k__BackingField>
<_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>31</_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>
<_x003C_GrossDeliveryCharge_x003E_k__BackingField>13</_x003C_GrossDeliveryCharge_x003E_k__BackingField>
<_x003C_HasMorePages_x003E_k__BackingField>true</_x003C_HasMorePages_x003E_k__BackingField>
<_x003C_InvoiceNr_x003E_k__BackingField>sample string 5</_x003C_InvoiceNr_x003E_k__BackingField>
<_x003C_LastModifiedBy_x003E_k__BackingField>sample string 43</_x003C_LastModifiedBy_x003E_k__BackingField>
<_x003C_LastModifiedUtc_x003E_k__BackingField>sample string 42</_x003C_LastModifiedUtc_x003E_k__BackingField>
<_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 3</_x003C_LocalTimeZoneID_x003E_k__BackingField>
<_x003C_NetDeliveryCharge_x003E_k__BackingField>11</_x003C_NetDeliveryCharge_x003E_k__BackingField>
<_x003C_NetExtraCharge_x003E_k__BackingField>14</_x003C_NetExtraCharge_x003E_k__BackingField>
<_x003C_OrderLineSubtotal_x003E_k__BackingField>29</_x003C_OrderLineSubtotal_x003E_k__BackingField>
<_x003C_OrderNetUnitPrice_x003E_k__BackingField>28</_x003C_OrderNetUnitPrice_x003E_k__BackingField>
<_x003C_OrderQty_x003E_k__BackingField>27</_x003C_OrderQty_x003E_k__BackingField>
<_x003C_PageSize_x003E_k__BackingField>37</_x003C_PageSize_x003E_k__BackingField>
<_x003C_ProductCode_x003E_k__BackingField>sample string 22</_x003C_ProductCode_x003E_k__BackingField>
<_x003C_ProductGroupID_x003E_k__BackingField>18</_x003C_ProductGroupID_x003E_k__BackingField>
<_x003C_ProductGroupName_x003E_k__BackingField>sample string 19</_x003C_ProductGroupName_x003E_k__BackingField>
<_x003C_ProductTypeID_x003E_k__BackingField>16</_x003C_ProductTypeID_x003E_k__BackingField>
<_x003C_ProductTypeName_x003E_k__BackingField>sample string 17</_x003C_ProductTypeName_x003E_k__BackingField>
<_x003C_Product_x003E_k__BackingField>sample string 15</_x003C_Product_x003E_k__BackingField>
<_x003C_PurchaseOrderNumber_x003E_k__BackingField>sample string 4</_x003C_PurchaseOrderNumber_x003E_k__BackingField>
<_x003C_PurchaseUnitQty_x003E_k__BackingField>24</_x003C_PurchaseUnitQty_x003E_k__BackingField>
<_x003C_PurchaseUnit_x003E_k__BackingField>sample string 23</_x003C_PurchaseUnit_x003E_k__BackingField>
<_x003C_RecordedDelivery_x003E_k__BackingField>true</_x003C_RecordedDelivery_x003E_k__BackingField>
<_x003C_RowNumber_x003E_k__BackingField>35</_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_Status_x003E_k__BackingField>sample string 6</_x003C_Status_x003E_k__BackingField>
<_x003C_StockLocationID_x003E_k__BackingField>20</_x003C_StockLocationID_x003E_k__BackingField>
<_x003C_StockLocationName_x003E_k__BackingField>sample string 21</_x003C_StockLocationName_x003E_k__BackingField>
<_x003C_SupplierID_x003E_k__BackingField>8</_x003C_SupplierID_x003E_k__BackingField>
<_x003C_Supplier_x003E_k__BackingField>sample string 7</_x003C_Supplier_x003E_k__BackingField>
<_x003C_TaxRate_x003E_k__BackingField>25</_x003C_TaxRate_x003E_k__BackingField>
<_x003C_TaxType_x003E_k__BackingField>sample string 26</_x003C_TaxType_x003E_k__BackingField>
<_x003C_TotalCount_x003E_k__BackingField>38</_x003C_TotalCount_x003E_k__BackingField>
</PurchaseOrdersReportItemDto>
<PurchaseOrdersReportItemDto>
<_x003C_ActualDeliveryDateUtc_x003E_k__BackingField>sample string 39</_x003C_ActualDeliveryDateUtc_x003E_k__BackingField>
<_x003C_ApprovalDateUtc_x003E_k__BackingField>sample string 40</_x003C_ApprovalDateUtc_x003E_k__BackingField>
<_x003C_CompleteDateUtc_x003E_k__BackingField>sample string 41</_x003C_CompleteDateUtc_x003E_k__BackingField>
<_x003C_CreateDateUtc_x003E_k__BackingField>sample string 10</_x003C_CreateDateUtc_x003E_k__BackingField>
<_x003C_CreateDate_x003E_k__BackingField>sample string 36</_x003C_CreateDate_x003E_k__BackingField>
<_x003C_DeliveredQty_x003E_k__BackingField>30</_x003C_DeliveredQty_x003E_k__BackingField>
<_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>12</_x003C_DeliveryChargeTaxValue_x003E_k__BackingField>
<_x003C_DeliveryLineSubtotal_x003E_k__BackingField>32</_x003C_DeliveryLineSubtotal_x003E_k__BackingField>
<_x003C_DeliveryLineTaxValue_x003E_k__BackingField>33</_x003C_DeliveryLineTaxValue_x003E_k__BackingField>
<_x003C_DeliveryLineTotal_x003E_k__BackingField>34</_x003C_DeliveryLineTotal_x003E_k__BackingField>
<_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>31</_x003C_DeliveryNetUnitPrice_x003E_k__BackingField>
<_x003C_GrossDeliveryCharge_x003E_k__BackingField>13</_x003C_GrossDeliveryCharge_x003E_k__BackingField>
<_x003C_HasMorePages_x003E_k__BackingField>true</_x003C_HasMorePages_x003E_k__BackingField>
<_x003C_InvoiceNr_x003E_k__BackingField>sample string 5</_x003C_InvoiceNr_x003E_k__BackingField>
<_x003C_LastModifiedBy_x003E_k__BackingField>sample string 43</_x003C_LastModifiedBy_x003E_k__BackingField>
<_x003C_LastModifiedUtc_x003E_k__BackingField>sample string 42</_x003C_LastModifiedUtc_x003E_k__BackingField>
<_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 3</_x003C_LocalTimeZoneID_x003E_k__BackingField>
<_x003C_NetDeliveryCharge_x003E_k__BackingField>11</_x003C_NetDeliveryCharge_x003E_k__BackingField>
<_x003C_NetExtraCharge_x003E_k__BackingField>14</_x003C_NetExtraCharge_x003E_k__BackingField>
<_x003C_OrderLineSubtotal_x003E_k__BackingField>29</_x003C_OrderLineSubtotal_x003E_k__BackingField>
<_x003C_OrderNetUnitPrice_x003E_k__BackingField>28</_x003C_OrderNetUnitPrice_x003E_k__BackingField>
<_x003C_OrderQty_x003E_k__BackingField>27</_x003C_OrderQty_x003E_k__BackingField>
<_x003C_PageSize_x003E_k__BackingField>37</_x003C_PageSize_x003E_k__BackingField>
<_x003C_ProductCode_x003E_k__BackingField>sample string 22</_x003C_ProductCode_x003E_k__BackingField>
<_x003C_ProductGroupID_x003E_k__BackingField>18</_x003C_ProductGroupID_x003E_k__BackingField>
<_x003C_ProductGroupName_x003E_k__BackingField>sample string 19</_x003C_ProductGroupName_x003E_k__BackingField>
<_x003C_ProductTypeID_x003E_k__BackingField>16</_x003C_ProductTypeID_x003E_k__BackingField>
<_x003C_ProductTypeName_x003E_k__BackingField>sample string 17</_x003C_ProductTypeName_x003E_k__BackingField>
<_x003C_Product_x003E_k__BackingField>sample string 15</_x003C_Product_x003E_k__BackingField>
<_x003C_PurchaseOrderNumber_x003E_k__BackingField>sample string 4</_x003C_PurchaseOrderNumber_x003E_k__BackingField>
<_x003C_PurchaseUnitQty_x003E_k__BackingField>24</_x003C_PurchaseUnitQty_x003E_k__BackingField>
<_x003C_PurchaseUnit_x003E_k__BackingField>sample string 23</_x003C_PurchaseUnit_x003E_k__BackingField>
<_x003C_RecordedDelivery_x003E_k__BackingField>true</_x003C_RecordedDelivery_x003E_k__BackingField>
<_x003C_RowNumber_x003E_k__BackingField>35</_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_Status_x003E_k__BackingField>sample string 6</_x003C_Status_x003E_k__BackingField>
<_x003C_StockLocationID_x003E_k__BackingField>20</_x003C_StockLocationID_x003E_k__BackingField>
<_x003C_StockLocationName_x003E_k__BackingField>sample string 21</_x003C_StockLocationName_x003E_k__BackingField>
<_x003C_SupplierID_x003E_k__BackingField>8</_x003C_SupplierID_x003E_k__BackingField>
<_x003C_Supplier_x003E_k__BackingField>sample string 7</_x003C_Supplier_x003E_k__BackingField>
<_x003C_TaxRate_x003E_k__BackingField>25</_x003C_TaxRate_x003E_k__BackingField>
<_x003C_TaxType_x003E_k__BackingField>sample string 26</_x003C_TaxType_x003E_k__BackingField>
<_x003C_TotalCount_x003E_k__BackingField>38</_x003C_TotalCount_x003E_k__BackingField>
</PurchaseOrdersReportItemDto>
</ArrayOfPurchaseOrdersReportItemDto>