VUZDevelopers

Get collection breakdown by client

GET
/analytics/collections/by-client

Retrieves collection data broken down by client.

Data Returned:

  • Top N clients with outstanding amounts
  • Total billed and collected per client
  • Outstanding and overdue amounts
  • Collection rate per client
  • Days since oldest unpaid invoice

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

limit?number

Maximum number of clients to return

Default10

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/collections/by-client"
{  "currency": "string",  "clients": [    {      "clientId": "string",      "clientName": "string",      "totalBilled": 0,      "totalCollected": 0,      "outstanding": 0,      "overdue": 0,      "oldestInvoiceDays": 0,      "collectionRate": 0    }  ],  "totalClients": 0}