כל מה שקראתם כאן, המערכת עושה בשבילכם בקליק
45 יום לנסות את ביג בוס בחינם. בלי כרטיס אשראי, בלי התקנה: מייל וסיסמה וזהו.
הלקוח שילם, והתשלום נרשם במסמך
כשהמערכת שלכם יודעת שלקוח שילם, למשל במזומן לשליח או בצ'ק, היא יכולה ליצור בביג בוס מסמך שכולל את התשלום עצמו: סוג התשלום, הסכום ופרטי הצ'ק או הכרטיס. כך התשלום נרשם על הלקוח בלי שמישהו יקליד אותו שוב.
המדריך מסביר באילו מסמכים שולחים תקבולים, אילו ארבעה סוגי תקבול אפשר לרשום ומה הכללים לכל אחד. יצירת המסמך עצמו מוסברת ביצירת מסמך מכירה דרך ה-API: סוגים, שורות, מע״מ והנחה.
רישום תשלום אינו גבייה. ה-API לא מחייב כרטיס אשראי ולא מבצע סליקה. תקבול באשראי רושם במסמך תשלום שכבר בוצע.
באילו מסמכים שולחים תקבולים
את התקבולים שולחים ברשימה payments, בשני סוגי מסמכים בלבד:
- קבלה (400): תקבולים בלבד. אין בה שורות, ולכן לא שולחים
itemsוגם לא סוג מע״מ. רשימת שורות בקבלה נדחית עם "אין להעביר רשימת פריטים במסמך קבלה". - חשבונית מס קבלה (320): גם שורות וגם תקבולים. סכום התקבולים חייב להיות שווה לסכום המסמך, אחרת חוזרת ההודעה "סכום התקבולים וסכום החיוב חייבים להיות זהים".
בשני הסוגים האלה התקבולים חובה, ובלעדיהם חוזרת ההודעה "לא הועבר אופן התשלום במסמך". בכל סוג מסמך אחר אסור לשלוח תקבולים, והבקשה נדחית.
ארבעה סוגי תקבול
בכל תקבול שולחים את payment_type ואת הסכום ב-amount_nis, עד 2 ספרות אחרי הנקודה. לפי הסוג נדרשים שדות נוספים:
| payment_type | התקבול | שדות חובה נוספים |
|---|---|---|
| 1 | מזומן | אין. התאריך הוא היום |
| 2 | צ'ק | due_date · bank_code · branch_number · bank_account_number · cheque_number |
| 3 | כרטיס אשראי | due_date · credit_card_code · credit_card_number |
| 10 | ניכוי מס במקור | אין. התאריך הוא היום |
במזומן ובניכוי מס במקור התאריך נקבע לפי יום יצירת המסמך, גם אם נשלח תאריך אחר.
הכללים לצ'ק ולכרטיס אשראי
צ'ק
תאריך הפירעון ב-due_date לא יכול להיות לפני היום. bank_code הוא קוד של בנק שקיים במערכת, branch_number הוא מספר סניף בן 3 תווים בדיוק, ומספר הצ'ק ב-cheque_number הוא לפחות 4 תווים.
כרטיס אשראי
credit_card_code הוא קוד של סוג כרטיס שקיים במערכת, ו-credit_card_number הוא לפחות 4 תווים.
שלחו רק את 4 הספרות האחרונות של הכרטיס. המספר נשמר במסמך כמו שנשלח, ולכן מספר כרטיס מלא יישמר מלא. אותו דבר במספר הצ'ק: מספיקות 4 הספרות האחרונות.
את רשימות קודי הבנקים וסוגי הכרטיסים מקבלים מצוות ביג בוס.
דוגמה: קבלה על תשלום במזומן
זה מבנה הבקשה לקבלה ללקוח קיים, עם תקבול אחד במזומן:
{
"api_token": "xxxxxxxx",
"request_reference": "ORDER-1001-PAY",
"document_type": 400,
"company_id": 5608,
"payments": [
{ "payment_type": 1, "amount_nis": 50 }
]
}
התשובה זהה לתשובה של כל מסמך אחר: סוג המסמך, המספר שלו, מספר הלקוח, האם נשלח במייל וקישור לצפייה. כדי ששליחה חוזרת של אותו תשלום לא תיצור קבלה כפולה, שולחים request_reference קבוע לכל תשלום: שליחת המסמך במייל, קישור הצפייה ומניעת כפילויות.
מה אי אפשר לרשום
אין דרך ה-API סוג תקבול של העברה בנקאית, ביט או PayPal. אלה ארבעת הסוגים בלבד: מזומן, צ'ק, כרטיס אשראי וניכוי מס במקור. ואין דרך ה-API ביטול של קבלה שכבר נוצרה. את זה עושים בתוך ביג בוס.
כל שכבת המדריכים מרוכזת בעמוד ממשק API בביג בוס.