VUZDevelopers

Get client aggregates

GET
/clients/{clientId}/statistics/aggregates

Returns aggregated statistics for a client including:

  • Revenue: Total, current year, previous year, last 12 months
  • Balance: Outstanding, overdue, credit
  • Documents: Invoice counts, quote counts, credit notes
  • Payment behavior: DSO, on-time rate, bounced checks
  • Activity: First/last transaction, days since activity

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

Path Parameters

clientId*string

Client ID

Response Body

application/json

curl -X GET "https://example.com/clients/string/statistics/aggregates"
{  "clientId": "string",  "totalRevenue": 0,  "revenueCurrentYear": 0,  "revenuePreviousYear": 0,  "revenueLast12Months": 0,  "yoyGrowth": 0,  "outstandingBalance": 0,  "overdueBalance": 0,  "creditBalance": 0,  "totalInvoices": 0,  "paidInvoices": 0,  "openInvoices": 0,  "overdueInvoices": 0,  "paymentRate": 0,  "totalQuotes": 0,  "convertedQuotes": 0,  "quoteConversionRate": 0,  "totalCreditNotes": 0,  "creditNotesAmount": 0,  "avgDaysToPayment": 0,  "onTimePaymentRate": 0,  "bouncedChecks": 0,  "firstTransactionDate": "2019-08-24T14:15:22Z",  "lastTransactionDate": "2019-08-24T14:15:22Z",  "lastPaymentDate": "2019-08-24T14:15:22Z",  "daysSinceLastActivity": 0,  "activeMonthsLast12": 0,  "avgInvoiceAmount": 0,  "largestInvoice": 0,  "lastFullRecalculation": "2019-08-24T14:15:22Z",  "lastIncrementalUpdate": "2019-08-24T14:15:22Z"}