VUZDevelopers

Get document default for specific type

GET
/businesses/document-defaults/{docType}

Returns default notes for a specific document type.

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

docType*string

Document type

Value in

  • "order"
  • "delivery_note"
  • "agent_delivery_note"
  • "return_note"
  • "tax_invoice"
  • "consolidated_invoice"
  • "tax_invoice_receipt"
  • "credit_note"
  • "reservation_invoice"
  • "agent_invoice"
  • "receipt"
  • "donation_receipt"
  • "cash_withdrawal"
  • "bank_deposit"
  • "purchase_order"
  • "purchase_delivery_note"
  • "purchase_return"
  • "purchase_tax_invoice"
  • "purchase_credit_note"
  • "opening_balance"
  • "inventory_in"
  • "inventory_out"
  • "warehouse_transfer"
  • "inventory_adjustment"
  • "production_in"
  • "production_out"
  • "quote"
  • "deal_bill"
  • "work_order"

Response Body

application/json

curl -X GET "https://example.com/businesses/document-defaults/order"
{  "notes": "שלום {{clientName}},\nתודה על ההזמנה!\nסה\"כ לתשלום: {{total}}",  "internalNotes": "לקוח VIP - לתת עדיפות"}