Saltar al contenido

PO exposure

Módulo Reports

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`.

  • Requiere la capacidad procurement.po.read.
  • Alcances de OAuth: procurement.
  • Estados de error: 400, 401, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

reports.poExposure: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
project_idstring (uuid)NoOnly this project; every visible project when omitted.

Respuesta 200: ReportRowPage

reports.poExposure: ReportRowPage
CampoTipoObligatorioDescripción
dataarray of ReportRowSíItems on this page, in the documented default order.
next_cursorstring | nullSí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
}

Ejemplos de código

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