יצירה או עריכת פריט ב-API
- ניתן לפנות ל- API של Invoice Maven באמצעות בקשת JSON.
- יש לפנות באמצעות POST .
- החיבור צריך להתבצע באמצעות SSL (פורט 443).
- לכל פניה יתווסף מפתח API שהוא בעצם מזהה חד ערכי לחשבון הלקוח במערכת.
- לאחר הפניה ליצירה או עדכון של פריט השרת יחזיר תשובה בפורמט JSON המציינת האם הפעולה הצליחה ואם לא את קוד ותיאור השגיאה.
- את שמות השדות המועברים יש לכתוב ב- lowercase בלבד.
- הקידוד של הפניה צריך להיות UTF-8.
| שדה | ברירת מחדל | חובה | תיאור |
|---|---|---|---|
| api_key | כן | מפתח ייחודי המשוייך לעסק במערכת ויש להעביר אותו עם כל בקשה. | |
| test | כן |
האם לבצע הקמה / עדכון לבדיקה בלבד (יש להעביר 1 כדי לבצע בדיקות): 0 – הפעולה תתבצע במציאות 1 – הפעולה תיבדק בלבד, ללא שמירה במערכת. |
|
| contact_email | כן | אימייל של מפתח התוכנה ליצירת קשר במקרה של בעיה. | |
| contact_phone | כן | טלפון של מפתח התוכנה ליצירת קשר במקרה של בעיה. | |
| name | כן (בהקמה חדשה) | שם הפריט. חובה אם זוהי הקמה חדשה. בעדכון של פריט קיים – לא חובה. | |
| amount | כן (בהקמה חדשה) | מחיר הפריט (מספר עשרוני). חובה אם זוהי הקמה חדשה. בעדכון – לא חובה. | |
| id | לא | מזהה GUID של הפריט (כפי שהוחזר ב-AddItem קודם). עדיפות עליונה לזיהוי פריט קיים. | |
| item_no | לא | מק"ט הפריט. ישמש לזיהוי אם id לא הועבר. | |
| external_item_id | לא | מזהה חיצוני של הפריט. ישמש לזיהוי אם id ו-item_no לא הועברו. | |
| 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 – פעיל. |