VUZDevelopers

Get expense breakdown by supplier

GET
/analytics/expenses/by-supplier

Retrieves expense breakdown by supplier, showing top suppliers by expense amount.

Data Returned:

  • Top N suppliers (default 10)
  • Total amount and expense count per supplier
  • Percentage of total expenses
  • Main category per supplier

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)

limit?number

Number of suppliers to return

Default10

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/expenses/by-supplier"
{  "currency": "string",  "startDate": "string",  "endDate": "string",  "suppliers": [    {      "supplierId": "string",      "supplierName": "string",      "totalAmount": 0,      "expenseCount": 0,      "percentage": 0,      "mainCategory": "string"    }  ],  "otherAmount": 0,  "totalExpenses": 0}