Invoice Receipt API
יש לבצע פניה ב POST לכתובת הבאה:
https://[account name].senzey.com/extapi/tax_invoice_receipt/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[] | שדות נוספות | לא | |||
discount | decimal | הנחה ב% | 0 | לא | ||
total_payment | decimal | הסכום הסופי לתשלום בפועל (אחרי הנחה) | כן | |||
currency | varchar |
אם שונה משקלים אז לשלוח ערך |
USD EUR AUD GBP |
NULL | לא | |
invoice_type | int | סוג הכנסה | NULL | לא | ||
vat_type | varchar | עוסק מורשה או פטור |
חייב במע"מ = "DEFAULT" פטור ממע"מ = "FREE" |
כן | ||
doc_comments | varchar | הערות מסמך | לא | |||
[][]items | array | שורות המוצרים אשר נירכשו | כן | |||
items[][name] |
varchar | שם המוצר | כן | |||
items[][code] |
varchar | מק"ט | לא | |||
items[][price] |
decimal | מחיר המוצר כולל מעמ לפני הנחה ליחידה | כן | |||
items[][discount] | decimal | הנחה ב% | 0 | לא | ||
items[][quantity] |
decimal | כמות | כן | |||
items[][desc] | varchar | תיאור | לא | |||
use_club_member_points | integer | השתמש בנק' של חבר מועדון | לא | |||
is_stock_record | varchar | האם להוריד את המוצר מהמלאי |
"TRUE" or "FALSE" |
"FALSE" | לא | |
send_invoice | varchar | האם לשלוח חשבונית ללקוח |
"TRUE" or "FALSE" |
"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 | כל אמצעי תשלום בשורה נפרדת | כן | |||
payment_details[][payment_method] | number | סוג תשלום*** |
|
כן (במידה ו- use_creditcard_onfile = FALSE) | ||
payment_details[][total_amount] | float | סכום כולל מע"מ | כן (במידה ו- use_creditcard_onfile = FALSE) | |||
payment_details[][credit_card_name] | varchar | שם כרטיס אשרי | לא | |||
payment_details[][last_4_digits] | varchar | 4 ספרות אחרונות | לא | |||
payment_details[][card_owner_name] | varchar | שם בעל הכרטיס | לא | |||
payment_details[][value_date] | date | תאריך ערך | CURDATE | לא | ||
payment_details[][צ'ק_number] | number | מס צ'ק |
צורת תשלום צ'ק וריק bank_code - כן כל צורת תשלום אחר - לא |
|||
payment_details[][account_branch] | number | סניף בנק המשלם |
צורת תשלום העברה בנקאית ,הו"ק או צ'ק - כן כל צורת תשלום אחר - לא |
|||
payment_details[][account_num] | number | חשבון בנק המשלם |
צורת תשלום העברה בנקאית ,הו"ק או צ'ק - כן כל צורת תשלום אחר - לא |
|||
payment_details[][bank_id] | number | מס בנק המשלם בסנסי |
צורת תשלום העברה בנקאית ,הו"ק או צ'ק וריק bank_code - כן כל צורת תשלום אחר - לא |
|||
payment_details[][bank_code] | number | קוד בנק המשלם |
צורת תשלום העברה בנקאית ,הו"ק או צ'ק וריק bank_id-כן כל צורת תשלום אחר -לא |
|||
payment_details[][bank_name] | varchar | שם בנק המשלם | bank_code | לא | ||
payment_details[][business_bank_id] | number | מס בנק של העסק (המקבל) בסנסי |
צורת תשלום העברה בנקאית ,הו"ק ולא סופקו נתוני בנק העסק לזיהוי - כן כל צורת תשלום אחר - לא |
|||
payment_details[][to_account_branch] | number | סניף בנק המקבל |
צורת תשלום העברה בנקאית ,הו"ק וריק business_bank_id - כן כל צורת תשלום אחר - לא |
|||
payment_details[][to_account_num] | number | חשבון בנק המקבל |
צורת תשלום העברה בנקאית ,הו"ק וריק business_bank_id - כן כל צורת תשלום אחר - לא |
|||
payment_details[][to_bank_id] | number | מס בנק המקבל בסנסי |
צורת תשלום העברה בנקאית ,הו"ק וריק business_bank_id וריק to_bank_code - כן כל צורת תשלום אחר - לא |
|||
payment_details[][to_bank_code] | number | קוד בנק המקבל |
צורת תשלום העברה בנקאית ,הו"ק וריק 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[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 | סוג חיוב* |
|
מחיר קבוע | כן במידה והוכנס ערך בשדה project_id | |
connect_to_project[billing_recurring]
|
number | מחזוריות** |
|
חד פעמי | לא | |
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 לחיוב חד פעמי | לא | |||
bank order[issue_billing] |
varchar | האם להפיק חיוב |
"TRUE" or "FALSE" |
"FALSE" | לא | |
bank order[issue_tax_invoice_receipt] |
varchar | האם להפיק חש' מס\קבלה |
"TRUE" or "FALSE" |
"FALSE" | לא | |
bank order[start_date] |
date | תאריך התחלה | כן במידה והוכנס ערך באחד השדות של bank order | |||
bank_order[num_of_payment] |
number | מספר תשלומים | לא | |||
issue_work_order | varchar | האם להפיק הזמנת עבודה. מבטל ערך של "האם ליצור תנועת מלאי" |
"TRUE" or "FALSE" |
"FALSE" | לא | |
send_work_order | varchar | האם לשלוח הזמנת עבודה ללקוח. |
"TRUE" or "FALSE" |
"FALSE" | לא | |
test | varchar | בדיקה - ידפיס למסך את הפרמטרים שנשלחו ללא המשך | test | לא |
התשובה שתיתקבל היא בפורמט JSON.
במיקרה של הצלחה:
קוד HTTP : 200
מספר החשבונית \קבלה - tax_invoice_receipt_number
לדוגמה: {'tax_invoice_receipt_number': 10005}
במיקרה של כישלון:
קוד HTTP : 400-599
הודעת שגיאה - error
לדוגמה:
{'error': 'Incorrect business number'}
במידה והתקבלו פרמטרים של הו"ק, הגדרות חיוב של הלקוח בפרויקט יקבעו לפי פרמטרים אלו.
דוגמא לקוד: example