Get Purchase Order Summary

Changed on

Operates on Purchase Orders. In the Zuper client app this module is labeled "Purchase Order" for most companies, and "Material Order" for companies in the roofing industry — the API and data shape are identical either way. Purchase Orders and Work Orders (Service Orders) share the exact same underlying schema and endpoints; they're distinguished only by the purchase_order_type field (PURCHASE_ORDER here) and the /purchase_orders vs /service_orders route prefix. Returns order counts/totals overall and broken down by status, plus an OVERDUE bucket (orders past their due_date in an active pre-fulfillment status).

post/purchase_orders/summary

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/purchase_orders/summary
  • Auth
    API key in header x-api-key

Request body

filter_rulesobject[]
filter_rule_operator'AND' | 'OR'

Response

200

type'success'
messagestring

Changes