Retrieve an order's KPIs

Returns an order’s key figures, such as revenue and amounts due, under order_kpis.

GET /orders/{order_id}/kpis

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/kpis" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "order_kpis": {
    "deleted_at": "<unknown>",
    "estimated_total": "<string>",
    "last_cancelled_at": "<unknown>",
    "last_changed_at": "<unknown>",
    "last_invoice_issue_date": "<unknown>",
    "last_invoice_total": "<string>",
    "last_reactivated_at": "<unknown>",
    "monthly_recurring_revenue": "<string>",
    "next_invoice_issue_date": "<unknown>",
    "object": "<string>",
    "start_date": "<unknown>",
    "total_collected": "<string>",
    "total_due": "<string>",
    "total_invoice": 123,
    "total_outstanding": "<string>",
    "total_revenue": "<string>"
  }
}

Pass the order’s id. The response holds totals such as total_revenue, total_outstanding and monthly_recurring_revenue, and dates such as the next invoice date.

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

order_id · string · required

The order's id, as GET /orders lists it.

Response

200 - application/json

The KPIs, under order_kpis.

order_kpis · object

Show child attributes