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 | datetime |
Date which the report will search for purchase orders from |
None. |
| DateUtcTo | datetime |
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 | datetime |
Date which the report will search for purchase orders from |
None. |
| DateUtcTo | datetime |
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": "2026-10-10T23:19:08.972147",
"DateUtcTo": "2026-10-10T23:19:08.972147",
"ProductTypeIDs": [
1,
2
],
"ProductGroupIDs": [
1,
2
],
"SupplierIDs": [
1,
2
],
"StockLocationIDs": [
1,
2
],
"PurchaseOrderID": 1
}
application/xml, text/xml
System.Xml.XmlDocument
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
System.Xml.XmlDocument