מסמכים וסוגי מסמך
חשבוניות, קבלות, הצעות מחיר, זיכויים — משאב אחד, שדה docType אחד.
מסמך הוא כל מסמך חשבונאי ש-VUZ יכול להנפיק — חשבונית, קבלה, הצעת מחיר, זיכוי.
משאב אחד, endpoint אחד; docType קובע את הסוג.
docType | בעברית | שימוש |
|---|---|---|
tax_invoice | חשבונית מס | חשבונית מס (ללא תשלום עדיין) |
tax_invoice_receipt | חשבונית מס/קבלה | הנפוץ ביותר — חשבונית + תשלום במסמך אחד |
receipt | קבלה | קבלה על תשלום |
quote | הצעת מחיר | הצעת מחיר לא מחייבת |
credit_note | חשבונית מס זיכוי | מבטל/מתקן חשבונית קודמת |
deal_bill | חשבון עסקה | לעוסקים פטורים — ללא מע"מ |
אילו סוגים מותר לכם להנפיק תלוי בסוג העסק שלכם (osek_patur / osek_murshe /
limited_company) — ראו מע"מ ותאימות ישראלית (באנגלית).
מחזור חיים: DRAFT ← ISSUED
POST /api/v1/documents יוצר מסמך במצב DRAFT — ניתן לעריכה, ללא מספר מסמך, ללא PDF.
הנפקה סופית היא קריאה נפרדת — עם הרשאה (scope) נפרדת:
POST /api/v1/documents/{id}/finalizeנדרשת הרשאת documents:finalize (בכוונה נפרדת מ-documents:write — אמצעי אימות שיוצר
טיוטות לא יכול להנפיק אותן בלי הרשאה מפורשת). ההנפקה מקצה מספר רץ, יוצרת PDF חתום,
ומבקשת מספר הקצאה מרשות המסים כשנדרש. מסמך שהונפק (ISSUED) הוא בלתי ניתן לשינוי;
ביטול נעשה בקריאה נפרדת — POST /documents/{id}/cancel (הרשאת documents:cancel) —
שיוצרת את המסמך הנגדי הנדרש על פי חוק.
חשבוניות זיכוי
אין endpoint נפרד לזיכוי — זיכוי הוא POST /documents עם docType: "credit_note" ו-
originalDocumentId (מזהה החשבונית המקורית, שחייבת להיות במצב ISSUED).
חישוב שורות מאומת בשרת
כל פריט דורש lineSubTotal, lineVatTotal, lineGrandTotal — אתם מחשבים אותם בצד
הלקוח, VUZ מחשב מחדש ודוחה בקשה שסוטה ביותר מ-0.01.