VUZDevelopers

Documents

Documents — 30 endpoints.

Create and issue a document in one call

POST /documents/issue

Get all documents with filtering and pagination

GET /documents

Create a new document

POST /documents

List clients with creditable tax invoices

GET /documents/creditable-clients

List clients that have documents

GET /documents/document-clients

Open customer credit balance (יתרת זכות ללקוח) — money received that is not yet applied to an invoice

GET /documents/customer-credit

Get a document by ID

GET /documents/id

Update a document

PATCH /documents/id

Soft delete a document

DELETE /documents/id

Get payment summary for a document

GET /documents/id/payment-summary

Close a document with a reason-driven accounting treatment

POST /documents/id/close

Reverse a previously closed document (בטל סגירה)

POST /documents/id/close/reverse

[DEPRECATED] Reopen a closed document (restore outstanding balance)

PATCH /documents/id/reopen

Add allocation number to an issued document

PATCH /documents/id/allocation

Duplicate a document

POST /documents/id/duplicate

Convert document to another type

POST /documents/id/convert

Create receipt for invoice (with auto-inherited line items)

POST /documents/id/receipts

Get linked documents (parent and children)

GET /documents/id/linked

Get allowed conversion targets for a document

GET /documents/id/allowed-conversions

Create a public share link for a document

POST /documents/id/share

Send document via email with branded template

POST /documents/id/share/email

Send document via SMS

POST /documents/id/share/sms

Send document via WhatsApp

POST /documents/id/share/whatsapp

Get share history for a document

GET /documents/id/share/logs

Get receipts available to link to this document

GET /documents/id/available-receipts

Link receipts to this document

POST /documents/id/link-receipts

Unlink a receipt from this document

DELETE /documents/id/unlink-receipt/receiptId

Count documents matching the export scope/filters (+ their total)

POST /documents/export/count

Export documents (ZIP / Excel / CSV) for download

POST /documents/export

Email the client a secure download link for the export

POST /documents/export/send-email