יצירה או עריכת לקוח ב-API

  • ניתן לפנות ל- API של Invoice Maven באמצעות בקשת JSON.
  • יש לפנות באמצעות POST .
  • החיבור צריך להתבצע באמצעות SSL (פורט 443).
  • לכל פניה יתווסף מפתח API שהוא בעצם מזהה חד ערכי לחשבון הלקוח במערכת.
  • לאחר הפניה ליצירת לקוח השרת יחזיר תשובה בפורמט JSON המציינת האם הפעולה הצליחה ואם לא את קוד ותיאור השגיאה.
  • את שמות השדות המועברים יש לכתוב ב- lowercase בלבד.
  • הקידוד של הפניה צריך להיות UTF-8.

בקשה להקמה או עריכה של לקוח – AddOrUpdateCustomer
יש לפנות לכתובת:
https://app.invoice-maven.co.il/api/customers/addOrUpdateCustomer
יש להעביר את הפרמטרים הבאים בפורמט JSON:
שדות כלליים:

שדה ברירת מחדל חובה תיאור
api_key כן מפתח ייחודי המשוייך לעסק במערכת ויש להעביר אותו עם כל בקשה.
test כן האם להקים לקוחות לבדיקה בלבד (יש להעביר 1 כדי לבצע בדיקות לפני הפקת מסמכים אמיתיים):

0 – יצירת לקוח אמיתי
1 – הקמת לקוחות לבדיקה. במצב זה יוקם לקוח ללא שמירה במערכת.

contact_email כן אימייל של מפתח התוכנה ליצירת קשר במקרה של בעיה.
contact_phone כן טלפון של מפתח התוכנה ליצירת קשר במקרה של בעיה.
customer_id לא מספר מזהה יחודי לבקשה. במידה ויתקבלו 2 פניות עם אותו מזהה, בפניה השניה לא יוקם לקוח.
id לא GUID של הלקוח, כפי שהוחזר ביצירה. אם נמצא לקוח לפי id, לפי identification או לפי email (בסדר הזה), הוא יעודכן. אחרת ייווצר לקוח חדש.
name כן שם הלקוח
address לא כתובת
city לא עיר
zip_code לא מיקוד
identification לא ת.ז או ח.פ שיופיעו על גבי המסמך
email לא כתובת אימייל
cell_phone לא נייד
fax לא פקס
phone_number לא טלפון
country_code לא קוד מדינה בתקן ISO, למשל IL לישראל או US לארה"ב. קוד שאינו מוכר מחזיר שגיאה.
emails לא מערך של כתובות מייל נוספות, למשל ["a@example.com", "b@example.com"]. הכתובות נשמרות בנוסף ל-email. אם לא נשלח email, הכתובת הראשונה במערך תשמש כמייל הראשי. בכל עדכון רשימת המיילים נכתבת מחדש מתוך email ו-emails, ולכן יש לשלוח בכל עדכון את כל הכתובות הנוספות שרוצים לשמור.
bank_name לא קוד הבנק (מספר, לא שם), עד 2 ספרות בלבד. לדוגמה 12 = הפועלים, 10 = לאומי. שליחת ערך ריק מוחקת את הערך הקיים.
bank_branch לא מספר הסניף, עד 3 ספרות בלבד. שליחת ערך ריק מוחקת את הערך הקיים.
bank_account_no לא מספר החשבון, עד 9 ספרות בלבד. שליחת ערך ריק מוחקת את הערך הקיים.
occasional_yn 0 לא לקוח מזדמן: 1 = מזדמן, 0 = קבוע. זהה לתיבת הסימון "לקוח מזדמן" בכרטיס הלקוח. בעדכון, אם לא נשלח, הערך הקיים נשמר.
מפתח של שדה מותאם לא ערך לשדה מותאם של הלקוח. שם השדה ב-JSON הוא מפתח השדה, כפי שמופיע בהגדרת השדות המותאמים. בשדה מסוג רשימת בחירה יש לשלוח את הטקסט של אחת האפשרויות, וערך שאינו ברשימה לא יישמר.

אם הפעולה הצליחה, התשובה כוללת את השדה id: מזהה ה-GUID של הלקוח, שבו משתמשים כדי לעדכן אותו בהמשך.

יש צורך בעזרה?

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

טופס פניה לתמיכה