Retrieve a purchase order's KPIs

Returns the KPI figures of one purchase order under purchase_order_kpis.

GET /purchase_orders/{purchase_order_id}/kpis

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_orders/PURCHASE_ORDER_ID/kpis" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "purchase_order_kpis": {
    "estimated_total": "<string>",
    "issue_date": "<unknown>",
    "last_cancelled_on": "<unknown>",
    "last_changed_on": "<unknown>",
    "last_deleted_on": "<unknown>",
    "last_invoice_issue_date": "<unknown>",
    "last_invoice_total": "<string>",
    "last_reactivated_on": "<unknown>",
    "object": "<string>",
    "total_expense": "<string>",
    "total_outstanding": "<string>",
    "total_overdue": "<string>",
    "total_purchase_invoice": 123
  }
}

Returns the purchase order’s KPIs, such as total_purchase_invoice, total_outstanding and total_overdue, under purchase_order_kpis. The same figures come with the purchase order as kpis.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

purchase_order_id · string · required

The purchase order's id.

Response

200 - application/json

The KPIs, under purchase_order_kpis.

purchase_order_kpis · object

Show child attributes