VUZDevelopers

Get expense summary metrics

GET
/analytics/expenses/summary

Retrieves comprehensive expense summary metrics for the specified period.

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

Metrics Returned:

  • Total expenses for the period
  • Expense count
  • Deductible vs non-deductible amounts
  • Expense to revenue ratio
  • Largest expense category

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/expenses/summary"
{  "totalExpenses": 0,  "expenseCount": 0,  "deductibleAmount": 0,  "deductiblePercentage": 0,  "expenseToRevenueRatio": 0,  "totalRevenue": 0,  "largestCategory": {    "category": "string",    "label": "string",    "labelEn": "string",    "amount": 0,    "percentage": 0  },  "currency": "string",  "startDate": "string",  "endDate": "string"}