Retrieve a booking's KPIs

Returns a booking’s key figures under order_kpis.

GET /booking/{booking_id}/kpis

cURL

cURL

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

200

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

Returns figures such as total_revenue, total_collected, total_outstanding and monthly_recurring_revenue, under order_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

booking_id · string · required

The booking's id. Any order's id works here, whatever the order's type.

Response

200 - application/json

The KPIs, under order_kpis.

order_kpis · object · required

Show child attributes