VUZDevelopers

Get allowed conversion targets for a document

GET
/documents/{id}/allowed-conversions

Returns the list of document types that this document can be converted to, based on:

  • Current document type
  • Business VAT status (Osek Patur or not)
  • Document status
  • Israeli accounting rules

Use Cases:

  • Display conversion options in UI dropdown
  • Validate user selections
  • Show conversion descriptions/tooltips

Example Response:

{  "documentId": "...",  "currentType": "quote",  "allowedTargets": ["invoice", "deal_bill", "tax_invoice"],  "descriptions": {    "invoice": "Convert quote to invoice",    "deal_bill": "Convert quote to deal bill (pro-forma invoice)",    "tax_invoice": "Convert quote to tax invoice"  }}

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

Path Parameters

id*string

Document ID

Response Body

application/json

application/json

curl -X GET "https://example.com/documents/660e8400-e29b-41d4-a716-446655440000/allowed-conversions"
{  "documentId": "660e8400-e29b-41d4-a716-446655440000",  "currentType": "quote",  "allowedTargets": [    "tax_invoice",    "deal_bill"  ],  "descriptions": {    "invoice": "Convert quote to invoice",    "deal_bill": "Convert quote to deal bill (pro-forma invoice)"  }}