עסקאות

נקודות קצה לניהול עסקאות, כולל סטטוס ומוצרים בעסקה.

רשימת עסקאות get

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

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

כותרות חובה

פרמטר סוג תיאור
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/deals/{deal}

כותרות חובה

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

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

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

יצירת עסקה post

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

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

כותרות חובה

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

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

פרמטר סוג תיאור
name חובה string שם העסקה.
pipeline_id חובה integer מזהה Pipeline.
stage_id חובה integer מזהה שלב בתוך ה-Pipeline.
amount אופציונלי number סכום. לקריאה בלבד אם יש מוצרים בעסקה.
expected_close_date אופציונלי date תאריך סגירה צפוי (`Y-m-d`).
status אופציונלי string `open` / `won` / `lost` (בעדכון).
lost_reason אופציונלי string סיבת הפסד — לרוב נדרש כש-`status=lost`.
user_id אופציונלי integer בעלים.
swatch_color אופציונלי string צבע כרטיס.
contacts אופציונלי array מזהי אנשי קשר.
companies אופציונלי array מזהי חברות.
tags אופציונלי array תגיות.

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

{
    "name": "הצעת מחיר — פרויקט חדש",
    "pipeline_id": 1,
    "stage_id": 2,
    "amount": 12500,
    "expected_close_date": "2026-08-31",
    "user_id": 1,
    "contacts": [
        1
    ],
    "companies": [
        1
    ]
}

עדכון עסקה put

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

https://your-company.example.com/api/deals/{deal}

כותרות חובה

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

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

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

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

פרמטר סוג תיאור
name אופציונלי string שם העסקה.
pipeline_id אופציונלי integer מזהה Pipeline.
stage_id אופציונלי integer מזהה שלב בתוך ה-Pipeline.
amount אופציונלי number סכום. לקריאה בלבד אם יש מוצרים בעסקה.
expected_close_date אופציונלי date תאריך סגירה צפוי (`Y-m-d`).
status אופציונלי string `open` / `won` / `lost` (בעדכון).
lost_reason אופציונלי string סיבת הפסד — לרוב נדרש כש-`status=lost`.
user_id אופציונלי integer בעלים.
swatch_color אופציונלי string צבע כרטיס.
contacts אופציונלי array מזהי אנשי קשר.
companies אופציונלי array מזהי חברות.
tags אופציונלי array תגיות.

מחיקת עסקה delete

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

https://your-company.example.com/api/deals/{deal}

כותרות חובה

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

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

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

צירוף שיוכים לעסקה put

https://your-company.example.com/api/associations/deals/{deal}

כותרות חובה

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

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

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

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

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

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

{
    "contacts": [
        1
    ],
    "companies": [
        2
    ],
    "activities": [
        3
    ],
    "documents": [
        4
    ]
}
יש לספק לפחות משאב אחד בגוף הבקשה.

ניתוק שיוכים מעסקה delete

https://your-company.example.com/api/associations/deals/{deal}

כותרות חובה

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

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

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

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

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

סנכרון שיוכים לעסקה post

https://your-company.example.com/api/associations/deals/{deal}

כותרות חובה

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

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

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

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

פרמטר סוג תיאור
contacts אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
companies אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
סנכרון מלא: מערך ריק למשאב מנתק את כל השיוכים של אותו סוג.

שינוי סטטוס עסקה put

נקודת קצה זו מיושנת. עדיף לעדכן דרך «עדכון עסקה» עם שדה status.

https://your-company.example.com/api/deals/{deal}/status/{status}

כותרות חובה

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

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

פרמטר סוג תיאור
deal חובה integer מזהה עסקה.
status חובה string אחד מ־`open`, `won`, `lost`.

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

{
    "status": "lost",
    "lost_reason": "Budget"
}
דוגמת עדכון מומלצת: PUT /api/deals/{id} עם {"status":"won"}.

מוצרים בעסקה post

ניהול מוצרים בעסקה (billable). משאב products הוא קטלוג מוגדר מראש; מוצרי העסקה מחזיקים מצב נפרד ומקושרים דרך product_id.

https://your-company.example.com/api/deals/{deal}/billable

כותרות חובה

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

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

פרמטר סוג תיאור
deal חובה integer מזהה עסקה.

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

פרמטר סוג תיאור
tax_type אופציונלי string `exclusive` / `inclusive` / `no_tax`. אם לא סופק — ברירת המחדל מהגדרות מוצרים.
products חובה array מוצרים לחיוב. אפשר להוסיף ולעדכן באותה בקשה.
products[].product_id אופציונלי integer קישור למוצר מוגדר מראש (משאב מוצרים).
products[].name חובה string שם שורה.
products[].unit_price חובה number מחיר יחידה.
products[].qty חובה number כמות.
products[].tax_rate אופציונלי number שיעור מס.
products[].tax_label אופציונלי string תווית מס.
products[].discount_type אופציונלי string סוג הנחה (למשל `percent`).
products[].discount_total אופציונלי number ערך הנחה.
removed_products אופציונלי array מזהי שורות להסרה.

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

{
    "tax_type": "exclusive",
    "products": [
        {
            "name": "רישיון",
            "product_id": 3,
            "unit_price": 5000,
            "qty": 2,
            "unit": "unit",
            "tax_label": "מע״מ",
            "tax_rate": 17,
            "discount_type": "percent",
            "discount_total": 10,
            "display_order": 1
        }
    ],
    "removed_products": [
        12
    ]
}
גם GET /api/deals/{deal}/billable זמין לשליפת המוצרים והמס של העסקה.

© 2026 BeCRM