VUZDevelopers

Get all document types

GET
/document-types

Returns all active document types with their UI metadata for the document type picker.

Response Structure

Each document type includes:

  • code: Document type code (matches DocumentType enum: tax_invoice, receipt, etc.)
  • nameHebrew/nameEnglish: Localized display names
  • descriptionHebrew/descriptionEnglish: Localized descriptions
  • icon: Flaticon UIcons class (e.g., "fi-rr-tax")
  • iconColor: Hex color for the icon (e.g., "#3B82F6")
  • allowedBusinessTypes: Which business types can issue this document
  • isPrimary: Whether to show in main picker grid (true) or "More" section (false)
  • displayOrder: Sort order for UI display

Business Type Filtering

When filterByBusiness=true, only returns document types that the current business can issue. For example:

  • Osek Patur: Receipt, Quote, Deal Bill, Order
  • Osek Murshe/Ltd: Tax Invoice, Tax Invoice Receipt, Receipt, Quote, Credit Note, Order

Document Types

CodeHebrewBusiness Types
tax_invoiceחשבונית מסOsek Murshe, Ltd
tax_invoice_receiptחשבונית מס / קבלהOsek Murshe, Ltd
receiptקבלהAll
quoteהצעת מחירAll
credit_noteחשבונית זיכויOsek Murshe, Ltd
deal_billחשבון עסקהOsek Patur only
orderהזמנהAll

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

filterByBusiness?boolean

When true, filters document types by what the current business can issue based on its business type (osek_patur, osek_murshe, limited_company)

Header Parameters

x-business-id*string

Business ID for multi-tenant access

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/document-types" \  -H "x-business-id: string"
{  "success": true,  "data": [    {      "id": "123e4567-e89b-12d3-a456-426614174000",      "code": "tax_invoice",      "nameHebrew": "חשבונית מס",      "nameEnglish": "Tax Invoice",      "descriptionHebrew": "מסמך מס רשמי לעסקאות",      "descriptionEnglish": "Official tax document for transactions",      "icon": "fi-rr-document",      "iconColor": "#3B82F6",      "allowedBusinessTypes": [        "osek_murshe",        "limited_company"      ],      "displayOrder": 1,      "isPrimary": true,      "primaryForBusinessTypes": [        "osek_murshe",        "limited_company"      ],      "isActive": true    }  ]}