Retrieve an invoice's KPIs

Returns an invoice’s key figures, such as payment applied and amount outstanding.

GET /invoices/{invoice_id}/kpis

cURL

cURL

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

200

{
  "invoice_kpis": {
    "credit_applied": "<string>",
    "credit_issued": "<string>",
    "payment_applied": "<string>",
    "last_payment_date": "<string>",
    "last_amended_on": "<string>",
    "last_cancelled_on": "<string>",
    "last_reactivated_on": "<string>",
    "deleted_on": "<string>",
    "voided_on": "<string>",
    "outstanding": "<unknown>",
    "overdue": "<unknown>",
    "object": "<string>"
  }
}

Fetches the invoice’s KPI block under invoice_kpis, the same block a retrieved invoice carries as kpis. Amounts such as payment_applied are strings.

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

invoice_id · string · required

The invoice's id, such as INV-0001. Not its uuid.

Response

200 - application/json

The KPIs, under invoice_kpis.

invoice_kpis · object

Show child attributes