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

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

נא לשים לב!

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

 

שם השדה סוג תאור ערכים אפשריים ברירת מחדל חובה
senzey_client_id int מס לקוח בסנזיי     כן(במידה ולא נשלח client_name או use_creditcard_onfile = TRUE)
client_name varchar שם הלקוח     כן(במידה ולא נשלח senzey_client_id)
client_email varchar אימייל הלקוח     כן(במידה ולא נשלח senzey_client_id)
client_idn varchar ת.ז של הלקוח     לא
client_business_idn varchar עוסק מורשה     לא
client_address varchar כתובת הלקוח     לא
client_phone varchar טלפון     לא
client_city varchar עיר הלקוח     לא
client_lang varchar שפת מסמכים

"en" or "he"

"he" לא
client_birthday date תאריך לידה dd/mm/yyyy   לא
client_fields string[] שדות נוספות     לא
currency varchar

אם שונה משקלים אז לשלוח ערך

USD
EUR
AUD
GBP
NULL לא
start_date date תאריך תשלום ראשון     כן
transfer_period varchar     תדירות

month

week

year

  כן
num_of_transfers int מספר תשלומים   NULL לא
transfer_amount float סכום תשלום תקופתי     כן
first_transfer_amount float סכום תשלום ראשון   אין לא נמסר - אז תשלום ראשון יהיה שווה ליתר תשלומים לא

issue_billing

varchar האם להפיק חיוב

"TRUE" or "FALSE"

"FALSE" לא
issue_deal_invoice varchar האם להפיק חשבונית עסקה .

"TRUE"

or

"FALSE"

"FALSE" לא

issue_tax_invoice_receipt

varchar האם להפיק חש' מס\קבלה "TRUE" or "FALSE" "FALSE" לא
invoice_type int סוג הכנסה   NULL לא
vat_type varchar עוסק מורשה או פטור

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

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

  לא 
doc_comments varchar הערות מסמך     לא
item array פרטי מוצר     לא

item[name]

varchar שם המוצר     לא

item[code]

varchar מק"ט     לא
item[discount] decimal הנחה ב%   0 לא

item[quantity]

decimal כמות   1 לא
item[desc] varchar תיאור     לא
transfer_type   סוג העברה

credit_card

bank

other

  כן (במידה ו- use_creditcard_onfile = FALSE)
transaction_company varchar הסולק שם הסולק yaad\zcredit לא
credit_card_payment varchar כל הנתונים שהתקבלו מחברת סליקה יכנסו לפרמטר זה      כן רק במקרה וערך בשדה transaction_company   הוא - "yaad" או "zcredit" ו-use_creditcard_onfile - False
use_creditcard_onfile varchar סליקה מתוך הכ"א השמור בפרטי הלקוח במערכת

"TRUE"

or

"FALSE"

"FALSE" לא
payment_details array       כן - אם לא נמסר   credit_card_payment     או use_creditcard_onfile
payment_details[credit_card_name] varchar שם כרטיס אשרי     לא
payment_details[last_4_digits] varchar 4 ספרות אחרונות     לא
payment_details[card_owner_name] varchar שם בעל הכרטיס     לא
payment_details[account_branch] number סניף בנק המשלם    

סוג העברה bank  - כן 

כל סוג העברה אחר - לא 

payment_details[account_num] number חשבון בנק המשלם    

סוג העברה bank - כן 

כל סוג העברה אחר - לא 

payment_details[bank_id] number מס בנק המשלם בסנסי    

סוג העברה bank וריק  bank_code - כן 

כל סוג העברה אחר - לא 

payment_details[bank_code] number קוד בנק המשלם    

סוג העברה bank וריק  bank_id-כן

כל סוג העברה אחר -לא

payment_details[bank_name]  varchar שם בנק המשלם   bank_code לא
payment_details[business_bank_id] number מס בנק של העסק (המקבל) בסנסי        

סוג העברה  bank ולא סופקו נתוני בנק העסק לזיהוי  - כן 

כל סוג העברה אחר - לא 

payment_details[to_account_branch] number סניף בנק המקבל    

סוג העברה   bank וריק  business_bank_id    - כן 

כל סוג העברה אחר - לא 

payment_details[to_account_num] number חשבון בנק המקבל    

סוג העברה bank וריק  business_bank_id    - כן 

כל סוג העברה אחר - לא 

payment_details[to_bank_id] number מס בנק המקבל בסנסי    

סוג העברה  bank  וריק  business_bank_id  וריק to_bank_code  - כן 

כל סוג העברה אחר - לא 

payment_details[to_bank_code] number קוד בנק המקבל    

סוג העברה bank  וריק  business_bank_id  וריק to_bank_id  - כן 

כל סוג העברה אחר - לא 

payment_details[to_bank_name]
 
varchar שם בנק המקבל   to_bank_code לא

connect_to_project[project_id]

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

connect_to_project[description]

text       לא

connect_to_project[reminder_before_days]

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

connect_to_project[payment_notes]

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

connect_to_project[comments]

text הערות     לא

 

 

 

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

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

קוד HTTP : 200

מספר הו"ק -  bank_order_num

מסמך (אם הופק) - doc_num

ID של לקוח - client_id

לדוגמה:

{ 'bank_order_num': 10005, 'doc_num' : 69521, 'client_id': 96521 }

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

קוד HTTP : 400-599

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

לדוגמה:

{'error': 'Incorrect business number'}

 

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