יש לבצע פניה לכתובת הבאה:

https://[account name].senzey.com/extapi/work_order/add.php?username=[username]&password=[password]

נא לשים לב!

  • הנתונים צריכים להישלח ב UTF8
  • כל הנתונים צריכים להישלח ב POST 
  • יש להשתמש ב content type: application/x-www-form-urlencoded

 

שם השדה סוג תאור ערכים אפשריים ברירת מחדל חובה
client_name varchar שם הלקוח     כן
client_email varchar אימייל הלקוח     כן
client_idn varchar ת.ז של הלקוח     לא
client_business_idn varchar עוסק מורשה     לא
client_address varchar כתובת הלקוח     לא
client_phone varchar טלפון     לא
client_city varchar עיר הלקוח     לא
client_lang char 2 שפת מסמכים en|he he לא
client_birthday date תאריך לידה dd/mm/yyyy   לא

client_fields[]

varchar[]

 שדות נוספות של לקוח

לדוגמא:
client_fields[zip_code]

   לא
total_payment decimal הסכום הסופי לתשלום בפועל     כן
currency varchar אם שונה משקלים אז לשלוח ערך USD
EUR
AUD
GBP		 NULL לא
vat_type varchar עוסק מורשה או פטור

חייב במע"מ = "DEFAULT"

פטור ממע"מ = "FREE"

   כן 
doc_comments varchar הערות מסמך     לא
[]items array שורות המוצרים אשר נירכשו     כן

items[][name]

 varchar שם המוצר     כן

items[][code]

 varchar מק"ט     לא

items[][price]

 decimal מחיר המוצר לחיוב בפועל ליחידה     כן

items[][quantity]

 decimal כמות     כן
send_invoice varchar האם לשלוח הזמנת עבודה ללקוח TRUE/FALSE FALSE לא
pay_url varchar במידה ורוצים להשתמש ב API זה לצורך דף תשלום, יש לשלוח "TRUE" ואז בסיום הדף יחזיר את אותו הפרמטר עם כתובת URL על מנת שתוכלו להפנות את הלקוח לדף התשלום. TRUE/FALSE FALSE לא
pay_success_callback_url varchar

במידה והפרמטר pay_url נשלח עם TRUE, והוכנס ערך בפרמטר זה עם כתובת חזרה לקבלת מידע על ביצוע התשלום, אז בסיום ביצוע התשלום ע"י הלקוח, המערכת תפנה לכתובת URL זו ב POST עם הפרמטרים הבאים:
"doc_type" => שם המסמך,
"doc_id" => מספר המסמך,
"sum" => סכום המסמך,
"work_order_number" => מספר הזמנה עבורה הופק המסמך (מספר זה נשלח בפניה הראשונה ל API וישמש לצורך שיוך/התאמה בין ההזמנה המקורית שנוצרה לבין התשלום.

     לא
pay_success_redirect_url varchar כתובת "דף תודה" לאחר תשלום מוצלח     לא
pay_success_send_invoice varchar האם לשלום מסמך שנוצר לאחר תשלום TRUE/FALSE FALSE לא

connect_to_project[project_id]

 number מזהה הפרויקט     לא

connect_to_project[description]

 text       לא

connect_to_project[amount]

 float סכום לחיוב כולל מע"מ     כן אם הוכנס ערך בשדה project_id

connect_to_project[start_date]

 date תאריך התחלה   CURDATE לא

connect_to_project[finish_date]

 date תאריך סיום     לא

connect_to_project[reminder_before_days]

 number תזכורת לפני סיום בימים     לא

connect_to_project[billing_type]

 number סוג חיוב*
  • 0 - לפי הגדרת משימה
  • 2 - מחיר קבוע
  • 5 - לא לחיוב
 מחיר קבוע כן אם הוכנס ערך בשדה project_id

connect_to_project[billing_recurring]

 

 number מחזוריות**
  • 0 - חד פעמי
  • 1 - חודשי
  • 2 - שנתי
  • 3 - דו-שנתי
  • 4 - שבועי
 חד פעמי לא

connect_to_project[recurring_from]

 date תאריך חיוב ראשון   ת.צירוף של לקוח לפרויקט לא

connect_to_project[num_of_payment]

 number מס' חיובים     לא

connect_to_project[payment_notes]

 text הערות תשלום     לא

connect_to_project[comments]

 text הערות     לא

connect_to_project[issue_billing_cycles]

 

 number מס' מחזורים להפיק חיוב, 1 לחיוב חד פעמי     לא
test varchar בדיקה - ידפיס למסך את הפרמטרים שנשלחו ללא המשך test   לא

 

 

 

התשובה שתיתקבל היא בפורמט JSON.

במיקרה של הצלחה:

קוד HTTP : 200

work_order_number - מספר הזמנה. לדוגמה: {'work_order_number': 10005}

pay_url - רק במידה והפניה ל API הכילה TRUE בפרמטר זה, תוחזר כתובת להפניית הלקוח לתשלום.

 

במיקרה של כישלון:

קוד HTTP : 400-599

הודעת שגיאה - error

לדוגמה:

{'error': 'Incorrect business number'}

 

במידה והתקבלו פרמטרים של הוראת קבע, הגדרות החיוב של הלקוח בפרויקט יקבעו על פי פרמטרים אלו.