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לא מספר ח.פ או ת.ז של הלקוח
emailתלוי כתובת המייל של הלקוח, חובה אם 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לאתשלום שווה(רלבנטי לתנועות באשראי בלבד). סכום תשלום ראשון בעסקת תשלומים או קרדיט.

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

אנחנו כאן בכל עניין ולכל שאלה. ביום עסקים רגיל, בין השעות 9:00 ל-18:00, אנחנו עונים תוך מספר דקות.