עריכת פריט ב-API
- ניתן לפנות ל- API של Invoice Maven באמצעות בקשת JSON.
- יש לפנות באמצעות POST .
- החיבור צריך להתבצע באמצעות SSL (פורט 443).
- לכל פניה יתווסף מפתח API שהוא בעצם מזהה חד ערכי לחשבון הלקוח במערכת.
- לאחר הפניה לעדכון פריט השרת יחזיר תשובה בפורמט JSON המציינת האם הפעולה הצליחה ואם לא את קוד ותיאור השגיאה.
- את שמות השדות המועברים יש לכתוב ב- lowercase בלבד.
- הקידוד של הפניה צריך להיות UTF-8.
| שדה | ברירת מחדל | חובה | תיאור |
|---|---|---|---|
| api_key | כן | מפתח ייחודי המשוייך לעסק במערכת ויש להעביר אותו עם כל בקשה. | |
| test | כן |
האם לבצע עדכון לבדיקה בלבד (יש להעביר 1 כדי לבצע בדיקות): 0 – עדכון אמיתי במערכת 1 – הרצת עדכון לבדיקה. במצב זה השינוי לא יישמר במערכת. |
|
| contact_email | כן | אימייל של מפתח התוכנה ליצירת קשר במקרה של בעיה. | |
| contact_phone | כן | טלפון של מפתח התוכנה ליצירת קשר במקרה של בעיה. | |
| id | מותנה | מזהה GUID של הפריט (כפי שהוחזר ב-AddItem). זוהי דרך הזיהוי המומלצת ובעדיפות העליונה. | |
| item_no | מותנה | מק"ט הפריט. ישמש לזיהוי אם id לא הועבר. | |
| external_item_id | מותנה | מזהה חיצוני של הפריט. ישמש לזיהוי אם id ו-item_no לא הועברו. | |
| name | לא | שם הפריט החדש. אם לא יועבר — השם הקיים יישאר ללא שינוי. | |
| amount | לא | מחיר הפריט החדש (מספר עשרוני). אם לא יועבר — המחיר הקיים יישאר ללא שינוי. | |
| description | לא | תיאור הפריט שיופיע על גבי המסמך. | |
| currency_id | לא | מזהה המטבע של מחיר הפריט. אם לא יועבר — המטבע הקיים יישאר ללא שינוי. | |
| vat_included_yn | לא | האם המחיר כולל מע"מ. true – כן, false – לא. | |
| no_vat_yn | לא | האם הפריט פטור ממע"מ. true – פטור, false – חייב במע"מ. | |
| inventory_management_yn | לא | האם לנהל מלאי לפריט הזה. true – לנהל, false – לא. | |
| inventory_count | לא | עדכון כמות במלאי (רלוונטי אם inventory_management_yn = true). | |
| archive_yn | לא | האם להעביר את הפריט לארכיון. true – להעביר, false – להחזיר ממנו. |