ממשק ה-API שלנו לאתר שלך!
- צוות ביג בוס
ביג בוס אונליין – BigBoss Web – Api
גרסה: Beta 1.0.2
כללי
תוכנה ביג בוס לניהול העסק מספקת שרות Backend לכלל התוכנות בשוק.
באמצעות ממשק ה-Api שלה, ביג בוס מאפשרת לכלל התוכנות בשוק, לאחר מתן הרשאות מתאימות, לנהל לקוחות, לנהל מלאי, ליצור מסמכים וכן לקבל דיווחים ונתונים בזמן אמת
לשאלות והערות עבור ממשק ה-Api ניתן לפנות למייל [email protected]
תוכן עניינים
כללי
תוכנה ביג בוס לניהול העסק מספקת שרות Backend לכלל התוכנות בשוק.
באמצעות ממשק ה-Api שלה, ביג בוס מאפשרת לכלל התוכנות בשוק, לאחר מתן הרשאות מתאימות, לנהל לקוחות, לנהל מלאי, ליצור מסמכים וכן לקבל דיווחים ונתונים בזמן אמת
לשאלות והערות עבור ממשק ה-Api ניתן לפנות למייל [email protected]
הפעלת מודול API
לאחר הפעלת המודול יקצה המשתמש מזהה התקשרות api_index למערכת אשר החיצונית.
במידה ומאפשרים למספר מערכות לתקשר עם הביג בוס, מומלץ לספק לכל מערכת מזהה התקשרות api_index שונה.
יתרון במתן מזהה התקשרות api_index שונה לכל מערכת מתקשרת:
- ניתן לסנן פעילות של מערכת מסויימת מתוך הפעילות של כלל המערכות המקושרות
- בסיום עבודה מול מערכת מסויימת ניתן לחסום אליה את הגישה בקלות
יצירת מזהה התקשרות api_index
אזור זה יתעדכן בקרוב
הסבר על מבנה ותוכן התשובה
מבנה תשובה
| שם השדה | תאור | סוג שדה | הערות |
| result_ code | קוד תשובה | int | תוצאת הכנת המסמך: – 200 – התשובה תקינה – 201 – המסמך – 204 – – 400 – הבקשה – 401 – – 404 – הבקשה – 503 – השרות לא זמין |
| result_ message | תאור תשובה | string | הודעה אשר מתלווה לקוד result_ code במקרה והבקשה נכשלה , לדוגמא קוד 400, שדה זה יכיל את תאור השגיאה |
| result_ data | שדה זה יכיל את תשובת המתודה | string | – בשדה זה יופיע ערך רק אם הפניה הצליחה, אחרת השדה יהיה ריק – מבנה התשובה משתנה ע"פ המתודה. – התיעוד מכיל את מבנה התשובה עבור כל מתודה בנפרד |
רשימת שגיאות כלליות
| קוד תשובה | תאור התשובה | סיבות אפשריות |
| 401 | קוד הזדהות לא הועבר | מזהה api_token לא הועבר |
| 401 | קוד הזדהות לא תקין | מזהה api_token אשר הועבר אינו תקין |
| 401 | נתוני הזדהות שגויים | מזהה api_token אשר הועבר אינו מוגדר |
| 401 | קוד הזדהות אינו פעיל | מזהה api_token אשר הועבר הוגדר כלא פעיל |
| 401 | החברה אינה זמינה | לא נמצאה חברה משוייכת לבקשה זו (*) |
| 401 | המשתמש אינו זמין | לא נמצא המשתמש המשוייך לבקשה זו (*) |
| 401 | המשתמש אינו פעיל | המשתמש המשוייך לבקשה זו מוגדר כלא פעיל |
| 400 | לא הועברו נתונים | לא התקבלו נתונים בגוף הבקשה – עבור פניות מסוג POST |
| 400 | מבנה נתונים לא תקין | מבנה הנתונים שהועברו לא תואמים את מבנה הנתונים שהמתודה ציפתה לקבל – במקרה זה יתווסף להודעה הסיבה המדוייקת |
לקוחות
הוספת לקוח
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/customer_new
- שדות להעברה – ראה שדות רשומה עבור לקוח בהמשך
- תשובת המתודה (שדה result_data במבנה התשובה)
| שם השדה | תאור | סוג שדה |
| customer_id | מס' לקוח אשר נוצר במערכת | int |
עדכון לקוח
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/customer_update
- שדות להעברה – ראה שדות רשומה עבור לקוח בהמשך
- תשובת המתודה (שדה result_data במבנה התשובה)
| שם השדה | תאור | סוג שדה |
| customer_id | מס' לקוח אשר עודכן | int |
קבלת יתרת לקוח
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/customer_balance
- שדות להעברה
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| customer_id | מס' לקוח | int | שדה חובה |
- תשובת המתודה
| שם השדה | תאור | סוג שדה |
| balance | יתרה מעודכנת עבור הלקוח | decimal |
קבלת פרטי לקוח
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/customer_get
- שדות להעברה:
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| customer_id | מס' לקוח | int | שדה חובה |
- תשובת המתודה: – ראה שדות רשומה עבור לקוח בהמשך
קבלת רשימת לקוחות
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/customer_list
- שדות להעברה
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
- תשובת המתודה: – רשימה של לקוחות (שדות רשומה עבור לקוח)
תאור שדות עבור רשומת לקוח
(ראה עמודת הערות לגבי שדות חובה בעת הקמה של לקוח וכן בעת עדכון של לקוח)
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה שדה זה לא מועבר בחזרה במתודה customer_get שדה זה לא מועבר בחזרה במתודה customer_list |
| customer_id | מס' לקוח | int | שדה חובה בעת עדכון בלבד אין להעביר בעת הוספה |
| company_hp | מס' ח.פ. במקרה של תאגיד מס' עוסק מורשה במקרה של עוסק יחיד מס' תעודת זהות במקרה של אדם פרטי | string | · שדה זה יכיל מס' ח.פ. או מס' עוסק מורשה או תעודת זהות |
| company_name | שם העסק \ שם החברה שם פרטי ושם משפחה במקרה של לקוח פרטי | string | שדה חובה בעת הוספה בלבד אורך מקסימלי 200 תוים |
| contact_name | איש קשר במקרה של חברה | string | אורך מקסימלי 200 תוים |
| address | כתובת | string | אורך מקסימלי 255 תוים |
| city | עיר | string | אורך מקסימלי 50 תוים |
| zip | מיקוד | string | אורך מקסימלי 50 תוים |
| tel | מס' טלפון | string | אורך מקסימלי 50 תוים |
| cel | מס' נייד | string | אורך מקסימלי 50 תוים |
| דוא"ל | string | אורך מקסימלי 100 תוים בדיקת תקינות כתובת דוא"ל | |
| account_code | קוד הכרטיס בהנה"ח | string | אורך מקסימלי 50 תוים |
| vat_exemption | האם הכרטיס פטור ממע"מ | int | ערכים אפשריים: – 0 – לא פטור ממע"מ (ברירת מחדל בעת הוספה) – 1 – כן פטור ממע"מ |
| comments | הערות | string | אורך מקסימלי 4,000 תוים |
| request_reference | מזהה פניה | string | מזהה פנייה חיצוני למניעת כפילויות אורך מקסימלי 255 תוים |
דוגמא לקוד להוספת לקוח
{
"api_token": "myTest",
"request_reference": "111223",
"company_hp": "123456789",
"company_name": "חברה לנסיון בבלבד",
"contact_name": "פיטר",
"address": "הרצל 152",
"city": "אשדוד",
"tel": "08-8661332",
"cel": "050-4915874",
"email": "[email protected]",
"account_code": "800224"
}
פריטים
להלן הנושאים המשוייכים פריטים:
הוספת פריט
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/item_new
- שדות להעברה – ראה שדות רשומה עבור פריט בהמשך
- תשובת המתודה (שדה result_data במבנה התשובה)
| שם השדה | תאור | סוג שדה |
| item_id | מס' פריט אשר נוצר במערכת | int |
עדכון פריט
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/item_update
- שדות להעברה – ראה שדות רשומה עבור פריט בהמשך
- תשובת המתודה (שדה result_data במבנה התשובה)
| שם השדה | תאור | סוג שדה |
| item_id | מס' פריט אשר עודכן | int |
קבלת פרטי פריט
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/item_get
- שדות להעברה:
יש חובה להעביר בבקשה את אחד מהשדות המסומנות ב- (*)
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| (*) item_id | מס' פריט | int | להעביר בעת שאילתא ע"פ מס' פריט אין לעביר catalog_number אם מועבר שדה זה |
| (*) catalog_number | מק"ט | string | להעביר בעת שאילתא ע"פ מק"ט אין לעביר item_id אם מועבר שדה זה |
- תשובת המתודה: – ראה שדות רשומה עבור פריט בהמשך
קבלת רשימת פריטים
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/item_list
- שדות להעברה
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| managed_in_inventory | האם מנוהל במלאי | int | ערכים אפשריים: – (-1) – כל הפריטים (ברירת מחדל) – 0 – לא מנוהל במלאי – 1 – כן מנוהל במלאי |
| group_id | קוד קבוצה | int | ערכים אפשריים: – 0 – כל הקבוצות (ברירת מחדל) – אחרת מס' הקבוצה המבוקשת |
- תשובת המתודה: – רשימה של פריטים (שדות רשומה עבור פריט)
תאור שדות עבור רשומת פריט
(ראה הערות לגבי שדות חובה בעת הקמה של פריט וכן בעת עדכון של פריט)
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה שדה זה לא מועבר בחזרה במתודה item_get שדה זה לא מועבר בחזרה במתודה item_list |
| item_id | מס' פריט | int | שדה חובה בעת עדכון בלבד אין להעביר בעת הוספה |
| item_name | שם הפריט | string | שדה חובה בעת הוספה בלבד אורך מקסימלי 200 תוים |
| catalog_number | מק"ט | string | אורך מקסימלי 100 תוים |
| barcode | ברקוד | string | אורך מקסימלי 4,000 תוים |
| group_id | מס' קבוצה | int | · במידה ולא הועבר ערך בעת הוספה, יעודכן מס' הקבוצה אשר הוגדרה כברירת מחדל במערכת · במידה ומועבר ערך המערכת תבדוק שאכן קיימת קבוצה עם קןדה זה בסטטוס פעיל אחרת תחזיר הודעת שגיאה |
| group_name | שם הקבוצה | string | שדה זה יהיה זמין בעת קבלת נתוני הפריט בעת הוספה \ עדכון המערכת תתעלם מהערך בשדה זה |
| price_buy_nis | מחיר עלות בש"ח | decimal | ברירת מחדל בעת הוספה: 0 לא ניתן הזין מספרים שליליים דיוק של עד 2 ספרות אחרי הנקודה |
| price_sell_nis | מחיר מכירה בש"ח | decimal | ברירת מחדל בעת הוספה: 0 לא ניתן הזין מספרים שליליים דיוק של עד 2 ספרות אחרי הנקודה |
| price_sell_vat_included | האם מחיר מכירה כולל מע"מ | int | ערכים אפשריים: – 0 – לא כולל מע"מ (ברירת מחדל בעת הוספה) – 1 – המחיר כולל מע"מ |
| image_url | קישור באינטרנט אשר מכיל את התמונה | string | אורך מקסימלי 500 תוים |
| extended_description | תאור נרחב של הפריט | string | אורך מקסימלי 4,000 תוים |
| managed_in_inventory | האם הפריט מנוהל במלאי | int | ערכים אפשריים: – 0 – לא מנוהל במלאי (ברירת מחדל) – 1 – כן מנוהל במלאי |
| inventory_min_qtty | מלאי מינימום | decimal | ברירת מחדל: 0 (ללא בקרה על מלאי מינימום) לא ניתן הזין מספרים שליליים דיוק של עד 2 ספרות אחרי הנקודה |
| inventory_max_qtty | מלאי מקסימום | decimal | ברירת מחדל: 0 (ללא בקרה על מלאי מקסימום) לא ניתן הזין מספרים שליליים דיוק של עד 2 ספרות אחרי הנקודה במידה ושדה inventory_min_qtty מועבר אזי הערך לא יכול להיות קטן מהערך המועבר בשדה inventory_min_qtty |
| request_reference | מזהה פניה | string | אורך מקסימלי 255 תוים |
דוגמא לקוד להוספת פריט
{
"api_token": "myTest",
"request_reference": "111223",
"item_name": "table",
"catalog_number": "abcdef",
"barcode": "barcode_1",
"price_buy_nis": 25,
"price_sell_nis": 117,
"price_sell_vat_included": 1,
"image_url": "https://www.freeimages.com/photo/prague-conference-center-1056491",
"extended_description": "remarks for item",
"managed_in_inventory": 1,
"inventory_min_qtty": 5,
"inventory_max_qtty": 100
}
קבוצת פריטים
להלן הנושאים המשוייכים לקבות פריטים:
- הוספת קבוצה
- עדכון קבוצה
- קבלת פרטי קבוצה
- קבלת רשימת קבוצות
- תאור שדות עבור רשומת קבוצה
- דוגמא לקוד להוספת קבוצה
הוספת קבוצה
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/itemgroup_new
- שדות להעברה – ראה שדות רשומה עבור קבוצה בהמשך
- תשובת המתודה (שדה result_data במבנה התשובה)
| שם השדה | תאור | סוג שדה |
| group_id | מס' קבוצה אשר נוצרה במערכת | int |
עדכון קבוצה
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/itemgroup_update
- שדות להעברה – ראה שדות רשומה עבור קבוצה בהמשך
- תשובת המתודה (שדה result_data במבנה התשובה)
| שם השדה | תאור | סוג שדה |
| group_id | מס' פריט אשר עודכן | int |
קבלת פרטי קבוצה
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/itemgroup_get
- שדות להעברה:
יש חובה להעביר בבקשה את אחד מהשדות המסומנות ב- (*)
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| (*) group_id | מס' קבוצה | int | להעביר בעת שאילתא ע"פ מס' קבוצה אין לעביר catalog_number אם מועבר שדה זה |
- תשובת המתודה: – ראה שדות רשומה עבור קבוצה בהמשך
קבלת רשימת קבוצות
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/itemgroup_list
- שדות להעברה
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
- תשובת המתודה: – רשימה של קבוצות (שדות רשומה עבור קבוצה)
תאור שדות רשומה עבור קבוצה
(ראה הערות לגבי שדות חובה בעת הקמה של פריט וכן בעת עדכון של פריט)
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה שדה זה לא מועבר בחזרה במתודה itemgroup_get שדה זה לא מועבר בחזרה במתודה itemgroup_list |
| group_id | מס' פריט | int | שדה חובה בעת עדכון בלבד אין להעביר בעת הוספה |
| group_name | שם הפריט | string | שדה חובה אורך מקסימלי 200 תוים |
דוגמא לקוד להוספת קבוצה
{
"api_token": "myTest",
"group_name": "my group",
}
מלאי
להלן הנושאים המשוייכים למלאי:
קבלת כמות במלאי עבור פריט
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/inventory_get
- שדות להעברה:
יש חובה להעביר בבקשה את אחד מהשדות המסומנות ב- (*)
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| (*) item_id | מס' פריט | int | להעביר בעת שאילתא ע"פ מס' פריט אין לעביר catalog_number אם מועבר שדה זה |
| (*) catalog_number | מק"ט | string | להעביר בעת שאילתא ע"פ מק"ט אין לעביר item_id אם מועבר שדה זה |
- תשובת המתודה
| שם השדה | תאור | סוג שדה |
| quatity | כמות במלאי | decimal |
קבלת כמות במלאי עבור רשימת של פריטים
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/inventory_list
- שדות להעברה
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| group_id | קוד קבוצה | int | ערכים אפשריים: – 0 – כל הקבוצות (ברירת מחדל) – אחרת מס' הקבוצה המבוקשת |
- תשובת המתודה
| שם השדה | תאור | סוג שדה |
| item_id | מס' פריט | int |
| catalog_number | מק"ט | string |
| item_name | שם הפריט | string |
| group_id | מס' קבוצה | string |
| quatity | כמות במלאי | decimal |
מסמכים
להלן הנושאים המשוייכים למסמכים:
- יצירת מסמך
- תאור שדות עבור מסמך
- תאור שדות עבור רשומת חיוב
- תאור שדות עבור רשומת תקבול
- דוגמא לקוד להפקת חשבונית מס קבלה
יצירת מסמך
- סוג בקשה: Post
- אופן העברת נתונים וקבלת התשובה: JSON
- כתובת המתודה: https://bigboss.co.il/bigbossweb/api.asmx/document_new
- שדות להעברה – ראה תאור שדות עבור רשומת מסמך
- מבנה התשובה המתקבל בעת הפקת המסמך
תאור שדות עבור רשומת מסמך
| שם השדה | תאור | סוג שדה | הערות |
| api_token | קוד ה-API שמייצג את פרטי ההתחברות | string | שדה חובה |
| request_reference | מזהה פניה במערכת היוזמת את הבקשה | string | מזהה פנייה חיצוני למניעת כפילויות אורך מקסימלי 255 תוים |
| document_type | סוג מסמך | Int | שדה חובה יכול להכיל את הערכים הבאים: · 3 – הצעת מחיר · 100 – הזמנה · 200 – תעודת משלוח · 300 – חשבונית עסקה · 305 – חשבונית מס · 320 – חשבונית מס קבלה · 330 – חשבונית זיכוי · 400 – קבלה |
| document_vat_type | סוג מע"מ במסמך | int | שדה חובה (חוץ מאשר במסמך קבלה) יכול להכיל את הערכים הבאים: · 1 – המחירים בשורות המסמך לא כוללים מע"מ · 2 – המחירים בשורות המסמך כן כוללים מע"מ · 3 – המסמך ללא מע"מ |
| company_id | מס' קוח | int | שדה חובה במידה ולא מועבר שדה company_name במידה ומועבר: · חייב להיות ערך אשר כבר קיים, אחרת תדווח שגיאה |
| company_hp | מס' ח.פ. במקרה של תאגיד מס' עוסק מורשה במקרה של עוסק מורשה מס' תעודת זהות במקרה של אדם פרטי | string | · שדה זה יכיל מס' ח.פ. או מס' עוסק מורשה או תעודת זהות · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר |
| company_name | שם העסק \ שם החברה שם פרטי ושם משפחה במקרה של לקוח פרטי | string | שדה חובה במידה ו- לא מועבר company_id · במידה ומועבר company_id המערכת תתעלם משדה זה |
| contact_name | איש קשר במקרה של חברה | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר |
| address | כתובת | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר |
| city | עיר | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר |
| zip | מיקוד | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר · שדה זה לא נתמך עבור לקוח מזדמן והמערכת תתעלם ממנו אם: o לא מועבר שדה company_id o create_customer = 0 |
| tel | מס' טלפון | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר |
| cel | מס' נייד | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר |
| דוא"ל | string | · במידה ומועבר company_id הערך הקיים בכרטיס יעודכן עם הערך המועבר | |
| create_customer | האם להקים לקוח | int | ערכים אפשריים: – 0 – לא להקים (ברירת מחדל) – 1 – כן להקים חשוב: לא יוקם לקוח חדש ותתקבל הודעת שגיאה במקרים הבאים: · הועבר ערך בשדה company_id · כבר קיים לקוח עם אותו שם חברה , אותו מס' ח.פ. (או מס' ח.פ. ריק) ואותה עיר (או ללא עיר) |
| due_date | תאריך פרעון | string | במבנה YYYY-MM-DD חשוב: · תאריך פרעון חייב להיות שווה או גדול מתאריך הפקת המסמך |
| discount_percentage | אחוז הנחה | decimal | · ניתן להעביר אך ורק במידה ולא הועבר discount_amount · יועברו 1 ספאה אחרי הנקודה |
| discount_amount | סכום הנחה | decimal | · ניתן להעביר אך ורק במידה ולא הועבר discount_percentage · יועברו 2 ספרות אחרי הנקודה |
| circle_pennies | עיגול אגורות | int | ערכים אפשריים: – 0 – לא לעגל – 1 – כן לעגל (ברירת מחדל) חשוב: בעת הפקת חשבונית מס קבלה יש לדאוג שסיכום הסכומים בשורות התשלום יהיו זהים לסכום המופע של המסמך |
| content | תאור תכולת המסמך | string | |
| comments | הערות למסמך | string | חשוב: במסמך מסוג קבלה יש לעדכן את כל המלל בשדה content |
| send_mail | האם לשלוח את המסמך בדוא"ל | Int | ערכים אפשריים: – 0 – לא לשלוח – 1 – כן לשלוח (ברירת מחדל) |
| email_to | כתובת דוא"ל למשלוח המסמך | string | חשוב: גם אם נבחר כרטיס לקוח אשר יש בו כבר דוא"ל, יש לעדכן את הדוא"ל לשליחה בשדה זה |
| email_bcc | כתובת דוא"ל למשלוח נסתר | string | |
| items[] | מערך פרטים במבנה המפורט בהמשך | שדה חובה (חוץ מאשר במסמך קבלה) | |
| payments[] | מערך תקבולים במבנה המפורט בהמשך | שדה חובה (במסמכים מסוג קבלה וחשבונית מס קבלה בלבד) |
תאור שדות עבור רשומת חיוב items[]
| שם השדה | תאור | סוג שדה | הערות |
| catalog_number | מספר קטלוגי | string | אורך מקסימלי 100 תוים |
| description | תאור הפריט \ שרות | string | שדה חובה אורך מקסימלי 4,000 תוים |
| quantity | כמות | decimal | שדה חובה יועברו 2 ספרות אחרי הנקודה |
| price_unit_nis | מחיר נטו ליחידה | decimal | שדה חובה יועברו 2 ספרות אחרי הנקודה |
תאור שדות עבור רשומת תקבול payments[]
| שם השדה | תאור | סוג שדה | הערות | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payment_type | סוג תשלום | int | שדה חובה יכול להכיל את הערכים הבאים: · 1 – מזומן · 2 – שיק · 3 – כרטיס אשראי · 10 – ניכוי מס במקור | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount_nis | סכום בשקלים | decimal | שדה חובה יועברו 2 ספרות אחרי הנקודה | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| due_date | תאריך פרעון | string | שדה חובה – בתשלום מסוג שיק וכרטיס אשראי במבנה YYYY-MM-DD חשוב: – תאריך פרעון חייב להיות שווה או גדול מתאריך הפקת המסמך – בתקבול מזומן ובניכוי מס במקור יעודכן תאריך המסמך תוך התעלמות מהמועבר בשדה זה | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bank_code | קוד בנק | int | שדה חובה בתשלום מסוג שיק להן רשימת הקודים הנתמכים:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| branch_number | מס' סניף | string | שדה חובה בתשלום מסוג שיק יש להעביר 3 ספרות בלבד | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bank_account_number | מס' חשבון | string | שדה חובה בתשלום מסוג שיק | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cheque_number | מס' שיק | string | שדה חובה בתשלום מסוג שיק יש להעביר 4 ספרות אחרונות בלבד | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| credit_card_code | קוד כרטיס אשראי | int | שדה חובה בתשלום מסוג כרטיס אשראי להן רשימת הקודים הנתמכים:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| credit_card_number | מס' כרטיס | string | שדה חובה בתשלום מסוג כרטיס אשראי יש להעביר 4 ספרות אחרונות בלבד |
מבנה התשובה המתקבל בעת הפקת המסמך
| שם השדה | תאור | סוג שדה | הערות |
| document_type | סוג מסמך | int | |
| document_number | מספר מסמך | int | מספר המסמך שנוצר |
| customer_id | מס' לקוח במסמך | int | במקרה של הפקה ללקוח מזדמן יחזור הערך 1- |
| sent_status | סטטוס שליחת המסמך | int | ערכים אפשריים: – 0 – המסמך לא נשלח – 1 – המסמך נשלח בהצלחה |
| document_link | קישור לקובץ pdf של המסמך | string |
דוגמא לקוד להפקת חשבונית מס קבלה
{
"api_token": "myTest",
"request_reference": "111222",
"document_type": 320,
"document_vat_type": 1,
"create_customer": 0,
"company_id": 4237,
"address": "הרצל 134",
"city": "אשדוד",
"discount_percentage": 2.5,
"content": "תאור לתכולה",
"comments": "הערות שונות",
"send_mail": 1,
"email_to": "[email protected]",
"items": [
{
"catalog_number": "1122",
"description": "שולחן עבודה",
"quantity": 2.0,
"price_unit_nis": 100.0,
}
],
"payments": [
{
"payment_type": 2,
"amount_nis": 526.5,
"due_date": "2023-09-05",
"bank_code": 10,
"branch_number": "789",
"bank_account_number": "998877",
"cheque_number": "4321",
}
]
}
