procureToPayAnalytics

Requires at least one of the permissions analytics:organization:read or purchase:purchase_order:read.

Procure-to-pay (purchase side) analytics over a date range, limited to what your role may see: sales reps see their own records, admins see everything by default, and other staff see their team. Needs the purchase orders feature on your plan.. Needs the organization analytics read or purchase order read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ProcureToPayAnalytics($range: AnalyticsRangeInput!) {
  procureToPayAnalytics(range: $range) {
    onTimeReceiptPct
    openPoValue
    avgLeadTimeDays {
      billToPaid
      grnToBill
      poToGrn
      total
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ProcureToPayAnalytics($range: AnalyticsRangeInput!) {\n  procureToPayAnalytics(range: $range) {\n    onTimeReceiptPct\n    openPoValue\n    avgLeadTimeDays {\n      billToPaid\n      grnToBill\n      poToGrn\n      total\n    }\n  }\n}",
  "variables": {
    "range": {
      "from": "2025-01-15T00:00:00Z",
      "to": "2025-01-15T00:00:00Z"
    }
  }
}
EOF

Variables:

{
  "range": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T00:00:00Z"
  }
}

Response:

{
  "data": {
    "procureToPayAnalytics": {
      "onTimeReceiptPct": 0,
      "openPoValue": 0,
      "avgLeadTimeDays": {
        "billToPaid": 0,
        "grnToBill": 0,
        "poToGrn": 0,
        "total": 0
      }
    }
  }
}

procureToPayAnalytics(
  range: AnalyticsRangeInput!
): ProcureToPayAnalytics!

Arguments

procureToPayAnalytics.range ● AnalyticsRangeInput! non-null input

The date range and, optionally, the visibility scope.

Type

ProcureToPayAnalytics object

Purchasing figures from order to payment.