VUZDevelopers

Get collection summary metrics

GET
/analytics/collections/summary

Retrieves comprehensive collection summary metrics for the specified period.

Default Period: Year-to-date (YTD) if no dates provided

Metrics Returned:

  • Total billed amount
  • Total collected amount
  • Outstanding amount
  • Overdue amount
  • Collection rate (percentage)
  • Days Sales Outstanding (DSO)
  • Outstanding and overdue invoice counts

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

startDate?string

Start date (YYYY-MM-DD)

endDate?string

End date (YYYY-MM-DD)

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/collections/summary"
{  "totalBilled": 0,  "totalCollected": 0,  "outstandingAmount": 0,  "overdueAmount": 0,  "collectionRate": 0,  "dso": 0,  "overdueCount": 0,  "outstandingCount": 0,  "currency": "string"}