Webhook מפרט טכני
כעת נתעמק בצד הטכני של מודול Webhook של ביג בוס – תוכנה לניהול עסק
בדף זה נתאר את מבנה ה-נתונים (Payload) אשר נשלח ע"י המערכת עבור כל אחד מסוגי האירועים.
להלן רשימת האירועים הנתמכים במערכת:
– הקמה \ עדכון \ מחיקה של לקוח
– הקמה \ עדכון \ מחיקה של פריט
ליד – פרטי הנתונים
להלן ה-Payload אשר יישלח עבור כל הפעילויות מול ליד:
| שדה | סוג הנתון | תיאור |
|---|---|---|
lead_id |
מספר (int) | מזהה ייחודי של הליד ממערכת הנתונים |
company_name |
מחרוזת | שם החברה |
contact_name |
מחרוזת | שם איש הקשר |
address |
מחרוזת | כתובת מלאה של איש הקשר |
city |
מחרוזת | העיר |
zip |
מחרוזת | מיקוד |
tel |
מחרוזת | טלפון קווי |
cel |
מחרוזת | טלפון נייד |
email |
מחרוזת | כתובת דוא"ל |
comments |
מחרוזת | הערות כלליות חופשיות |
דוגמא של נתונים:
{
"lead_id": "1234",
"company_name": "שם החברה",
"contact_name": "שם איש הקשר",
"address": "כתובת",
"city": "עיר",
"zip": "מיקוד",
"tel": "+972501234567",
"cel": "+972521234567",
"email": "[email protected]",
"comments": "הערות חופשיות"
}
לקוח \ ספק – פרטי הנתונים
להלן ה-Payload אשר יישלח עבור כל הפעילויות מול לקוח וספק:
| שדה | סוג | תיאור |
|---|---|---|
customer_id |
int | מזהה ייחודי של הלקוח |
company_hp |
string | מספר העסק/ח.פ. |
company_name |
string | שם החברה |
contact_name |
string | שם איש הקשר |
address |
string | כתובת מלאה |
city |
string | עיר |
zip |
string | מיקוד |
tel |
string | טלפון קווי |
cel |
string | טלפון נייד |
email |
string | כתובת דואר אלקטרוני |
comments |
string | הערות נוספות |
account_code |
string | קוד חשבון |
vat_exemption |
int | פטור ממע"מ (1 או 0) |
דוגמא של נתונים:
{
"customer_id": 5678,
"company_hp": "123456789",
"company_name": "שם החברה",
"contact_name": "שם איש הקשר",
"address": "כתובת",
"city": "עיר",
"zip": "מיקוד",
"tel": "+97236123456",
"cel": "+972521234567",
"email": "[email protected]",
"comments": "הערות חופשיות",
"account_code": "AC12345",
"vat_exemption": 1
}
פריט – פרטי הנתונים
להלן ה-Payload אשר יישלח עבור כל הפעילויות מול פריט:
| שדה | סוג | תיאור |
|---|---|---|
item_id |
int | מזהה ייחודי של הפריט |
item_name |
string | שם הפריט |
catalog_number |
string | מק"ט |
barcode |
string | ברקוד |
group_id |
int | מזהה קבוצה של פריטים |
group_name |
string | שם הקבוצה |
price_buy_nis |
decimal | מחיר עלות בש"ח (לפני מע"מ) |
price_sell |
decimal | מחיר מכירה |
price_sell_matvea_id |
int | מזהה קבוצת מחיר לפי מתווה |
price_sell_matvea_code |
string | קוד קבוצת מחיר |
price_sell_vat_included |
int | האם מע"מ כלול? (1/0) |
image_url |
string | URL לתמונה של הפריט |
extended_description |
string | תיאור מורחב |
managed_in_inventory |
int | האם מתוחזק במלאי? (1/0) |
inventory_min_qtty |
decimal | מינימום מלאי |
inventory_max_qtty |
decimal | מקסימום מלאי |
דוגמא של נתונים:
{
"item_id": 3456,
"item_name": "שם הפריט",
"catalog_number": "123-ABC",
"barcode": "7290001234567",
"group_id": 10,
"group_name": "קטגוריית פריטים",
"price_buy_nis": 12.34,
"price_sell": 23.45,
"price_sell_matvea_id": 2,
"price_sell_matvea_code": "B",
"price_sell_vat_included": 1,
"image_url": "https://…/image.jpg",
"extended_description": "תיאור מורחב של הפריט",
"managed_in_inventory": 1,
"inventory_min_qtty": 2.5,
"inventory_max_qtty": 100.0
}
מלאי- פרטי הנתונים
להלן ה-Payload אשר יישלח עבור פעילות מול המלאי:
| שדה | סוג | תיאור |
|---|---|---|
item_id |
int | מזהה ייחודי של הפריט |
catalog_number |
string | מק"ט לפריט |
item_name |
string | שם הפריט |
group_id |
int | מזהה קבוצה של הפריטים |
group_name |
string | שם הקבוצה |
warehouse_id |
int | מזהה ה‑warehouse |
warehouse_name |
string | שם המחסן |
quatity |
decimal | הכמות במלאי – יכולה להיות מספר עשרוני |
דוגמא של נתונים:
{
"item_id": 3456,
"catalog_number": "123-ABC",
"item_name": "שם הפריט",
"group_id": 10,
"group_name": "קטגוריית פריטים",
"warehouse_id": 2,
"warehouse_name": "מחסן מרכזי",
"quatity": 150.75
}
מסמך – פרטים בעת הפקת מסמך
להלן ה-Payload אשר יישלח בעת הפקת מסמך חדש:
| שדה | סוג | תיאור |
|---|---|---|
document_id |
int | מזהה מסמך ייחודי |
document_type |
int | סוג המסמך (למשל חשבונית, קבלה… לפי קוד פנימי) |
document_number |
int | מספר המסמך לפי הרשומה |
document_date |
timestamp | string |
due_date |
timestamp | string |
company_id |
int | מזהה החברה/לקוח |
company_hp |
string | מספר העסק/ח.פ |
company_name |
string | שם החברה |
contact_name |
string | שם איש הקשר |
address |
string | כתובת מלאה |
city |
string | עיר |
tel |
string | טלפון |
cel |
string | נייד |
email |
string | דוא"ל |
document_vat_type |
int | סוג המע"מ (לפי Id מערכת) |
discount_percentage |
decimal | אחוז הנחה לכל המסמך |
discount_amount |
decimal | סכום הנחה מוחלט |
maam_percentage |
decimal | אחוז המע"מ |
amount_maam |
decimal | סכום המע"מ |
amount_total |
decimal | סכום כולל לאחר הנחה־מע"מ (עלות סופית) |
items |
array | רשימת פרטי פריטים (DocInvWebHookData[]) |
payments |
array | רשימת תשלומים (DocRcpWebHookData[]) |
עבור שורות המסמך:
| שדה | סוג | תיאור |
|---|---|---|
line_number |
int | מספר שורה כסידורי |
catalog_number |
string | מק"ט פריט |
description |
string | תיאור שורה |
quantity |
decimal | כמות |
price_unit |
decimal | מחיר יחידה לפני הנחה |
discount_percentage |
decimal | אחוז הנחה לפי שורה |
amount_discount |
decimal | סכום ההנחה |
matvea_code |
string | קוד מתווה מחיר |
exchange_rate |
decimal | שער המרה (במקרה של מטבע) |
price_nis |
decimal | מחיר לאחר הנחה במטבע ש"ח |
עבור שורות התקבול במסמך:
| שדה | סוג | תיאור |
|---|---|---|
line_number |
int | מספר שורה בקרב התשלומים |
payment_type |
int | סוג תשלום (לפי קוד פנימי, למשל צ'ק / אשראי) |
amount_nis |
decimal | סכום התשלום בש"ח |
due_date |
timestamp | string |
bank_code |
int? | קוד בנק (אם צ'ק) |
branch_number |
string | סניף |
bank_account_number |
string | חשבון בנק |
cheque_number |
string | מספר צ'ק |
credit_card_id |
int? | מזהה כרטיס אשראי (אם מדובר בתשלום אשראי) |
credit_card_number |
string | מספר כרטיס (עם/בלי סוגריים) |
{
"document_id": 9876,
"document_type": 3,
"document_number": 4512,
"document_date": "2025‑07‑31T14:26:00Z",
"due_date": "2025‑08‑30T14:26:00Z",
"company_id": 5678,
"company_hp": "523456789",
"company_name": "שם החברה",
"contact_name": "שם איש הקשר",
"address": "רחוב X 1, חולון",
"city": "חולון",
"tel": "+97236111111",
"cel": "+972521234567",
"email": "[email protected]",
"document_vat_type": 2,
"discount_percentage": 5.0,
"discount_amount": 120.50,
"maam_percentage": 17.0,
"amount_maam": 273.85,
"amount_total": 1889.35,
"items": [
{
"line_number": 1,
"catalog_number": "123-ABC",
"description": "תיאור פריט",
"quantity": 2.0,
"price_unit": 250.00,
"discount_percentage": 5.0,
"amount_discount": 25.00,
"matvea_code": "A",
"exchange_rate": 1.0000,
"price_nis": 475.00
}
],
"payments": [
{
"line_number": 1,
"payment_type": 1,
"amount_nis": 1889.35,
"due_date": "2025‑08‑05T14:26:00Z",
"bank_code": 12,
"branch_number": "01",
"bank_account_number": "1234567",
"cheque_number": "3456789",
"credit_card_id": null,
"credit_card_number": null
}
]
}
מסך ניהול Webhook של ביג בוס – תוכנה לניהול עסק, מספקות כלים להגדרת תהליכי אוטומציה חכמים, החל מבחירת סוגי אירועים ועד לניהול אבטחת התקשורת והפניית הנתונים למערכות חיצוניות בזמן אמת.