הודעת מסמך: מה נשלח בהפקה, בעריכה ובביטול

כל מה שקראתם כאן, המערכת עושה בשבילכם בקליק

45 יום לנסות את ביג בוס בחינם. בלי כרטיס אשראי, בלי התקנה: מייל וסיסמה וזהו.

מדריך למשתמש לשליחת אירועים למערכות חיצוניות (Webhook) בביג בוס

כל מסמך מכירה שמופק, עם הלקוח, השורות והסכומים

לוח נתונים שסופר מכירות, או מערכת CRM שמציגה לכל לקוח את המסמכים שלו, רוצים לדעת על כל מסמך שהופק בביג בוס. סוג האירוע "הפקת מסמך" שולח את המסמך כולו: פרטי הלקוח, השורות, הסכומים והתקבולים. מה שפחות ברור הוא מה קורה כשעורכים מסמך שכבר הופק, וכשמבטלים אותו, ואת זה המדריך מסביר.

מתי נשלחת ההודעה

ההודעה נשלחת כשמופק מסמך מכירה סופי, למשל הצעת מחיר או קבלה, בכל דרך שבה הוא מופק: במסך המסמכים, בקופה, דרך תוסף ממשק ה-API, בייבוא מסמכים מאקסל, ובדף תשלום או דף מכירה שבו לקוח קונה באתר. היא לא נשלחת על טיוטה, ולא על מסמכי רכש והוצאה.

מסמך אחד יכול לשלוח כמה הודעות מסוגים שונים, אם הוגדרו להם אירועים: "הפקת מסמך" על המסמך עצמו, "עדכון מלאי" לכל פריט ומחסן שהמסמך הזיז, ו"הוספת פריט" על פריט שנוסף לבד כשההגדרה "הוספת פריטים באופן אוטומטי" מסומנת. לקוח חדש שנפתח מתוך המסמך לא שולח "הוספת לקוח".

הסוג "הפקת מסמך" בבורר סוגי האירועים.

מה יש בהודעה

פרטי המסמך: document_id, המזהה הפנימי, document_type, קוד הסוג (למשל 3 הצעת מחיר, 305 חשבונית מס, 320 חשבונית מס קבלה, 400 קבלה), document_number, תאריך המסמך ותאריך הערך. אחריהם פרטי הלקוח כפי שהם במסמך, סוג המע״מ, ההנחה, המע״מ והסכום הכולל, ושני מערכים: items, שורות המסמך, ו-payments, שורות התקבול בקבלה ובחשבונית מס קבלה. כך נראית הודעה מקוצרת (הערכים לדוגמה):

{
  "document_id": 5001,
  "document_type": 3,
  "document_number": 1001,
  "document_date": "2026-10-06T15:19:20",
  "company_name": "לקוח לדוגמה",
  "email": "[email protected]",
  "amount_total": 59.0,
  "items": [
    {
      "line_number": 1,
      "catalog_number": "",
      "description": "שורת שירות לדוגמה",
      "quantity": 1.0,
      "price_unit": 50.0,
      "price_nis": 50.0
    }
  ],
  "payments": []
}

שני דברים שכדאי לדעת על השורות: price_nis הוא סכום השורה בשקלים אחרי הנחה, ולא מחיר היחידה, ובשורה חופשית בלי פריט השדה catalog_number ריק. מה שלא נמצא בהודעה: מספר הקצאה, סטטוס ביטול, יתרה פתוחה, סוכן, פרויקט וקישור לקובץ ה-PDF.

פרטי הלקוח בהודעה הם אלה שנרשמו במסמך, ו-company_id הוא מספר הכרטיס של הלקוח בביג בוס. לפיו משייכים את המסמך ללקוח הנכון במערכת שלכם, גם כשהלקוח עצמו לא נשלח בהודעה נפרדת.

בקבלה ובחשבונית מס קבלה, כל שורת תקבול כוללת את סוג התקבול כקוד (למשל 1 מזומן, 2 צ'ק, 3 אשראי, 4 העברה, 5 ביט), את הסכום בשקלים ואת תאריך הפירעון. בצ'ק נוספים פרטי הבנק והסניף ומספר הצ'ק, ובאשראי הספרות של הכרטיס כפי שנשמרו במסמך.

עריכה: אותה הודעה שוב, עם אותו מזהה

מסמך שעדיין פתוח לעריכה אחרי ההפקה, כמו הצעת מחיר, אפשר לערוך ולהפיק שוב. בכל הפקה כזו נשלחת שוב הודעת "הפקת מסמך", עם אותו document_id, אותו document_number והתוכן החדש. אין סוג אירוע נפרד לעדכון של מסמך, ולכן המערכת המקבלת צריכה לבדוק אם המזהה כבר קיים אצלה, ולעדכן את הרשומה הקיימת במקום ליצור חדשה. אותה בדיקה מגינה גם מפני הודעה שהגיעה פעמיים.

ביטול מסמך לא שולח הודעה. כשמבטלים הצעת מחיר, הסטטוס שלה משתנה ל"מבוטל" ולא יוצאת שום הודעה, וגם ביטול של מסמך מסוג אחר לא שולח הודעת מסמך. המערכת המקבלת לא תדע שהמסמך בוטל, ולכן את הביטולים מעדכנים בה בדרך אחרת.

בטלפון, ומהכיוון ההפוך

את האירועים אפשר לנהל גם בטלפון. ברשימה, הכתובת של כל אירוע מופיעה בשורה "כתובת קצה:" מתחת לסוג שלו.

ברשימה בטלפון: "הפקת מסמך" לצד אירועי הליד והלקוח. הכתובות מטושטשות.

כדי שמערכת אחרת תיצור מסמך בביג בוס, משתמשים בתוסף ממשק ה-API: יצירת מסמך מכירה דרך ה-API. מסמך שנוצר כך שולח גם הוא הודעת "הפקת מסמך", כשמוגדר לה אירוע.