לדלג לתוכן הראשי

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

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

נכתב על ידי Eliron Giny

חוץ מבנקים וכרטיסי אשראי, אפשר לחבר ל-Financy מערכות עסקיות: מערכת חשבוניות, מערכת ERP וחברת סליקה. כל מה שהן מביאות זמין גם דרך ה-API, עם אותם מפתחות ואותו טוקן שאתם כבר משתמשים בהם לנתוני הבנק.

מה אפשר למשוך

  • מערכות חשבוניות (Invoice4U, מורנינג, SUMIT, iCount): מסמכים, לקוחות ומי עוד חייב לכם. אפשר גם להכין טיוטות של מסמכים, שמונפקות רק אחרי שהמשתמש מאשר אותן ב-Financy. מתוכנית Starter.

  • ERP (פריוריטי): מסמכים, לקוחות ומי חייב לכם, וגם ספקים, חשבוניות ספק, למי אתם חייבים, ספרי חשבונות, הזמנות ומלאי. קריאה בלבד. מתוכנית Pro.

  • נתוני סליקה (ישראכרט עסקים): הזיכויים מחברת הסליקה, העתידיים וגם אלה שכבר נכנסו לבנק. קריאה בלבד. מתוכנית Pro.

בכל תוכנית אפשר לחבר מספר חשבונות לכל מערכת: אחד ב-Starter, עד 5 ב-Pro ועד 20 ב-Ultra.

לפני שמתחילים

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

  • משתמשים במפתחות API של הארגון, מהגדרות ← גישה ל-API ב-Financy. אין צורך לבקש הרשאות נוספות. ראו מתחילים עם ה-API.

  • יוצרים טוקן עם userId. מערכות עסקיות שייכות למשתמש, ולכן כל קריאה אליהן צריכה טוקן שנוצר עם userId.

איך מושכים נתונים

  1. כתובת הבסיס היא https://api.open-finance.ai/integrations.

  2. קוראים ל-GET /integrations/ כדי לקבל את המערכות המחוברות של המשתמש. לכל אחת יש id שמתחיל ב-intg_.

  3. קוראים לנתיב של סוג הנתונים, עם ה-id הזה. למשל, נתוני סליקה: GET /integrations/{integrationId}/settlements.

  • מערכות חשבוניות ו-ERP: /documents, /customers, /receivables

  • ERP בלבד: /payables, /suppliers, /bills, /ledger, /orders, /inventory

  • נתוני סליקה: /settlements. אפשר לסנן לפי status (expected לזיכוי עתידי, settled לזיכוי שכבר שולם) ולפי תאריך התשלום (paymentFrom, paymentTo)

כל רשימה מחזירה עד 200 פריטים בעמוד. כדי לקבל את העמוד הבא, שולחים את nextCursor בפרמטר cursor. השדה freshness.dataAsOf אומר מתי הנתונים התעדכנו לאחרונה מהמערכת. הסכומים הם מספרים שלמים באגורות: 125000 הם ₪1,250.

כמה כללים לנתוני סליקה

  • אל תחברו זיכויים עתידיים (expected) וזיכויים ששולמו (settled) לסכום אחד. אלה נקודות זמן שונות.

  • זיכוי ששולם כבר נמצא בחשבון הבנק, ולכן הוא כבר חלק מהיתרה ומהתנועות שלו. אל תספרו אותו פעמיים.

  • הסכום נטו (netMinor) הוא מה שנכנס לבנק: ברוטו פחות העמלות והניכויים.

  • הזיכויים לא ממוינים לפי תאריך. מיינו אותם בעצמכם.

איפה הדוקומנטציה המלאה

המדריך המלא, עם דוגמאות, נמצא ב-Business Systems API בדוקומנטציה למפתחים. כל שדה, פרמטר ושגיאה של כל נתיב מופיעים ב-API Reference שם.

שאלות נפוצות

קיבלתי שגיאה UPGRADE_REQUIRED. מה זה אומר?

התוכנית של הארגון לא כוללת את המערכת הזו. מערכות חשבוניות זמינות מ-Starter, ופריוריטי וישראכרט עסקים מ-Pro.

קיבלתי רשימה ריקה. למה?

אם freshness.dataAsOf ריק, הסנכרון הראשון עדיין רץ, או שלמערכת הזו אין את סוג הנתונים הזה. למשל, בישראכרט עסקים אין מסמכים, ובמערכות חשבוניות אין נתוני סליקה.

אפשר לחבר מערכת חדשה ישירות דרך ה-API?

לא. ה-API יוצר קישור חיבור (POST /integrations/link-sessions), והמשתמש מזין את פרטי הכניסה בעצמו בעמוד המאובטח של Financy.

האם קיבלת תשובה לשאלתך?