הפניה לAPI צריכה להיות מוצפנת (כלומר יש לפנות ל https) ולמרות שאנחנו תומכים גם ב GET ההמלצה היא להשתמש ב POST.
את הפניה יש להפנת ל https://api.icount.co.il/api/create_doc.php אלא אם נשלחה הנחיה לבצע פניה לכתובת אחרת.

שם השדה סוג תיאור ערכים אפשריים ברירת מחדל חובה
כללי
compID varchar מזהה החברה שלך כן
user varchar *שם משתמש
pass varchar *סיסמה
dateissued varchar התאריך שיופיע על המסמך (YYYYmmdd). החוק מחייב שמסמך הנהלת חשבונות יונפק עם תאריך של היום שבו הוא מונפק אך המערכת לא אוכפת את זה. באחריותך לדאוג לניהול נכון של תאריכי המסמך. כן
clientname varchar שם הלקוח עבורו מופק המסמך. כן
client_street_number varchar מספר הבית של הלקוח
client_street varchar שם הרחוב של הלקוח
client_city varchar עיר הלקוח
client_country varchar מדינת הלקוח
client_zip varchar מיקוד הלקוח
docType varchar סוג המסמך (במקרה שלנו סוג המסמך יהיה invrec) כן
totalsum varchar סה”כ לפני מע”מ – בשקלים. כלומר, אם המסמך במט”ח יש לתרגם את סכום הסה”כ לשקלים. כן
totalvat varchar סה”כ סכום המע”מ – בשקלים. כלומר, אם המסמך במט”ח יש לתרגם את סכום הסה”כ לשקלים. כן
totalwithvat varchar סה”כם כולל מע”מ – בשקלים. כלומר, אם המסמך במט”ח יש לתרגם את סכום הסה”כ לשקלים. כן
taxexempt varchar במידה וחשבונית המס פטורה ממע”מ על משתנה זה להיות בעל ערך של 1 אחרת עליו להיות ריק
desc[] varchar תיאור הפריט כן
quantity[] varchar כמות כן
unitprice[] varchar מחיר יחידה ללא מע”מ (ללא התייחסות למט”ח) כלומר אם יחידה עולה 10 דולר על המשתנה להיות בעל ערך של 10 ואם היא עולה 10 שקלים ערך המשתנה עדיין צריך להיות 10 כן
maampercent varchar אחוז המע”מ. לדוגמה – אם המע”מ ביום הפקת המסמך הינו 18 אחוז על המשתנה להיות בעל ערך של 18 כן
paid varchar סה”כ בקבלה לפני ניכוי מס במקור (בשקלים) כן
nicui varchar סכום ניכוי מס במקור (בשקלים)
totalpaid varchar סה”כ כולל ניכוי מס במקור (בשקלים) כן
income_type_name varchar שם סוג ההכנסה כפי שמופיע במערכת
vatid varchar מספר ת.ז. / עוסק מורשה / ח.פ. של הלקוח
במידה והמסמך הינו במט”ח
currency varchar מספר המט”ח
1=EUR, 2=USD, 3=Yen, 4=GBP, 5=NIS, 6=SGP, 7=CAD, 8=RUB, 9=NZD, 10=AUD, 11=KES
rate varchar שער המט”ח
hidenis varchar האם להסתיר ערכים שקליים. 1=כן או פשוט לא לשלוח את הפרמטר הזה כדי להציג אותם
במידה ויש מזומן בתור אמצעי התשלום (או בתור אחד מאמצעי התשלום)
cash varchar במידה ויש תשלום במזומן על המשתנה הזה להיות בעל הערך 1
cashamount varchar סכום שהתקבל במזומן
במידה ויש העברה בנקאית בתור אמצעי התשלום (או בתור אחד מאמצעי התשלום)
banktransfer varchar במידה ויש העברה בנקאית המשתנה הזה צריך להיות בעל הערך 1
depositedTo varchar מספר החשבון אליו הועברו הכספים (ניתן גם לשלב מספר סניף. לדוגמה – 118-182788 יסמל סניף 118 חשבון 182788)
totalBT varchar סה”כ סכום שהועבר בהעברה בנקאית
peraonDateBT varchar תאריך ההעברה
במידה ויש המחאות בתור אמצעי התשלום (או בתור אחד מאמצעי התשלום)
cheque varchar במידה ויש המחאות המשתנה הזה צריך להיות בעל הערך 1
chequeDateY[] varchar תאריך ההמחאה (בפורמט yyyy)
chequeDateM[] varchar תאריך ההמחאה (בפורמט mm)
chequeDateD[] varchar תאריך ההמחאה (בפורמט dd)
chequeNumber[] varchar מספר ההמחאה
chequeSnif[] varchar מספר הסניף של ההמחאה
chequeAcc[] varchar מספר החשבון של ההמחאה
chequeBank[] varchar מספר הבנק של ההמחאה
chequeTotal[] varchar סה”כ סכום השיק
במידה ויש כרטיס אשראי בתור אמצעי התשלום (או בתור אחד מאמצעי התשלום)
credit varchar במידה ויש תשלום באשראי המשתנה הזה צריך להיות בעל הערך 1
cc_cardtype[] varchar סוג הכרטיס (ויזה / כאל / לאומי כארד / דיינרס / אמ. אקס. / ישראכרט / מאסטרכארד)
cc_paymenttype[] varchar צורת התשלום* (1=רגיל / 2=תשלומים / 3=קרדיט)
cctotal[] varchar סה”כ שולם בכרטיס
ccfirstpayment[] varchar תשלום ראשון – או כל התשלום אם לא מדובר בתשלומים
cc_numofpayments[] varchar מספר התשלומים (אם זו לא עסקה בתשלומים יש להעביר 1)
cc_peraondate[] varchar תאריך התשלום באשראי (yyyymmdd)
cc_shovar[] varchar מספר השובר
cc_cardnumber[] varchar מספר הכרטיס (רצוי לציין רק את ארבע הספרות האחרונות)
cc_holdername[] varchar שם בעל הכרטיס
במידה ורוצים שiCount תבצע את הפניה למסוף האשראי שלכם תוך כדי הקריאה ל API
cc_bill varchar חייב להיות בעל הערך 1 אחרת המערכת תתעלם לחלוטין מהבקשה שלך לחייב כרטיס אשראי
cc_validity_MM varchar תוקף כרטיס האשראי – חודש (שתי ספרות)
cc_validity_YY varchar תוקף כרטיס האשראי – שנה (שתי ספרות)
cc_cvv varchar שלוש ספרות בגב הכרטיס
cc_id varchar תעודת הזהות של בעל הכרטיס
במידה ויש PayPal בתור אמצעי התשלום (או בתור אחד מאמצעי התשלום)
paypal varchar במידה ויש תשלום דרך PayPal המשתנה הזה צריך להיות בעל הערך 1
pp_sum varchar סה”כ תשלום דרך PayPal
pp_deal_number varchar מספר העסקה לפי PayPal
pp_name_of_payer varchar שם המשלם ב PayPal
pp_paydate varchar תאריך התשלום (בפורמט yyyy-mm-dd)
במידה ויש בארטר בתור אמצעי התשלום (או בתור אחד מאמצעי התשלום)
barter varchar במידה ויש תשלום בבארטר המשתנה הזה צריך להיות בעל הערך 1
barter_amount varchar סה”כ שווי הבארטר
אם ברצונך להוסיף הערה ידנית לתוכן המייל שיכיל את הלינק למסמך
eft varchar טקסט חופשי במייל
אם ברצונך להגדיר נושא למייל, ולא להשתמש בברירת המחדל המובנית
es varchar טקסט נושא המייל
אם המסמך פטור ממע”מ
taxexempt varchar יש להעביר את הערך “1” במידה והמסמך פטור ממע”מ
אם ברצונך להוסיף הערה למסמך שתוצג באזור ההערות
hwc varchar
במידה ורוצים לשלוח מסמך מקור חתום דיגיטלית ישירות למייל של הלקוח
sendOrig varchar כתובת המייל של הלקוח
sendCopy varchar כתובת נוספת אליו ישלח המסמך. בדרך כלל נהוג להשתמש בזה על מנת לשלוח לעצמך העתק
ובמידה ורוצים שהשפה שבה ישלח המסמך ללקוח המייל תהיה שונה מעברית
lang varchar כרגע המערכת תומכת באנגלית או עברית בלבד. לכן האפשרות היחידה היא en
במידה ורוצים לקבל מידע ממערכת ה API אודות המסמך שמונפק (מומלץ)
show_response varchar אם רוצים תשובה (respnose) על המשתנה הזה להיות בעל הערך 1
debug varchar אם רוצים לקבל מידע debug בפורמט html על המשתנה הזה להיות בעל ערך “yes”
הערות

* – השדה צורת תשלום הינו לתצוגה בלבד. בעת סליקה המערכת מבצעת סליקה כתשלום רגיל או תשלומים תלוי במספר התשלומים שהועבר.