מסמכים — API

רשימת מסמכים get

שליפת רשימה עם עימוד.

https://your-company.example.com/api/documents

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרי שאילתה

פרמטר	סוג	תיאור
`page` אופציונלי	`integer`	מספר עמוד. ברירת מחדל: 1.
`per_page` אופציונלי	`integer`	גודל עמוד (עד 100 ברוב המשאבים). ברירת מחדל: 15.
`q` אופציונלי	`string`	מחרוזת חיפוש חופשית.
`order` אופציונלי	`string`	מיון. דוגמה: `created_at` או `created_at\|desc`.
`select` אופציונלי	`string`	בחירת שדות. דוגמה: `id;first_name;email`.
`with` אופציונלי	`string`	טעינת יחסים (eager load).

שליפת מסמך get

שליפת רשומה בודדת לפי מזהה.

https://your-company.example.com/api/documents/{document}

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה הרשומה.

יצירת מסמך post

יצירת רשומה חדשה. תשובה מוצלחת מחזירה סטטוס 201.

https://your-company.example.com/api/documents

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בגוף הבקשה

פרמטר	סוג	תיאור
`title` חובה	`string`	כותרת המסמך.
`brand_id` חובה	`integer`	מותג.
`user_id` חובה	`integer`	בעלים.
`document_type_id` אופציונלי	`integer`	סוג מסמך.
`requires_signature` אופציונלי	`boolean`	דורש חתימה.
`view_type` אופציונלי	`string`	`nav-top` / `nav-left` / `nav-left-full-width`.
`locale` אופציונלי	`string`	שפה.
`valid_until` אופציונלי	`date`	תוקף.
`signers` אופציונלי	`array`	`[{name, email, send_email?}]`.
`recipients` אופציונלי	`array`	`[{name, email, send_email?}]`.
`billable` אופציונלי	`object`	מוצרים ומס — נדרש לסוג הצעת מחיר.
`contacts` אופציונלי	`array`	מזהי אנשי קשר.
`companies` אופציונלי	`array`	מזהי חברות.
`deals` אופציונלי	`array`	מזהי עסקאות.

דוגמת גוף בקשה

{
    "title": "הצעת מחיר",
    "brand_id": 1,
    "document_type_id": 1,
    "user_id": 1,
    "view_type": "nav-left",
    "requires_signature": true,
    "signers": [
        {
            "name": "ישראל ישראלי",
            "email": "israel@example.com",
            "send_email": true
        }
    ],
    "contacts": [
        1
    ],
    "billable": {
        "tax_type": "inclusive",
        "products": [
            {
                "name": "שירות",
                "unit_price": 1000,
                "qty": 1,
                "product_id": 2
            }
        ]
    }
}

עדכון מסמך put

עדכון חלקי או מלא של רשומה קיימת.

https://your-company.example.com/api/documents/{document}

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר	סוג	תיאור
`title` אופציונלי	`string`	כותרת המסמך.
`brand_id` אופציונלי	`integer`	מותג.
`user_id` אופציונלי	`integer`	בעלים.
`document_type_id` אופציונלי	`integer`	סוג מסמך.
`requires_signature` אופציונלי	`boolean`	דורש חתימה.
`view_type` אופציונלי	`string`	`nav-top` / `nav-left` / `nav-left-full-width`.
`locale` אופציונלי	`string`	שפה.
`valid_until` אופציונלי	`date`	תוקף.
`signers` אופציונלי	`array`	`[{name, email, send_email?}]`.
`recipients` אופציונלי	`array`	`[{name, email, send_email?}]`.
`billable` אופציונלי	`object`	מוצרים ומס — נדרש לסוג הצעת מחיר.
`contacts` אופציונלי	`array`	מזהי אנשי קשר.
`companies` אופציונלי	`array`	מזהי חברות.
`deals` אופציונלי	`array`	מזהי עסקאות.

מחיקת מסמך delete

מחיקה רכה. תשובה מוצלחת: 204 No Content.

https://your-company.example.com/api/documents/{document}

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה הרשומה.

חיפוש מסמכים get

חיפוש מהיר. מחזיר מערך (ללא עימוד מלא כמו ברשימה).

https://your-company.example.com/api/documents/search

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרי שאילתה

פרמטר	סוג	תיאור
`q` חובה	`string`	מחרוזת החיפוש.
`order` אופציונלי	`string`	מיון. דוגמה: `created_at` או `created_at\|desc`.
`select` אופציונלי	`string`	בחירת שדות. דוגמה: `id;first_name;email`.
`with` אופציונלי	`string`	טעינת יחסים (eager load).

צירוף שיוכים למסמך put

https://your-company.example.com/api/associations/documents/{document}

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר	סוג	תיאור
`contacts` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
`companies` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
`deals` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.

דוגמת גוף בקשה

{
    "contacts": [
        1
    ],
    "companies": [
        2
    ],
    "deals": [
        3
    ]
}

יש לספק לפחות משאב אחד בגוף הבקשה.

ניתוק שיוכים ממסמך delete

https://your-company.example.com/api/associations/documents/{document}

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר	סוג	תיאור
`contacts` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
`companies` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
`deals` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.

יש לספק לפחות משאב אחד בגוף הבקשה.

סנכרון שיוכים למסמך post

https://your-company.example.com/api/associations/documents/{document}

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר	סוג	תיאור
`contacts` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
`companies` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
`deals` אופציונלי	`array`	מערך מזהים לשיוך. יש לספק לפחות משאב אחד.

סנכרון מלא: מערך ריק למשאב מנתק את כל השיוכים של אותו סוג.

פעולות על מסמך post

פעולות סטטוס מאומתות: /accept, /lost, /draft. ללקוח קצה יש גם נתיבים ציבוריים תחת /api/d/{uuid}/... (accept / sign / validate).

https://your-company.example.com/api/documents/{document}/accept

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה מסמך.

מוצרים במסמך post

ניהול מוצרים במסמך/הצעת מחיר — אותו מבנה כמו «מוצרים בעסקה».

https://your-company.example.com/api/documents/{document}/billable

כותרות חובה

פרמטר	סוג	תיאור
`Accept` חובה	`string`	`application/json`
`Content-Type` חובה	`string`	`application/json` (בבקשות עם גוף)
`Authorization` חובה	`string`	`Bearer {token}`

פרמטרים בנתיב

פרמטר	סוג	תיאור
`document` חובה	`integer`	מזהה מסמך.

דוגמת גוף בקשה

{
    "tax_type": "inclusive",
    "products": [
        {
            "name": "שירות",
            "unit_price": 1000,
            "qty": 1,
            "product_id": 2
        }
    ]
}