יצירת פריט ב-API

  • ניתן לפנות ל- API של Invoice Maven באמצעות בקשת JSON.
  • יש לפנות באמצעות POST .
  • החיבור צריך להתבצע באמצעות SSL (פורט 443).
  • לכל פניה יתווסף מפתח API שהוא בעצם מזהה חד ערכי לחשבון הלקוח במערכת.
  • לאחר הפניה ליצירת פריט השרת יחזיר תשובה בפורמט JSON המציינת האם הפעולה הצליחה ואם לא את קוד ותיאור השגיאה.
  • את שמות השדות המועברים יש לכתוב ב- lowercase בלבד.
  • הקידוד של הפניה צריך להיות UTF-8.
בקשה להקמה של פריט – AddItem יש לפנות לכתובת: https://app.invoice-maven.co.il/api/items/addItem יש להעביר את הפרמטרים הבאים בפורמט JSON: שדות כלליים:
שדה ברירת מחדל חובה תיאור
api_key כן מפתח ייחודי המשוייך לעסק במערכת ויש להעביר אותו עם כל בקשה.
test כן האם להקים פריטים לבדיקה בלבד (יש להעביר 1 כדי לבצע בדיקות לפני הקמה אמיתית):

0 – יצירת פריט אמיתי
1 – הקמת פריטים לבדיקה. במצב זה יוקם פריט ללא שמירה במערכת.
contact_email כן אימייל של מפתח התוכנה ליצירת קשר במקרה של בעיה.
contact_phone כן טלפון של מפתח התוכנה ליצירת קשר במקרה של בעיה.
name כן שם הפריט.
amount כן מחיר הפריט (מספר עשרוני).
item_no לא מק"ט פנימי של הפריט. יש להעביר אם רוצים שזה יזוהה כייחודי במערכת — לא ניתן להקים שני פריטים עם אותו מק"ט.
external_item_id לא מזהה חיצוני של הפריט (לדוגמא ממערכת חיצונית). יחיד למניעת כפילויות.
description לא תיאור הפריט שיופיע על גבי המסמך.
currency_id מטבע ברירת המחדל של העסק לא מזהה המטבע של מחיר הפריט (לדוגמא 1 = שקל, 2 = דולר). אם לא יועבר — יילקח מטבע ברירת המחדל של העסק.
vat_included_yn false לא האם המחיר כולל מע"מ. true – כן, false – לא.
no_vat_yn false לא האם הפריט פטור ממע"מ. true – פטור, false – חייב במע"מ.
inventory_management_yn false לא האם לנהל מלאי לפריט הזה. true – לנהל, false – לא.
inventory_count 0 לא כמות התחלתית במלאי (רלוונטי אם inventory_management_yn = true).
archive_yn false לא האם הפריט בארכיון (לא יוצג ברשימת הפריטים הפעילים). true – בארכיון, false – פעיל.

יש צורך בעזרה?

נשמח לתת מענה לכל בעיה והתלבטות.
צוות התמיכה עושה הכל כדי לספק מענה מהיר.
אנחנו כאן.

טופס פניה לתמיכה