API הכנסות קופה
ממשק זה משמש להעברת נתוני הכנסות קופה (דוח z) לפי 3 חתכים :
א. פירוט לפי משמרת
ב. פירוט לפי ערוץ מכירה (למשל ישיבה, t.a, משלוחים)
ג. פירוט לפי אמצעי תשלום של ערוץ המכירה
Method: POST
Url Production: https://api.restigo.co.il/api/pos/{provider}/receive/income
Url Test: https://dev.restigo.co.il/api/pos/{provider}/receive/income
Provider- שם הקופה ברסטיגו
Request Body
key | Required/Optional | type | שם השדה בעברית + הערות |
Branch_id | Required | Integer | מס' סניף ב RESTIGO. ישלח בעת בקשת חיבור סניף חדש |
Key | Required | String | מזהה חיבור לסניף ב RESTIGO. ישלח בעת בקשת חיבור סניף חדש |
Startdate | Required | String yyyy-mm-dd | תאריך פתיחת יום העסקים (z) |
Enddate | Required | String yyyy-mm-dd | תאריך סגירת יום העסקים (z) |
transactionDate | Required | String yyyy-mm-dd | תאריך אליו משויך יום העסקים (z) |
zNumber | Required | String | מספר ה z |
totalCustomers | Required | Integer | מס' סועדים. אם לא קיים ניתן להגדיר 1 |
AvgDeliveryTime | Required | Number | ממוצע זמן משלוח בדקות. אם לא קיים ניתן להגדיר 0 |
AvgPrepTime | Required | Number | ממוצע זמן הכנה בדקות. אם לא קיים ניתן להגדיר 0 |
AvgLeaveTime | Required | Number | ממוצע זמן יציאה מהסניף בדקות. אם לא קיים ניתן להגדיר 0 |
salesBefore6PM | Required | Number | מכירות עד השעה 18:00. מכירות כולל מע"מ |
salesAfter6PM | Required | Number | מכירות אחרי השעה 18:00. מכירות כולל מע"מ |
breakdownShifts | Required | פירוט לפי משמרת | |
| Required | String | מזהה המשמרת בקופה |
| Required | String | שם המשמרת בקופה. לדוגמא: "בוקר" |
| Required | Number | סה"כ הכנסות כולל מע"מ. מתייחס לכלל אמצעי התשלום |
| Required | Number | סכום עסקאות מסוג זיכוי / ביטול עסקה |
| Required | Number | סה"כ זיכויים / ביטולי עסקאות |
| Required | Integer | מספר עסקאות מסוג הנחה |
| Required | Number | סכום עסקאות מסוג הנחה |
| פירוט לפי ערוץ מכירה | ||
| Required | String | סוג ערוץ מכירה בקופה |
| Required | String | שם ערוץ המכירה |
| Required | Number | סה״כ הכנסות כולל מע״מ. מתייחס לכלל אמצעי התשלום הרלוונטיים לערוץ מכירה |
| Required | Number | סכום עסקאות מסוג זיכוי / ביטול עסקה לערוץ מכירה |
| Required | Integer | מס' הזמנות לערוץ מכירה |
| פירוט אמצעי תשלום לערוץ מכירה | ||
| Required | String | סוג אמצעי התשלום הספציפי |
| Required | String | שם אמצעי התשלום הספציפי |
| Required | Number | סה"כ הכנסות כולל מע״מ של אמצעי התשלום הספציפי |
| Required | Number | סה"כ זיכויים / החזרות לאמצעי תשלום הספציפי |
| Required | Number | כמות זיכויים / החזרות לאמצעי תשלום הספציפי |
| Required | Integer | מס' לקוחות לאמצעי תשלום הספציפי |
| Required | Integer | מס' הזמנות לאמצעי תשלום הספציפי |
| Required | Boolean | האם אמצעי התשלום הספציפי מחושב ב z. אם כן true |
"restigo": {
"branch_id": 642,
"key": "$2y$10$idnu1Gd738yHJ56hb1uGpeGnk01JrWF9gm/FTYcQwgBDioTmkPvv.",
"income": {
"startDate": "2024-08-13",
"endDate": "2024-08-13",
"transactionsDate": "2024-08-13",
"zNumber": "380",
"totalCustomers": 2,
"AvgDeliveryTime": 27.31,
"AvgPrepTime":24.21,
"AvgLeaveTime": 25,
"salesAfter6PM": 2500,
"salesBefore6PM": 3256.3
"breakdownShifts": [
{
"shiftType": "shiftID-1",
"shiftName": "בוקר",
"totalCharged": 11977.1,
"totalRefunded": -142,
"countRefunded": 5,
"Totaldiscount": 1,
"Sumdiscount": 100,
"breakdownOrders": [
{
"orderType": 2,
"orderName": "מסעדה",
"totalCharged": 1155.5,
"totalRefunded": 0,
"totalOrders": 4,
"breakdownPayments": [
{
"paymentType": "credit",
"paymentName": "אשראי",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "cash",
"paymentName": "מזומן",
"totalCharged": 17.9,
"totalRefunded": 150,
"countRefunded": 7,
"totalCustomers": 2,
"totalOrders": 2,
"calcInTotalZ": true
},
{
"paymentType": "checks",
"paymentName": "שיקים",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "EFT",
"paymentName": "העברה בנקאית",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": 9999,
"paymentName": "MULTIPASS",
"totalCharged": 1087.6,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
},
{
"paymentType": 20015,
"paymentName": "קופונים מנוהלים רשתית",
"totalCharged": 50,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
}
]
},
{
"orderType": 1,
"orderName": "TAKEAWAY",
"totalCharged": 1505.25,
"totalRefunded": 0,
"totalOrders": 23,
"AvgPrepTime": null,
"breakdownPayments": [
{
"paymentType": "credit",
"paymentName": "אשראי",
"totalCharged": 1070.95,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 17,
"calcInTotalZ": true
},
{
"paymentType": "cash",
"paymentName": "מזומן",
"totalCharged": 305,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 4,
"calcInTotalZ": true
},
{
"paymentType": "checks",
"paymentName": "שיקים",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "EFT",
"paymentName": "העברה בנקאית",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": 7777,
"paymentName": "תן ביס בע"מ",
"totalCharged": 44.5,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
},
{
"paymentType": 8888,
"paymentName": "סיבוס סודקסו פאס ישראל בע"מ",
"totalCharged": 84.8,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
}
]
},
{
"orderType": 4,
"orderName": "WOLT",
"totalCharged": 4296.2,
"totalRefunded": 0,
"totalOrders": 34,
"AvgPrepTime": null,
"AvgDeliveryTime": null,
"breakdownPayments": [
{
"paymentType": "credit",
"paymentName": "אשראי",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "cash",
"paymentName": "מזומן",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "checks",
"paymentName": "שיקים",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "EFT",
"paymentName": "העברה בנקאית",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": 3333,
"paymentName": "WOLT",
"totalCharged": 4296.2,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 34,
"calcInTotalZ": true
}
]
},
{
"orderType": 3,
"orderName": "משלוחים",
"totalCharged": 5020.15,
"totalRefunded": -142,
"totalOrders": 42,
"AvgPrepTime": null,
"AvgDeliveryTime": 27.31,
"breakdownPayments": [
{
"paymentType": "credit",
"paymentName": "אשראי",
"totalCharged": 4650,
"totalRefunded": -142,
"totalCustomers": 0,
"totalOrders": 37,
"calcInTotalZ": true
},
{
"paymentType": "cash",
"paymentName": "מזומן",
"totalCharged": 121.9,
"totalRefunded": 134,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
},
{
"paymentType": "checks",
"paymentName": "שיקים",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": "EFT",
"paymentName": "העברה בנקאית",
"totalCharged": 0,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 0,
"calcInTotalZ": true
},
{
"paymentType": 4444,
"paymentName": "פאפא גונס ניהול מותגים בע"מ",
"totalCharged": 97.6,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
},
{
"paymentType": 7777,
"paymentName": "תן ביס בע"מ",
"totalCharged": 150.65,
"totalRefunded": 0,
"totalCustomers": 0,
"totalOrders": 1,
"calcInTotalZ": true
}
]
}
]
}
]
}
}
}
ממשק הכנסות נוספות
באמצעות ממשק זה ניתן ליצור הכנסות נוספות לסניף מסוים.
Endpoint
Method: POST
Url for production: https://api.restigo.co.il/api/thirdParty/income/extra
Url for development: https://dev.restigo.co.il/api/thirdParty/income/extra
Request
key | value |
RESTIGO-API-KEY (header) | Provided separately |
date (תאריך) | Required | date |
client_name (שם לקוח) | Required | string |
total_with_vat (סכום כולל מע״מ) | Required | numeric |
type (סוג הכנסה) | Required | string |
diners (מספר סועדים) | Required | integer |
maturity_date (תאריך פירעון) | Required | date |
document_number (מספר קבלה) | Required | string |
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
Request Example:
{
"date": "2025-04-08", // YYYY-MM-DD
"client_name": "name",
"total_with_vat": 443,
"type": "אירוח",
"diners": 2,
"maturity_date": "2025-04-18", // YYYY-MM-DD
"document_number": "65653871"
}
Response
Success Response
Status Code: 201 CREATED
Example Response
{
"branch_id": 1,
"date": "2025-04-08",
"client_name": "name",
"total_with_vat": 443,
"diners": 2,
"total_without_vat": 375.42,
"notes": "מספר קבלה: 65653871, תאריך פירעון: 2025-04-18",
"branch_name": "נתניה",
"type_name": "אירוח"
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "Unauthorized"
}