VUZDevelopers

Get document distribution by type

GET
/analytics/documents/by-type

Retrieves distribution of documents by type.

Document Types:

  • Tax Invoice, Invoice, Quote, Receipt
  • Tax Invoice/Receipt, Credit Note
  • Deal Bill, Work Order, Delivery Note

Data Returned:

  • Count per type
  • Percentage distribution
  • Total value per type
  • Color coding for visualization

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/documents/by-type"
{  "currency": "string",  "startDate": "string",  "endDate": "string",  "types": [    {      "type": "string",      "label": "string",      "labelEn": "string",      "count": 0,      "percentage": 0,      "totalValue": 0,      "color": "string"    }  ],  "totalDocuments": 0}