VUZDevelopers

Get monthly turnover

GET
/analytics/monthly-turnover

Retrieves current and previous month turnover with percentage change.

Calculation Method:

  • עוסק מורשה / חברה בע"מ: Sum of tax invoices (subTotal - before VAT)
  • עוסק פטור: Sum of receipts and deal bills (grandTotal - no VAT)

Data Returned:

  • Current month turnover
  • Previous month turnover
  • Percentage change
  • Business type and calculation method used

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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/monthly-turnover"
{  "currentMonthTurnover": 45000,  "previousMonthTurnover": 38000,  "percentageChange": 18.42,  "currency": "ILS",  "currentMonth": "2025-12",  "previousMonth": "2025-11",  "businessType": "osek_murshe",  "calculationMethod": "Calculated from tax invoices (before VAT)"}