API להפקת חשבוניות וקבלות - תיעוד מלא (חלק 2)
תיעוד מלא של API להפקת מסמכים
המדריך הבא מציג הנחיות לממשק ה- API הישן. לממשק ה- API החדש שלנו, לחצו כאן.
אובייקט JSON מלא של חשבונית מס קבלה לדוגמא:
{ "timestamp": 1380095506, //זמן נוכחי בשניות "callback_url": "{your_callback_url}" //POST, "doc_type": 320 //סוג מסמך, "description": "תיאור מסמך", "remarks": "הערות כלליות", //שדה הערות שמופיע בתחתית המסמך "currency": "ILS", //מטבע "lang": "he", //שפה "demo": false, //האם להפיק את המסמך בפועל "due_date": "2012-12-17", //תאריך לתשלום עד "client": { "id": "00c861ae-0000-11e2-9943-0800273f0fdb", //קוד לקוח אם לקוח כבר קיים "add": true, //אם true הלקוח יתווסף לרשימת הלקוחות בחשבון "send_email": true, //האם לשלוח ללקוח את המסמך למייל "name": "לקוח חדש", "tax_id": "123456789", //מספר ח.פ. או ת.ז. של לקוח "email": "user@email.com", "address": "כתובת", "city": "תל אביב", "zip": "1234567", "country": "IL" //קוד מדינה }, "income": [ { "catalog_num": "1234", //מספר קטלוגי "price": 1000.00, "quantity": 2, //כמות "description": "תיאור שורה", "vat": 1 }], "payment": [ { "type": 2, //תשלום בשיק "date": "2012-01-01", //YYYY-MM-DD "amount": 1000.00, "bank": "מזרחי טפחות", "branch": "761", "account": "123456", "number": "10928" }, { "type": 3, //תשלום בכרטיס אשראי "date": "2012-01-01", //YYYY-MM-DD "amount": 1000.00, //סכום "number": "8971", //4 ספרות אחרונות של כרטיס אשראי "deal_type": 2, //סוג עסקת אשראי "card_type": 2, //סוג כרטיס אשראי "payments": 5, "first_payment": 200 //תשלום ראשון בכרטיס אשראי }] }
שדות כלליים
שם שדה | חובה | ברירת מחדל | הערות |
---|---|---|---|
timestamp | כן | זמן נוכחי בשניות מאז 01/01/1970 | |
callback_url | לא | כתובת דף לקבלת עדכון לאחר סיום הפקת מסמך | |
doc_type | כן | סוג מסמך | |
description | לא | תיאור כללי של המסמך | |
remarks | לא | הערות שמופיעות בתחתית המסמך | |
currency | לא | ILS | מטבע |
lang | לא | he | שפת המסמך, עברית (he) או אנגלית (en) |
demo | לא | false | מצב עבודה פעיל או ניסוי (לא יופקו מסמכים בפועל אם מוגדר כאן true) |
round | לא | false | האם לעגל את המסמך? (לא פעיל במסמכים עם תקבולים כגון קבלה, קבלה על תרומה וחשבונית מס / קבלה) |
attachment | לא | true | האם לצרף את החשבונית כ Attachment למייל |
external_data | לא | שדה לנתונים חוזרים. ערך שתזינו כאן יוחזר לכם לאחר סיום עיבוד הבקשה באופן אסינכרוני. | |
due_date | לא | תאריך לתשלום עד, במבנה YYYY-MM-DD | |
client | כן | אובייקט נתונים של לקוח, פירוט למטה | |
income | תלוי | מערך של שורות הכנסה, לא חובה בקבלות, פירוט למטה | |
payment | תלוי | מערך של שורות תשלומים, לא חובה במסמכים ללא תקבולים, פירוט למטה | |
ref_document_id | לא | מזהה ייחודי של מסמך אליו מסמך זה מקושר (למשל חשבונית מס על קבלה) | |
footer_text | לא | טקסטים המופיעים בתחתית המסמך | |
reply_to_email | לא | אימייל עסק | לכתובת זו ישלחו מיילים, כאשר משתמש מגיב למייל האוטומטי הנשלח אליו |
שדה לקוח (client)
שם שדה | חובה | ברירת מחדל | הערות |
---|---|---|---|
id | לא | מספר מזהה של הלקוח בחשבונית ירוקה, אם ממלאים שדה זה באופן תקין אין חובה למלא את שדות החובה של הלקוח | |
add | לא | false | האם להוסיף את הלקוח לחשבון המשתמש במערכת (אם קיים כבר לקוח בשם זהה לא יווצר לקוח חדש) |
self | לא | false | האם להפיק חשבונית עצמית (תקף רק לחשבונית מס) |
send_email | לא | false | האם לשלוח ללקוח את החשבונית במייל |
override | לא | false | במידה ושולחים מספר מזהה של לקוח, ניתן לסמן שדה זה כ true ולשכתב חלק משדות הלקוח באופן ספציפי למסמך זה |
name | כן | שם הלקוח | |
tax_id | לא | מספר ח.פ או ת.ז של הלקוח | |
תלוי | כתובת המייל של הלקוח, חובה אם send_email=true, אפשרי לשלוח מערך של מספר מיילים (עד 3) | ||
phone | לא | טלפון | |
address | כן | כתובת הלקוח | |
city | לא | עיר | |
zip | לא | מיקוד | |
country | לא | מדינה, לפי קודי מדינות | |
accounting_key | לא | מפתח לקוח חיצוני (הנהלת חשבונות) |
שדה הכנסות (income)
שם שדה | חובה | ברירת מחדל | הערות |
---|---|---|---|
catalog_num | לא | מספר קטלוגי, אם לא נשלח לא יופיע במסמך | |
price | כן | מחיר ליחידה, בפורמט של מספר עשרוני עם 2 ספרות אחרי הנקודה (רצוי לשלוח כ String) | |
quantity | לא | 1 | כמות יחידות |
description | כן | תיאור שורת ההכנסה, שם הפריט וכד'. | |
vat | לא | 1 | האם הסכום כולל מע"מ, פטור ממע"מ או יש להוסיף מע"מ. קודי תנועות מע"מ |
שדה תשלומים (payment)
שם שדה | חובה | ברירת מחדל | הערות |
---|---|---|---|
type | כן | סוג אמצעי תשלום. קודי תנועות אמצעי תשלום. | |
date | לא | היום | תאריך תשלום (YYYY-MM-DD) |
amount | כן | סכום, בפורמט של מספר עשרוני עם 2 ספרות אחרי הנקודה (רצוי לשלוח כ String) | |
bank | תלוי | מספר או שם בנק. חובה אם שיק. | |
branch | תלוי | סניף בנק. חובה אם שיק. | |
account | תלוי | מספר חשבון בנק. חובה אם שיק. | |
number | תלוי | מספר שיק אם התשלום הוא שיק. 4 ספרות אחרונות של מספר כרטיס אשראי אם התשלום הוא אשראי. מספר טרנזקציה בפייפאל. | |
deal_type | תלוי | סוג עסקת אשראי (רלבנטי לתנועות באשראי בלבד). קודי סוגי עסקאות אשראי. | |
card_type | לא | סוג כרטיס אשראי (רלבנטי לתנועות באשראי בלבד). קודי סוגי כרטיסי אשראי. | |
payments | לא | 1 | (רלבנטי לתנועות באשראי בלבד). מספר תשלומים. |
first_payment | לא | תשלום שווה | (רלבנטי לתנועות באשראי בלבד). סכום תשלום ראשון בעסקת תשלומים או קרדיט. |