VUZDevelopers

Get VAT summary for current period

GET
/analytics/vat/summary

Retrieves VAT summary for a specific tax period.

Period Format: "01-02/2025" (bi-monthly) or "01/2025" (monthly)

Data Returned:

  • Output VAT (מע"מ עסקאות) - from sales
  • Input VAT (מע"מ תשומות) - from deductible expenses
  • Net VAT to pay/refund
  • Comparison with previous period
  • Due date and report status

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

period?string

Tax period (e.g., "01-02/2025" or "01/2025")

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/vat/summary"
{  "summary": {    "period": "string",    "startDate": "string",    "endDate": "string",    "outputVAT": 0,    "inputVAT": 0,    "netVAT": 0,    "documentCount": 0,    "expenseCount": 0,    "currency": "string"  },  "previousPeriod": {    "period": "string",    "startDate": "string",    "endDate": "string",    "outputVAT": 0,    "inputVAT": 0,    "netVAT": 0,    "documentCount": 0,    "expenseCount": 0,    "currency": "string"  },  "change": {    "outputVAT": 0,    "inputVAT": 0,    "netVAT": 0  },  "dueDate": "string",  "status": "pending"}