הפניה ל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 סוג המסמך (במקרה שלנו סוג המסמך יהיה invoice) כן
totalsum varchar סה”כ לפני מע”מ – בשקלים. כלומר, אם המסמך במט”ח יש לתרגם את סכום הסה”כ לשקלים. כן
totalvat varchar סה”כ סכום המע”מ – בשקלים. כלומר, אם המסמך במט”ח יש לתרגם את סכום הסה”כ לשקלים. כן
totalwithvat varchar סה”כ כולל מע”מ – בשקלים. כלומר, אם המסמך במט”ח יש לתרגם את סכום הסה”כ לשקלים. כן
paidincvat varchar סה”כ כולל מע”מ ששולם בשקלים(המערכת משתמש בנתון זה על מנת להבחין הבין חשבוניות שהתקבל בעבורן תשלום לבין כאלה שלא התקבל בעבורן תשלום. חשבונית עם תשלום חלקי תופיע כחשבונית מזוכה חלקית.) כן
taxexempt varchar במידה וחשבונית המס פטורה ממע”מ על משתנה זה להיות בעל ערך של 1 אחרת עליו להיות ריק
desc[] varchar תיאור הפריט כן
quantity[] varchar כמות כן
unitprice[] varchar מחיר יחידה ללא מע”מ (ללא התייחסות למט”ח) כלומר אם יחידה עולה 10 דולר על המשתנה להיות בעל ערך של 10 ואם היא עולה 10 שקלים ערך המשתנה עדיין צריך להיות 10 כן
maampercent varchar אחוז המע”מ. לדוגמה – אם המע”מ ביום הפקת המסמך הינו 15.5 אחוז על המשתנה להיות בעל ערך של 15.5 כן
originaldiscount varchar הנחה כולל מע”מ
currency varchar מספר המט”ח
1=EUR, 2=USD, 3=YEN, 4=GBP, 5=ILS, 6=SGP, 7=CAD, 8=RUB, 9=NZD, 10=AUD, 11=KES, 12=BRL, 13=DKK, 14=NOK
rate varchar שער המט”ח
hidenis varchar האם להסתיר ערכים שקליים. 1=כן או פשוט לא לשלוח את הפרמטר הזה כדי להציג אותם
paydate varchar תאריך לתשלום כן
afterdiscount varchar סכום לפני מע”מ אחרי הנחה כן
income_type_name varchar שם סוג ההכנסה כפי שמופיע במערכת
vatid varchar מספר ת.ז. / עוסק מורשה / ח.פ. של הלקוח
קשירת המסמך למסמכים אחרים
based_on_doctype varchar receipt (כרגע נתמך רק receipt)
based_on_docnum varchar רשימה של מספרי הקבלות, מופרדת בפסיקים, ללא רווחים. אם יש רק קבלה אחת פשוט לכתוב רק מספר אחד בלי פסיקים
אם רוצים שליחה מיידית למייל
sendOrig varchar כתובת המייל של הלקוח
sendCopy varchar כתובת נוספת אליה ישלח המסמך. בדרך כלל נהוג להשתמש בזה על מנת לשלוח לעצמך העתק
אם ברצונך להוסיף הערה ידנית לתוכן המייל שיכיל את הלינק למסמך
eft varchar טקסט חופשי במייל
אם ברצונך להגדיר נושא למייל, ולא להשתמש בברירת המחדל המובנית
es varchar טקסט נושא המייל
אם המסמך פטור ממע”מ
taxexempt varchar יש להעביר את הערך “1” במידה והמסמך פטור ממע”מ
אם ברצונך להוסיף הערה למסמך שתוצג באזור ההערות
hwc varchar טקסט שיופיע בשדה ההערכות של המסמך
ובמידה ורוצים שהשפה שבה ישלח המסמך ללקוח המייל תהיה שונה מעברית
lang varchar כרגע המערכת תומכת באנגלית או עברית בלבד. לכן האפשרות היחידה היא en
במידה ורוצים לקבל מידע ממערכת ה API אודות המסמך שמונפק (מומלץ)
show_response varchar אם רוצים תשובה (respnose) על המשתנה הזה להיות בעל הערך 1
debug varchar אם רוצים לקבל מידע debug בפורמט html על המשתנה הזה להיות בעל ערך “yes”