GET purchase-orders?RaisedDateFrom={RaisedDateFrom}&RaisedDateTo={RaisedDateTo}&SentDateFrom={SentDateFrom}&SentDateTo={SentDateTo}&DueDateFrom={DueDateFrom}&DueDateTo={DueDateTo}&SupplierID={SupplierID}&WarehouseID={WarehouseID}&PurchaseOrderStatus={PurchaseOrderStatus}&PageSize={PageSize}&Page={Page}

Returns information about multiple Purchase Orders matching the filter information provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RaisedDateFrom This is an optional parameter. This inidicates the earliest Raised Date which will be returned. date None.
RaisedDateTo This is an optional parameter. This indicates the most recent Raised Date which will be returned. date None.
SentDateFrom This is an optional parameter. This indicates the earliest Sent Date which will be returned date None.
SentDateTo This is an optional parameter. This indicates the most recent Sent Date which will be returned date None.
DueDateFrom This is an optional parameter. This indicates the earliest Due Date which will be returned. date None.
DueDateTo This is an optional parameter. This indicates the most recent Due Date which will be returned. date None.
SupplierID This is an optional parameter. Specifying a Supplier ID will only return Purchase Orders for that Supplier. integer Matching regular expression pattern: ^[1-9]\d*$
WarehouseID This is an optional parameter. Specifying a Warehouse ID will only return Purchase Orders for that Warehouse. integer Matching regular expression pattern: ^[1-9]\d*$
PurchaseOrderStatus This is an optional parameter. Specifying a Status will only return Purchase Orders with that matching status. PurchaseOrderStatuses None.
PageSize integer Range: inclusive between 1 and 100
Page This is an optional parameter. It will default to page 1. integer Matching regular expression pattern: ^[1-9]\d*$

Body Parameters

None.

Response Information

Resource Description

Returns information about multiple Purchase Orders matching the filter information provided.

PagedResponseModelOfPurchaseOrderModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
Data Collection of PurchaseOrderModel None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "PagingInfo": {
    "PageSize": 1,
    "Page": 2
  },
  "TotalPages": 2,
  "Data": [
    {
      "PurchaseOrderID": 1,
      "PurchaseOrderGuid": "69ba971c-74c8-4c23-b068-01502e9a552b",
      "User": {
        "UserID": 1,
        "UserName": "sample string 2"
      },
      "PurchaseOrderReference": "sample string 2",
      "DateRaised": "2017-12-16T21:46:43.6585461+00:00",
      "Supplier": {
        "SupplierID": 1,
        "Name": "sample string 1"
      },
      "Warehouse": {
        "WarehouseName": "sample string 1",
        "WarehouseGuid": "88adcba1-9bb9-40ec-9074-149e4c067a80",
        "WarehouseID": 3
      },
      "DateDue": "2017-12-16T21:46:43.6741461+00:00",
      "PurchaseOrderStatus": "Draft",
      "DeliveryCost": 1.0,
      "Subtotal": 1.0,
      "TotalVat": 1.0,
      "Total": 1.0,
      "Currency": {
        "CurrencyID": 1,
        "CurrencyCode": "sample string 2",
        "CurrencyName": "sample string 3",
        "Symbol": "sample string 4"
      },
      "DateSent": "2017-12-16T21:46:43.6741461+00:00",
      "PurchaseOrderLines": [
        {
          "PurchaseOrderLineID": 1,
          "ProductSKU": "sample string 2",
          "QtyOrdered": 1,
          "QtyReceived": 1,
          "PurchaseOrderDetailsStatus": "AwaitingProduct",
          "SinglePrice": 1.0,
          "TaxRate": 1.0,
          "LineVat": 1.0,
          "LineTotal": 1.0,
          "DeliveryStatusID": 1,
          "DeliveryStatus": "sample string 3",
          "QtyWrittenOff": 1.0,
          "CartonQty": 4,
          "AddedByUserID": 1,
          "BookedInByUserID": 1,
          "TotalUnitsOrdered": 5,
          "TotalUnitsReceived": 1,
          "TotalUnitsWrittenOff": 1,
          "LineNotes": "sample string 6"
        },
        {
          "PurchaseOrderLineID": 1,
          "ProductSKU": "sample string 2",
          "QtyOrdered": 1,
          "QtyReceived": 1,
          "PurchaseOrderDetailsStatus": "AwaitingProduct",
          "SinglePrice": 1.0,
          "TaxRate": 1.0,
          "LineVat": 1.0,
          "LineTotal": 1.0,
          "DeliveryStatusID": 1,
          "DeliveryStatus": "sample string 3",
          "QtyWrittenOff": 1.0,
          "CartonQty": 4,
          "AddedByUserID": 1,
          "BookedInByUserID": 1,
          "TotalUnitsOrdered": 5,
          "TotalUnitsReceived": 1,
          "TotalUnitsWrittenOff": 1,
          "LineNotes": "sample string 6"
        }
      ]
    },
    {
      "PurchaseOrderID": 1,
      "PurchaseOrderGuid": "69ba971c-74c8-4c23-b068-01502e9a552b",
      "User": {
        "UserID": 1,
        "UserName": "sample string 2"
      },
      "PurchaseOrderReference": "sample string 2",
      "DateRaised": "2017-12-16T21:46:43.6585461+00:00",
      "Supplier": {
        "SupplierID": 1,
        "Name": "sample string 1"
      },
      "Warehouse": {
        "WarehouseName": "sample string 1",
        "WarehouseGuid": "88adcba1-9bb9-40ec-9074-149e4c067a80",
        "WarehouseID": 3
      },
      "DateDue": "2017-12-16T21:46:43.6741461+00:00",
      "PurchaseOrderStatus": "Draft",
      "DeliveryCost": 1.0,
      "Subtotal": 1.0,
      "TotalVat": 1.0,
      "Total": 1.0,
      "Currency": {
        "CurrencyID": 1,
        "CurrencyCode": "sample string 2",
        "CurrencyName": "sample string 3",
        "Symbol": "sample string 4"
      },
      "DateSent": "2017-12-16T21:46:43.6741461+00:00",
      "PurchaseOrderLines": [
        {
          "PurchaseOrderLineID": 1,
          "ProductSKU": "sample string 2",
          "QtyOrdered": 1,
          "QtyReceived": 1,
          "PurchaseOrderDetailsStatus": "AwaitingProduct",
          "SinglePrice": 1.0,
          "TaxRate": 1.0,
          "LineVat": 1.0,
          "LineTotal": 1.0,
          "DeliveryStatusID": 1,
          "DeliveryStatus": "sample string 3",
          "QtyWrittenOff": 1.0,
          "CartonQty": 4,
          "AddedByUserID": 1,
          "BookedInByUserID": 1,
          "TotalUnitsOrdered": 5,
          "TotalUnitsReceived": 1,
          "TotalUnitsWrittenOff": 1,
          "LineNotes": "sample string 6"
        },
        {
          "PurchaseOrderLineID": 1,
          "ProductSKU": "sample string 2",
          "QtyOrdered": 1,
          "QtyReceived": 1,
          "PurchaseOrderDetailsStatus": "AwaitingProduct",
          "SinglePrice": 1.0,
          "TaxRate": 1.0,
          "LineVat": 1.0,
          "LineTotal": 1.0,
          "DeliveryStatusID": 1,
          "DeliveryStatus": "sample string 3",
          "QtyWrittenOff": 1.0,
          "CartonQty": 4,
          "AddedByUserID": 1,
          "BookedInByUserID": 1,
          "TotalUnitsOrdered": 5,
          "TotalUnitsReceived": 1,
          "TotalUnitsWrittenOff": 1,
          "LineNotes": "sample string 6"
        }
      ]
    }
  ]
}