Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
PurchaseOrder

Search_PurchaseOrders2

Searches purchase order by a number of parameters, such as Date of Purchase, status, reference number. Returns paged result of purchase order header. <b>Permissions Required: </b> GlobalPermissions.Inventory.PurchaseOrder.SearchPurchaseOrderNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/PurchaseOrder/Search_PurchaseOrders2

Request body

DateFromstring date-time

Purchase order date range from (optional)

DateTostring date-time

Purchase order date range to (optional)

Status'PENDING' | 'OPEN' | 'PARTIAL' | 'DELIVERED'

Purchase order status: PENDING - purchase order can be changed, not yet affecting stock levels OPEN - purchase order is created and stock levels Due are reflected PARTIAL - partially delivered DELIVERED - fully delivered

SearchValuestring

Specifies search value to filter with result set

SearchType'All' | 'Reference' | 'StockItemSKU' | 'SupplierCode' | 'SupplierReference'

Specifies search value type for search value

EntriesPerPageinteger

Number of records returned, sorted by Purchase Order Date

PageNumberinteger

Page Number

Locationstring[]

Current Location

Supplierstring[]

Current Supplier

Example request

{
  "Location": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "Supplier": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Response

OK

TotalPagesinteger

Total number of pages

CurrentPageNumberinteger

Currently request page number

EntriesPerPageinteger

Requested entries per page

TotalNumberOfRecordsinteger

Total number of records matching the search request

Example response

{
  "Result": [
    {
      "pkPurchaseID": "00000000-0000-0000-0000-000000000000",
      "fkSupplierId": "00000000-0000-0000-0000-000000000000",
      "fkLocationId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}