הפקת מסמכים ב-API

מדריך API – הפקת מסמכים

 

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

בקשה להפקת מסמך – AddDocument

יש לפנות לכתובת:

https://app.invoice-maven.co.il/api/documents/addDocument

יש להעביר את הפרמטרים הבאים בפורמט JSON:

שדות כלליים:

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

0-     הפקת מסמכים אמיתיים

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

contact_emailכןאימייל של המפתח תוכנה ליצירת קשר במקרה של בעיה.
contact_phoneכןטלפון של המפתח תוכנה ליצירת קשר במקרה של בעיה.
doc_idלאמספר מזהה יחודי לבקשה. במידה ויתקבלו 2 פניות עם אותו מזהה, בפניה השניה לא יופק מסמך.
doc_typeכןסוג המסמך:

305 – חשבונית מס

400 – קבלה

405 – קבלה על תרומה

320 – חשבונית מס / קבלה

330 – חשבונית זיכוי

10 – הצעת מחיר

100 – הזמנת עבודה

200 – תעודת משלוח

210 – תעודת החזרה

300 – חשבונית עסקה

500 – הזמנת רכש

descriptionלאתיאור המסמך
document_dateלאתאריך של המסמך. אין צורך להעביר שדה הזה מכיוון שהמסמך נוצר עם התאריך של היום הנוכחי באופן אוטומטי. יש לדאוג שתאריכי המסמכים מאותו סוג הם בסדר כרונולוגי.
due_dateלאתאריך לתשלום עד בפורמט dd/MM/yyyy
vat_included0לאיש להעביר 1 אם מחירי הפריטים במסמך כוללים מע"מ.
discountלאהנחה באחוזים או בסכום. אחוז או סכום יקבע בשדה: discount_type
discount_type1לאסוג ההנחה:

1-     לפי אחוזים

2-     לפי סכום

round_total0לאיש להעביר 1 כדי לעגל את הסכום.
withholding_taxלאסכום קיזוז מס במקור
send_to_customer1לא0-     המסמך לא ישלח ללקוח

1-     המסמך ישלח ללקוח במייל.

no_vat0לא1-     הפקת מסמך ללא מע"מ.
english_document0לא1-     הפקת מסמך באנגלית
currency1לאמטבע המסמך:

1-     שקל

2-     דולר

3-     אירו

4-     ליש"ט

5-     דולר אוסטרלי

6-     פרנק שיווצרי

7-     דולר קנדי

8-     כתר נורבגי

9-     כתר דני

10-   כתר שוודי

11-   ראנד דרא"פ

customerכןשדה שמכיל את פרטי הלקוח – ראה מבנה שדות לקוח בהמשך.
itemsלאשדה המכיל רשימה של הפריטים במסמך. אין להעביר במידה וסוג המסמך הינו קבלה.

ראה מבנה שדות פריטים בהמשך.

paymentsלאשדה המכיל רשימה של התשלומים במסמך. יש להעביר אך ורק במסמכים מסוג 'קבלה', 'חשבונית מס / קבלה' ו'קבלה על תרומה'.

ראה מבנה שדות תשלומים בהמשך.

remarksלאהערות בתחתית המסמך

שדות לקוח (customer):

שדהברירת מחדלחובהתיאור
nameכןשם הלקוח
addressלאכתובת
cityלאעיר
zip_codeלאמיקוד
identificationלאת.ז או ח.פ שיופיעו על גבי המסמך
emailלאכתובת אימייל
phone_numberלאטלפון
cell_phoneלאנייד
faxלאפקס
save_customer0לאיש להעביר 1 כדי לשמור את הכרטיס לקוח במערכת.

שדות פריטים (items):

שדהברירת מחדלחובהתיאור
descriptionכןתיאור הפריט
item_numberלאמספר פריט או מספר קטלוגי – במידה
priceכןמחיר הפריט
quantity1לאכמות. המחיר הסופי של השורת פירוט יהיה: מחיר * כמות
currency1לאראה קודים של מטבעות בטבלת שדות כלליים
currency_rateשער נוכחילאשער מטבע במידה ונבחר מטבע השונה משקל. אין צורך לספק שער מטבע- המערכת תשתמש בשער הנוכחי לפי בנק ישראל.
no_vat0לאיש להעביר 1 במידה והפריט הוא ללא מע"מ.

שדות תשלומים (payments):

שדהברירת מחדלחובהתיאור
payment_dateכןתאריך שבו בוצע התשלום או תאריך פרעון של המחאה. בפורמט dd/MM/yyyy
payment_typeכןסוג תשלום:

1-     העברה בנקאית

2-     מזומן

3-     המחאה

4-     כרטיס אשראי

5-     פייפאל

9-     אחר

amountכןסכום התשלום
bank_accountלאמספר חשבון (חובה בתשלום המחאה)
bank_branchלאסניף (חובה בתשלום המחאה)
bankלאבנק (חובה בתשלום המחאה)
cheque_numberלאמספר המחאה (חובה בתשלום המחאה)
credit_card_typeלאסוג כרטיס אשראי:

1-     אמריקן אקספרס

2-     דיינרס

3-     ויזה

4-     ישראכרט

5-     לאומי קארד

6-     מאסטרקארד

credit_card_4_digitsלא4 ספרות אחרונות של הכרטיס אשראי
credit_transaction_typeלאסוג התשלום בכרטיס אשראי: (חובה בתשלום מסוג כרטיס אשראי)

1-     רגיל

2-     תשלומים

3-     קרדיט

4-     חיוב נדחה

5-     אחר

number_of_paymentsלאמספר תשלומים בכרטיס אשראי (חובה במידה וסוג התשלום בכרטיס אשראי הוא תשלומים)
first_payment_amountלאסכום תשלום ראשון בכרטיס אשראי
payments_one_row0לאיש להעביר 1 במידה ואין צורך בהצגת פירוט התשלומים בכרטיס אשראי על גבי המסמך
paypal_account_numberלאמספר חשבון פייפאל
paypal_transaction_numberלאמספר טרנזאקציה בפייפאל

מבנה תשובה המתקבלת מהשרת:

 

שדהתיאור
status_codeקוד סטטוס שגיאות. במידה והכל תקין יוחזר 0.
status_descriptionתיאור השגיאה. במידה והכל תקין יוחזר 'OK'.
doc_noמספר המסמך שנוצר.
pdf_originalקישור למסמך המקור.
pdf_copyקישור למסמך העתק.

 

עדיין זקוקים לעזרה?

שלחו פנייה לתמיכה
אזור תוכן, לקיצור דרך לחצ/י כפתור ALT + zאזור פוטר, לקיצור דרך לחצ/י כפתור ALT + x