VUZDevelopers

Get project statistics

GET
/projects/{id}/stats

Retrieves aggregated statistics for a project.

Statistics Include:

  • estimatedValue: Project estimated value
  • invoicedAmount: Total invoiced amount
  • paidAmount: Total paid amount
  • outstandingAmount: Amount still owed
  • quotesCount: Number of quotes
  • invoicesCount: Number of invoices
  • receiptsCount: Number of receipts
  • totalDocuments: Total linked documents
  • completionPercentage: Payment progress (0-100)

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

id*string

Project UUID

Response Body

application/json

application/json

curl -X GET "https://example.com/projects/string/stats"
{  "projectId": "string",  "projectName": "string",  "estimatedValue": "string",  "invoicedAmount": "string",  "paidAmount": "string",  "outstandingAmount": "string",  "quotesCount": 0,  "invoicesCount": 0,  "receiptsCount": 0,  "totalDocuments": 0,  "workOrdersCount": 0,  "completionPercentage": 0}