חיפוש מסמכים ב-API

חיפוש מסמכים ב־API

ניתן לבצע אינטגרציה מול מערכת Invoice Maven באמצעות שליחת בקשות JSON ל־API של המערכת.

מפתח API:
יש לשלוח את מפתח ה־API באחד או בשני המקומות הבאים:
בגוף הבקשה (api_key).
בכותרת (Header) בשם: x-api-key: YOUR_API_KEY

https://app.invoice-maven.co.il/api/documents/searchDocuments

כל בקשה מוגבלת ל-20 מסמכים.

שם השדה	סוג ערך	חובה	תיאור
`api_key`	מחרוזת (String)	כן	מפתח הגישה לחשבון שלך במערכת Invoice Maven. יש לשלוח גם ב־header בשם `x-api-key`.
`page`	מספר (Integer)	כן	מספר העמוד בתוצאות החיפוש. מתחיל מ־1.
`page_size`	מספר (Integer)	כן	כמות המסמכים בכל עמוד. לדוגמה: 10.
`sort_by`	מחרוזת (String)	לא	שדה למיון התוצאות. הערך הנתמך כרגע: `document_date`.
`description`	מחרוזת (String)	לא	טקסט חופשי לחיפוש לפי תיאור המסמך.
`from_document_date`	תאריך (String)	לא	תאריך התחלה לחיפוש, בפורמט `yyyy-mm-dd` או `dd/mm/yyyy`.
`to_document_date`	תאריך (String)	לא	תאריך סיום לחיפוש מסמכים.
`downloaded_by_customer`	מספר (1 או 0)	לא	סינון לפי האם המסמך הורד על ידי הלקוח. `1` = כן, `0` = לא.
`customer_id`	מחרוזת / מספר	לא	מזהה פנימי של הלקוח. לדוגמה: מספר מזהה או ID במערכת שלך.
`customer_name`	מחרוזת (String)	לא	שם הלקוח לחיפוש לפי טקסט חופשי.
`customer_email`	מחרוזת (String)	לא	כתובת אימייל של הלקוח לחיפוש מסמכים שנשלחו אליו.
`sort_dir`	מחרוזת (String)	לא	לחפש לפי סדר עולה או יורד, desk or asc