PO exposure

Reports module

GET/reports/po-exposurereports.poExposure

Committed purchase order value (lines plus approved changes) against value received, by vendor. An order with an unpriced line stays out of each sum and is counted in `unpriced_count`. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability procurement.po.read.
OAuth scopes: procurement.
Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

reports.poExposure: Path and query parameters
Field	Type	Required	Description
project_id	string (uuid)	No	Only this project; every visible project when omitted.

Response 200: ReportRowPage

reports.poExposure: ReportRowPage
Field	Type	Required	Description
data	array of ReportRow	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "dimension": "5400",
      "budget": {
        "total_minor": 1250000,
        "currency": "USD",
        "unpriced_count": 2
      },
      "actual": {
        "total_minor": 1250000,
        "currency": "USD",
        "unpriced_count": 2
      }
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/reports/po-exposure" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.reports.poExposure();

response = xos.reports.po_exposure()

xos reports po-exposure