{ "info": { "name": "רצף – Retzef API", "description": "The Retzef invoicing API (engine 0.23.0), generated from https://retsef.co.il/docs/openapi.json.\n\n1. Set the collection variable apiKey to your business API key (iek_..., created on the site → API tab) or a personal access token (iep_...). Never share an exported collection with the key in it.\n\n2. Set businessId (GET /v1/businesses lists it). Amounts are integers in agorot (100 = 1 ₪); dates are YYYY-MM-DD.\n\n3. Issuing is irreversible: try \"dryRun\": true first. Rate limits (engine 0.20): 429 with Retry-After – wait and retry.\n\nHebrew reference: https://retsef.co.il/docs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "0.23.0" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://retsef.co.il/api", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" }, { "key": "businessId", "value": "", "type": "string" }, { "key": "documentId", "value": "", "type": "string" }, { "key": "customerId", "value": "", "type": "string" }, { "key": "itemId", "value": "", "type": "string" }, { "key": "designId", "value": "", "type": "string" }, { "key": "linkId", "value": "", "type": "string" } ], "item": [ { "name": "Health", "description": "מצב המנוע", "item": [ { "name": "מצב המנוע: גרסה, מספר רישום וטביעת המהדורה", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/health", "host": [ "{{baseUrl}}" ], "path": [ "health" ] }, "description": "GET /health" }, "response": [] } ] }, { "name": "Auth", "description": "הרשמה, כניסה ויציאה", "item": [ { "name": "הרשמה עצמית (כשהשרת פתוח להרשמה)", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\",\n \"name\": \"\",\n \"password\": \"\",\n \"acceptTerms\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/auth/signup", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "signup" ] }, "description": "POST /v1/auth/signup" }, "response": [] }, { "name": "כניסה", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"me@example.com\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "login" ] }, "description": "POST /v1/auth/login\n\nמחזיר טוקן כניסה (ies_) לשים ב-apiKey, לבדיקות בלבד. לאוטומציה – מפתח API (iek_)." }, "response": [] }, { "name": "דרכי הכניסה שהשרת מציע (סיסמה, Google, הרשמה עצמית)", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/auth/providers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "providers" ] }, "description": "GET /v1/auth/providers" }, "response": [] }, { "name": "כניסה או הרשמה עם Google: התחלה (הכתובת ב-Google)", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"acceptTerms\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/auth/google/start", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "google", "start" ] }, "description": "POST /v1/auth/google/start\n\nstate, nonce ו-PKCE נשמרים בשרת ל-10 דקות ולשימוש אחד, קשורים לכותרת X-Auth-Binding (האתר קובע אותה מעוגייה httpOnly). כתובת החזרה קבועה: <כתובת האתר>/auth/google/callback. 404 כשהכניסה עם Google לא מופעלת." }, "response": [] }, { "name": "כניסה או הרשמה עם Google: סיום (אותה כניסה כמו בסיסמה)", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/auth/google/callback", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "google", "callback" ] }, "description": "POST /v1/auth/google/callback\n\n{ state, code } מהחזרה מ-Google, עם אותה X-Auth-Binding. משתמש עם אימות דו-שלבי: 401 עם twoFactorRequired, ושולחים שוב { state, secondFactor }. משתמש חדש שלא אישר את התנאים: 409 עם termsRequired, ושולחים שוב { state, acceptTerms: true }. 403: Google לא אישר את האימייל, או שההרשמה סגורה." }, "response": [] }, { "name": "יציאה: הטוקן שבבקשה מפסיק לעבוד", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "logout" ] }, "description": "POST /v1/auth/logout" }, "response": [] } ] }, { "name": "Me", "description": "המשתמש המחובר, סיסמה ואימות דו-שלבי", "item": [ { "name": "המשתמש המחובר והעסקים שלו", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] }, "description": "GET /v1/me" }, "response": [] }, { "name": "שינוי סיסמה (מבטל את כל הכניסות והטוקנים)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/me/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "password" ] }, "description": "PUT /v1/me/password\n\nמשתמש בלי סיסמה (נרשם עם Google): newPassword בלי currentPassword, רק בכניסה טרייה (עד 10 דקות מהכניסה)." }, "response": [] }, { "name": "התחלת הגדרת אימות דו-שלבי", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/me/two-factor", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "two-factor" ] }, "description": "POST /v1/me/two-factor" }, "response": [] }, { "name": "כיבוי אימות דו-שלבי, בקוד תקף", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/me/two-factor", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "two-factor" ] }, "description": "DELETE /v1/me/two-factor" }, "response": [] }, { "name": "אישור אימות דו-שלבי בקוד; מחזיר 8 קודי שחזור (פעם אחת)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/me/two-factor/confirm", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "two-factor", "confirm" ] }, "description": "POST /v1/me/two-factor/confirm" }, "response": [] } ] }, { "name": "Personal tokens", "description": "טוקני גישה אישיים (iep_)", "item": [ { "name": "טוקני הגישה האישיים של המשתמש (בלי הטוקנים עצמם)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/me/tokens", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "tokens" ] }, "description": "GET /v1/me/tokens" }, "response": [] }, { "name": "טוקן גישה אישי חדש (iep_), רק בכניסה עם סיסמה ועם הסיסמה שוב", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/me/tokens", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "tokens" ] }, "description": "POST /v1/me/tokens" }, "response": [] }, { "name": "ביטול טוקן של המשתמש עצמו", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/me/tokens/:tokenId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me", "tokens", ":tokenId" ], "variable": [ { "key": "tokenId", "value": "", "description": "מזהה טוקן הגישה האישי" } ] }, "description": "DELETE /v1/me/tokens/{tokenId}" }, "response": [] } ] }, { "name": "Businesses", "description": "רישום עסק, סקירה ופרטים", "item": [ { "name": "רשימת העסקים (משתמש: שלו; מפתח API: העסק שלו)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses" ] }, "description": "GET /v1/businesses" }, "response": [] }, { "name": "יצירת עסק בלבד, בלי סדרות ומפתח (מנהל)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses" ] }, "description": "POST /v1/businesses" }, "response": [] }, { "name": "רישום עסק בפעולה אחת: פרטים, סדרות, מפתח חתימה והודעה לפקיד השומה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/register", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", "register" ] }, "description": "POST /v1/businesses/register\n\nמשתמש מחובר נעשה בעל העסק (כשהשרת פתוח להרשמה עצמית). מנהל יכול לצרף בעל עסק ב-owner. בלתי הפיך. בשירות של רצף עסק חדש נפתח ישר במצב מסמכים אמיתיים (realDocumentsSince בתשובה), ומסמך ראשון שלו כבר מסמך חשבונאי." }, "response": [] }, { "name": "סקירת העסק: פרטים, סדרות, תעודה, סיכומים ומה דורש טיפול", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}" }, "response": [] }, { "name": "עדכון פרטי העסק (למעט מספר עוסק). בעל העסק או מנהל", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "PUT /v1/businesses/{id}" }, "response": [] }, { "name": "מנוע 0.22: המחזור השנתי מול תקרת עוסק פטור / עסק זעיר. עוסק פטור: חשבוניות עסקה וקבלות שאינן משלמות חשבונית עסקה; עוסק מורשה: חשבוניות מס וחשבוניות מס / קבלה פחות זיכויים, לפני מע\"מ", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/turnover", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "turnover" ], "query": [ { "key": "year", "value": "", "description": "ברירת מחדל: השנה הנוכחית (שעון ישראל)", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/turnover" }, "response": [] }, { "name": "תאריך ההודעה לפקיד השומה (הוראה 18ב(ב))", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sentOn\": \"2026-11-01\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/computerized-notice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "computerized-notice" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "PUT /v1/businesses/{id}/computerized-notice" }, "response": [] } ] }, { "name": "Sequences", "description": "סדרות מסמכים ומספרי התחלה", "item": [ { "name": "פתיחת סדרה לסוג מסמך (פעם אחת)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"docType\": 10,\n \"firstNumber\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/sequences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "sequences" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/sequences" }, "response": [] }, { "name": "שינוי המספר הבא של סדרה: רק כלפי מעלה ורק לפני המסמך הראשון", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"nextNumber\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/sequences/:docType", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "sequences", ":docType" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" }, { "key": "docType", "value": "", "description": "10 הצעת מחיר, 100 הזמנה, 200 תעודת משלוח, 210 תעודת החזרה, 300 חשבון עסקה, 305 חשבונית מס, 320 חשבונית מס/קבלה, 330 חשבונית מס זיכוי, 400 קבלה, 405 קבלה על תרומה" } ] }, "description": "PUT /v1/businesses/{id}/sequences/{docType}" }, "response": [] }, { "name": "יומן שינויי מספר ההתחלה, מהישן לחדש", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/sequences/changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "sequences", "changes" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/sequences/changes" }, "response": [] } ] }, { "name": "Designs", "description": "עיצובים ומותגים", "item": [ { "name": "העיצובים (מותגים) של העסק, בלי הלוגו עצמו", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/designs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "designs" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/designs" }, "response": [] }, { "name": "עיצוב חדש (בעל העסק או מנהל)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/designs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "designs" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/designs" }, "response": [] }, { "name": "עיצוב מלא, כולל הלוגו (data URL)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/designs/:designId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "designs", ":designId" ], "variable": [ { "key": "designId", "value": "{{designId}}", "description": "מזהה עיצוב: dsg_ ו-20 תווים הקסדצימליים" } ] }, "description": "GET /v1/designs/{designId}" }, "response": [] }, { "name": "גרסה חדשה של העיצוב (שדה שלא נשלח נשאר)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/designs/:designId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "designs", ":designId" ], "variable": [ { "key": "designId", "value": "{{designId}}", "description": "מזהה עיצוב: dsg_ ו-20 תווים הקסדצימליים" } ] }, "description": "PUT /v1/designs/{designId}" }, "response": [] }, { "name": "קביעת עיצוב ברירת המחדל", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/designs/:designId/default", "host": [ "{{baseUrl}}" ], "path": [ "v1", "designs", ":designId", "default" ], "variable": [ { "key": "designId", "value": "{{designId}}", "description": "מזהה עיצוב: dsg_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/designs/{designId}/default" }, "response": [] }, { "name": "העברה לארכיון (לא את ברירת המחדל)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/designs/:designId/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "designs", ":designId", "archive" ], "variable": [ { "key": "designId", "value": "{{designId}}", "description": "מזהה עיצוב: dsg_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/designs/{designId}/archive" }, "response": [] }, { "name": "PDF לדוגמה בעיצוב, בלי לשמור (גוף ריק = העיצוב כפי שהוא; docType = סוג המסמך לדוגמה)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/designs/:designId/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "designs", ":designId", "preview" ], "variable": [ { "key": "designId", "value": "{{designId}}", "description": "מזהה עיצוב: dsg_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/designs/{designId}/preview" }, "response": [] }, { "name": "עיצוב ברירת המחדל (הנתיב מלפני 0.13)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/design", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "design" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/design" }, "response": [] }, { "name": "גרסה חדשה של עיצוב ברירת המחדל (הנתיב מלפני 0.13; שדה חסר מקבל ערך בסיסי)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"template\": \"classic\",\n \"accentColor\": \"\",\n \"footerText\": \"\",\n \"footerByType\": {},\n \"logo\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/design", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "design" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "PUT /v1/businesses/{id}/design" }, "response": [] }, { "name": "PDF לדוגמה בעיצוב שבגוף הבקשה (הנתיב מלפני 0.13)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/design/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "design", "preview" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/design/preview" }, "response": [] } ] }, { "name": "Customers", "description": "כרטיסי לקוח (מנוע 0.16)", "item": [ { "name": "כרטיסי הלקוח לפי שם, עם חיפוש (שם, ח\"פ, אימייל, טלפון, externalId) ועמודים", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "customers" ], "query": [ { "key": "q", "value": "", "description": "חיפוש חלקי", "disabled": true }, { "key": "sort", "value": "", "description": "newest: החדשים קודם (createdAt)", "disabled": true }, { "key": "since", "value": "", "description": "רק מה שנוצר אחרי הזמן הזה", "disabled": true }, { "key": "vatNumber", "value": "", "description": "ח\"פ מדויק (מנורמל ל-9 ספרות, מנוע 0.19)", "disabled": true }, { "key": "email", "value": "", "description": "אימייל מדויק, בלי הבדל אותיות (מנוע 0.19)", "disabled": true }, { "key": "externalId", "value": "", "description": "מזהה חיצוני מדויק (מנוע 0.19)", "disabled": true }, { "key": "archived", "value": "", "description": "פעילים (ברירת מחדל), בארכיון או הכול", "disabled": true }, { "key": "limit", "value": "", "description": "עד 200", "disabled": true }, { "key": "offset", "value": "", "description": "לעמוד הבא", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/customers" }, "response": [] }, { "name": "כרטיס לקוח חדש", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"עיריית רמלה\",\n \"vatNumber\": \"513746776\",\n \"email\": \"office@ramla.example\",\n \"phone\": \"08-0000000\",\n \"city\": \"רמלה\",\n \"externalId\": \"CRM-1042\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "customers" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/customers" }, "response": [] }, { "name": "יצירה מרובה (ייבוא), עם תוצאה לכל שורה; dryRun = רק בדיקה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/customers/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "customers", "bulk" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/customers/bulk" }, "response": [] }, { "name": "כרטיסים מהלקוחות שבמסמכים הקיימים, וקישור המסמכים (המסמכים לא משתנים)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dryRun\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/customers/import-from-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "customers", "import-from-documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/customers/import-from-documents" }, "response": [] }, { "name": "כרטיס לפי המזהה החיצוני (externalId)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/customers/external/:externalId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "customers", "external", ":externalId" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" }, { "key": "externalId", "value": "", "description": "המזהה החיצוני (externalId) של הכרטיס או הפריט, מקודד ל-URL" } ] }, "description": "GET /v1/businesses/{id}/customers/external/{externalId}" }, "response": [] }, { "name": "כרטיס לקוח, וסיכום המסמכים המקושרים אליו", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "מזהה כרטיס לקוח: cus_ ו-20 תווים הקסדצימליים" } ] }, "description": "GET /v1/customers/{customerId}" }, "response": [] }, { "name": "עדכון חלקי (רק השדות שנשלחו); מסמכים שכבר הופקו לא משתנים", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vatNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"address\": \"
\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "מזהה כרטיס לקוח: cus_ ו-20 תווים הקסדצימליים" } ] }, "description": "PATCH /v1/customers/{customerId}" }, "response": [] }, { "name": "מחיקה, רק של כרטיס שאף מסמך לא מקושר אליו (אחרת 409)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "מזהה כרטיס לקוח: cus_ ו-20 תווים הקסדצימליים" } ] }, "description": "DELETE /v1/customers/{customerId}" }, "response": [] }, { "name": "העברה לארכיון (לא יופקו לו מסמכים חדשים)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customerId/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId", "archive" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "מזהה כרטיס לקוח: cus_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/customers/{customerId}/archive" }, "response": [] }, { "name": "החזרה מהארכיון", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customerId/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customerId", "unarchive" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "מזהה כרטיס לקוח: cus_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/customers/{customerId}/unarchive" }, "response": [] } ] }, { "name": "Items", "description": "פריטים ומחירון (מנוע 0.16)", "item": [ { "name": "הפריטים (מחירון) לפי שם, עם חיפוש (שם, מק\"ט, תיאור, externalId) ועמודים", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "items" ], "query": [ { "key": "q", "value": "", "description": "חיפוש חלקי", "disabled": true }, { "key": "sort", "value": "", "description": "newest: החדשים קודם (createdAt)", "disabled": true }, { "key": "since", "value": "", "description": "רק מה שנוצר אחרי הזמן הזה", "disabled": true }, { "key": "sku", "value": "", "description": "מק\"ט מדויק (מנוע 0.19)", "disabled": true }, { "key": "archived", "value": "", "description": "פעילים (ברירת מחדל), בארכיון או הכול", "disabled": true }, { "key": "limit", "value": "", "description": "עד 200", "disabled": true }, { "key": "offset", "value": "", "description": "לעמוד הבא", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/items" }, "response": [] }, { "name": "פריט חדש במחירון", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"יום הפעלות\",\n \"sku\": \"ACT-1\",\n \"unitPrice\": 300000,\n \"description\": \"יום הפעלות בקליקרים\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "items" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/items\n\nהמחיר באגורות, לפני מע\"מ." }, "response": [] }, { "name": "יצירה מרובה של פריטים (ייבוא), עם תוצאה לכל שורה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "items", "bulk" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/items/bulk" }, "response": [] }, { "name": "פריט לפי המזהה החיצוני (externalId)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/items/external/:externalId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "items", "external", ":externalId" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" }, { "key": "externalId", "value": "", "description": "המזהה החיצוני (externalId) של הכרטיס או הפריט, מקודד ל-URL" } ] }, "description": "GET /v1/businesses/{id}/items/external/{externalId}" }, "response": [] }, { "name": "פריט", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "{{itemId}}", "description": "מזהה פריט: itm_ ו-20 תווים הקסדצימליים" } ] }, "description": "GET /v1/items/{itemId}" }, "response": [] }, { "name": "עדכון חלקי של פריט; מסמכים שכבר הופקו לא משתנים", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sku\": \"\",\n \"unitPrice\": 1,\n \"pricesIncludeVat\": false,\n \"unit\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "{{itemId}}", "description": "מזהה פריט: itm_ ו-20 תווים הקסדצימליים" } ] }, "description": "PATCH /v1/items/{itemId}" }, "response": [] }, { "name": "מחיקה, רק של פריט שאף שורה במסמך לא מפנה אליו (אחרת 409)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "{{itemId}}", "description": "מזהה פריט: itm_ ו-20 תווים הקסדצימליים" } ] }, "description": "DELETE /v1/items/{itemId}" }, "response": [] }, { "name": "העברה לארכיון", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/items/:itemId/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "items", ":itemId", "archive" ], "variable": [ { "key": "itemId", "value": "{{itemId}}", "description": "מזהה פריט: itm_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/items/{itemId}/archive" }, "response": [] }, { "name": "החזרה מהארכיון", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/items/:itemId/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "items", ":itemId", "unarchive" ], "variable": [ { "key": "itemId", "value": "{{itemId}}", "description": "מזהה פריט: itm_ ו-20 תווים הקסדצימליים" } ] }, "description": "POST /v1/items/{itemId}/unarchive" }, "response": [] } ] }, { "name": "Documents", "description": "הפקה, בדיקה בלי הפקה, תצוגה מקדימה כ-PDF, מקור, העתק ומספר הקצאה", "item": [ { "name": "הפקת חשבונית מס/קבלה (320)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"docType\": 320,\n \"customer\": {\n \"name\": \"משפחת כהן\",\n \"email\": \"cohen@example.com\"\n },\n \"lines\": [\n {\n \"description\": \"הפעלה בקליקרים\",\n \"quantity\": 1,\n \"unitPrice\": 90000\n }\n ],\n \"pricesIncludeVat\": true,\n \"payments\": [\n {\n \"method\": 4,\n \"amount\": 90000,\n \"paymentDate\": \"2026-11-01\"\n }\n ],\n \"shareLink\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/documents\n\nבלתי הפיך: המסמך מקבל את המספר הבא. סכומים באגורות (90000 = 900 ₪). shareLink: true מחזיר גם קישור ללקוח." }, "response": [] }, { "name": "בדיקה בלי הפקה (dryRun)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"docType\": 320,\n \"customer\": {\n \"name\": \"משפחת כהן\",\n \"email\": \"cohen@example.com\"\n },\n \"lines\": [\n {\n \"description\": \"הפעלה בקליקרים\",\n \"quantity\": 1,\n \"unitPrice\": 90000\n }\n ],\n \"pricesIncludeVat\": true,\n \"payments\": [\n {\n \"method\": 4,\n \"amount\": 90000,\n \"paymentDate\": \"2026-11-01\"\n }\n ],\n \"dryRun\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/documents\n\nאותן בדיקות ואותם סכומים, ושום דבר לא נשמר (200). מציגים למשתמש ומקבלים אישור לפני ההפקה." }, "response": [] }, { "name": "הפקת חשבונית מס (305) עם כרטיס לקוח ופריט", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"docType\": 305,\n \"customerId\": \"{{customerId}}\",\n \"lines\": [\n {\n \"itemSku\": \"ACT-1\",\n \"quantity\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/documents\n\ncustomerId ו-itemSku ממלאים את פרטי הלקוח, התיאור והמחיר מהכרטיס ומהמחירון." }, "response": [] }, { "name": "חשבונית מס זיכוי (330) על חשבונית", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"docType\": 330,\n \"base\": {\n \"docType\": 305,\n \"docNumber\": 60012\n },\n \"creditReason\": \"החזר על יום הפעלות שבוטל\",\n \"customer\": {\n \"name\": \"עיריית רמלה\",\n \"vatNumber\": \"513746776\"\n },\n \"lines\": [\n {\n \"description\": \"זיכוי יום הפעלות\",\n \"quantity\": 1,\n \"unitPrice\": 300000\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/documents\n\nתיקון של חשבונית שהופקה: זיכוי עם base (סוג ומספר המסמך המקורי) וסיבה." }, "response": [] }, { "name": "רשימת מסמכים, מהחדש לישן", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "documents" ], "query": [ { "key": "from", "value": "", "description": "מתאריך (כולל), ברירת מחדל 1900-01-01", "disabled": true }, { "key": "to", "value": "", "description": "עד תאריך (כולל), ברירת מחדל 2999-12-31", "disabled": true }, { "key": "docType", "value": "", "description": "רק סוג מסמך אחד", "disabled": true }, { "key": "customerKey", "value": "", "description": "רק לקוח אחד (customer.key)", "disabled": true }, { "key": "customerId", "value": "", "description": "רק המסמכים שמקושרים לכרטיס הלקוח (מנוע 0.16)", "disabled": true }, { "key": "sinceId", "value": "", "description": "רק מסמכים שהמזהה שלהם גדול מזה (סקירה בתדירות, מנוע 0.19)", "disabled": true }, { "key": "docNumber", "value": "", "description": "מספר המסמך (עם docType: מסמך אחד; מנוע 0.19)", "disabled": true }, { "key": "limit", "value": "", "description": "עד 1,000", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/documents" }, "response": [] }, { "name": "תצוגה מקדימה כ-PDF", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"docType\": 320,\n \"customer\": {\n \"name\": \"משפחת כהן\",\n \"email\": \"cohen@example.com\"\n },\n \"lines\": [\n {\n \"description\": \"הפעלה בקליקרים\",\n \"quantity\": 1,\n \"unitPrice\": 90000\n }\n ],\n \"pricesIncludeVat\": true,\n \"payments\": [\n {\n \"method\": 4,\n \"amount\": 90000,\n \"paymentDate\": \"2026-11-01\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/documents/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "documents", "preview" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/documents/preview\n\nה-PDF בדיוק כפי שהמסמך יופק, עם סימן מים, ושום דבר לא נשמר." }, "response": [] }, { "name": "כל פרטי המסמך", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "GET /v1/documents/{docId}" }, "response": [] }, { "name": "רישום מספר הקצאה מרשות המסים (9 עד 30 ספרות). בלתי הפיך", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allocationNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/documents/:docId/allocation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "allocation" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "POST /v1/documents/{docId}/allocation" }, "response": [] }, { "name": "מקור להדפסה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"computerized\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/documents/:docId/original", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "original" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "POST /v1/documents/{docId}/original\n\nהמקור מופק פעם אחת. computerized: true = מקור ממוחשב חתום." }, "response": [] }, { "name": "העתק (PDF). כל הורדה נרשמת ויוצרת document.copy_produced", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId/copy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "copy" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "GET /v1/documents/{docId}/copy" }, "response": [] } ] }, { "name": "Share links", "description": "קישורי שיתוף למסמכים (נפתחים בלי התחברות)", "item": [ { "name": "קישור שיתוף למסמך (30 יום)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiresInDays\": 30\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/documents/:docId/share-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "share-links" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "POST /v1/documents/{docId}/share-links\n\nהכתובת (/s/) מוחזרת פעם אחת; נפתחת בלי התחברות." }, "response": [] }, { "name": "קישורי השיתוף של המסמך, מהחדש לישן, עם מספר הפתיחות (בלי הכתובות)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId/share-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "share-links" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "GET /v1/documents/{docId}/share-links" }, "response": [] }, { "name": "פרטי קישור ופתיחותיו האחרונות (בלי כתובות IP)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/share-links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "share-links", ":linkId" ], "variable": [ { "key": "linkId", "value": "{{linkId}}", "description": "מזהה הקישור: shl_ (שיתוף) או cnl_ (אישור הסכמה) ו-20 תווים הקסדצימליים" } ] }, "description": "GET /v1/share-links/{linkId}" }, "response": [] }, { "name": "ביטול קישור: מפסיק לעבוד מיד, והרשומה נשארת. קריאה חוזרת לא משנה דבר", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/share-links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "share-links", ":linkId" ], "variable": [ { "key": "linkId", "value": "{{linkId}}", "description": "מזהה הקישור: shl_ (שיתוף) או cnl_ (אישור הסכמה) ו-20 תווים הקסדצימליים" } ] }, "description": "DELETE /v1/share-links/{linkId}" }, "response": [] }, { "name": "ציבורי, בלי טוקן: מה שדף השיתוף מציג (שם העסק, סוג המסמך ומספרו)", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/share/:token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "share", ":token" ], "variable": [ { "key": "token", "value": "", "description": "הטוקן מקישור ההזמנה (/invite/), או של קישור שיתוף (/s/)" } ] }, "description": "GET /v1/share/{token}\n\nהטוקן שבנתיב הוא ההרשאה. Cache-Control: no-store ו-X-Robots-Tag: noindex. 404 לטוקן לא מוכר, 410 לקישור שבוטל או פג. מגבלת קצב: 429." }, "response": [] }, { "name": "ציבורי, בלי טוקן: ה-PDF – המקור החתום רק כשהכללים מתירים, אחרת העתק. כל הורדה נרשמת", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/share/:token/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "share", ":token", "pdf" ], "variable": [ { "key": "token", "value": "", "description": "הטוקן מקישור ההזמנה (/invite/), או של קישור שיתוף (/s/)" } ] }, "description": "GET /v1/share/{token}/pdf\n\nהמקור הממוחשב החתום מוגש רק כשכבר הופק ללקוח שההחלטה האחרונה שלו היא הסכמה (הצעת מחיר: בלי הסכמה); בכל מקרה אחר העתק, שנרשם ביומן המסמך (copy_produced). X-Share-Served: original | copy." }, "response": [] } ] }, { "name": "Events", "description": "יומני אירועים", "item": [ { "name": "יומן הפעולות על המסמך", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "events" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "GET /v1/documents/{docId}/events" }, "response": [] }, { "name": "יומן האירועים של כל העסק, לפי הסדר (לחיבור שבודק מה חדש)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "events" ], "query": [ { "key": "after", "value": "", "description": "רק אירועים אחרי המזהה הזה (next מהעמוד הקודם)", "disabled": true }, { "key": "limit", "value": "", "description": "עד 500", "disabled": true }, { "key": "event", "value": "", "description": "רק סוג אירוע אחד (מנוע 0.19)", "disabled": true }, { "key": "order", "value": "", "description": "desc: מהחדש לישן, לסקירה בתדירות (מנוע 0.19)", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/events" }, "response": [] } ] }, { "name": "Consents", "description": "הסכמת לקוחות למסמכים ממוחשבים", "item": [ { "name": "קישור אישור ללקוח (/c/): הלקוח מאשר או מבטל בעצמו, והראיה נרשמת", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customerKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/consent-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "consent-links" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/consent-links" }, "response": [] }, { "name": "קישורי האישור של העסק (או של לקוח אחד), בלי הכתובות", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/consent-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "consent-links" ], "query": [ { "key": "customerKey", "value": "", "description": "רק לקוח אחד", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/consent-links" }, "response": [] }, { "name": "ביטול קישור אישור (ההחלטות שנרשמו נשארות)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/consent-links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consent-links", ":linkId" ], "variable": [ { "key": "linkId", "value": "{{linkId}}", "description": "מזהה הקישור: shl_ (שיתוף) או cnl_ (אישור הסכמה) ו-20 תווים הקסדצימליים" } ] }, "description": "DELETE /v1/consent-links/{linkId}" }, "response": [] }, { "name": "ציבורי: דף ההסכמה – שם העסק, הנוסח המדויק וההחלטה האחרונה", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/consent/:token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consent", ":token" ], "variable": [ { "key": "token", "value": "", "description": "הטוקן מקישור ההזמנה (/invite/), או של קישור שיתוף (/s/)" } ] }, "description": "GET /v1/consent/{token}" }, "response": [] }, { "name": "ציבורי: הלקוח מאשר (grant) או מבטל (revoke); נרשם עם הראיה", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"decision\": \"grant\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/consent/:token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consent", ":token" ], "variable": [ { "key": "token", "value": "", "description": "הטוקן מקישור ההזמנה (/invite/), או של קישור שיתוף (/s/)" } ] }, "description": "POST /v1/consent/{token}" }, "response": [] }, { "name": "רישום הסכמת לקוח לקבל מסמכים ממוחשבים (הוראה 18ב(ג))", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customerKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/consents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "consents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/consents" }, "response": [] }, { "name": "האם ההחלטה האחרונה של הלקוח היא הסכמה", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/consents/:customerKey", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "consents", ":customerKey" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" }, { "key": "customerKey", "value": "", "description": "מפתח הלקוח (customer.key) שבו נרשמה ההסכמה" } ] }, "description": "GET /v1/businesses/{id}/consents/{customerKey}" }, "response": [] } ] }, { "name": "Open format", "description": "מבנה אחיד", "item": [ { "name": "קבצים במבנה אחיד (ZIP), או סיכום ב-?format=json", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"2026-11-01\",\n \"to\": \"2026-11-01\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/openformat", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "openformat" ], "query": [ { "key": "format", "value": "", "description": "json = רק הסיכום", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/openformat" }, "response": [] } ] }, { "name": "Archive", "description": "ייצוא מלא", "item": [ { "name": "ייצוא מלא (ZIP): מקורות, מבנה אחיד לכל שנה, רשימות, יומן ותעודות", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "archive" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/archive" }, "response": [] } ] }, { "name": "Team", "description": "משתמשים בעסק והזמנות", "item": [ { "name": "משתמשי העסק וההזמנות הפתוחות (בעל העסק)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/members", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "members" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/members" }, "response": [] }, { "name": "הזמנה לעסק (רק בכניסה עם סיסמה)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\",\n \"role\": \"owner\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/invitations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "invitations" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/invitations" }, "response": [] }, { "name": "ביטול הזמנה", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/invitations/:invitationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "invitations", ":invitationId" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" }, { "key": "invitationId", "value": "", "description": "מזהה ההזמנה" } ] }, "description": "DELETE /v1/businesses/{id}/invitations/{invitationId}" }, "response": [] }, { "name": "הסרת משתמש מהעסק (לא בעל העסק האחרון)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/members/:userId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "members", ":userId" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" }, { "key": "userId", "value": "", "description": "מזהה המשתמש (UUID)" } ] }, "description": "DELETE /v1/businesses/{id}/members/{userId}" }, "response": [] }, { "name": "פרטי הזמנה (משתמש מחובר)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/invitations/:token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invitations", ":token" ], "variable": [ { "key": "token", "value": "", "description": "הטוקן מקישור ההזמנה (/invite/), או של קישור שיתוף (/s/)" } ] }, "description": "GET /v1/invitations/{token}" }, "response": [] }, { "name": "הצטרפות לעסק (רק המשתמש עם האימייל שהוזמן)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/invitations/:token/accept", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invitations", ":token", "accept" ], "variable": [ { "key": "token", "value": "", "description": "הטוקן מקישור ההזמנה (/invite/), או של קישור שיתוף (/s/)" } ] }, "description": "POST /v1/invitations/{token}/accept" }, "response": [] } ] }, { "name": "API keys", "description": "מפתחות API של עסק (iek_)", "item": [ { "name": "מפתחות ה-API של העסק (בלי המפתחות עצמם)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "api-keys" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/api-keys" }, "response": [] }, { "name": "מפתח API חדש (iek_), רק בכניסה עם סיסמה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "api-keys" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/api-keys" }, "response": [] }, { "name": "ביטול מפתח API", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/api-keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "", "description": "מזהה מפתח ה-API" } ] }, "description": "DELETE /v1/api-keys/{keyId}" }, "response": [] } ] }, { "name": "Signing", "description": "מפתח החתימה: כברירת מחדל שמור בשרת והחתימה אוטומטית. מתקדם: קוד חתימה אישי, האצלה למפתח API או לטוקן, חזרה לחתימה אוטומטית והחלפת מפתח", "item": [ { "name": "מפתח ותעודת חתימה חדשים (החלפת מפתח). בלי pin (ברירת המחדל): המפתח החדש נשמר בשרת והחתימה אוטומטית – גם הדרך כששכחו את קוד החתימה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pin\": \"\",\n \"currentPassword\": \"\",\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/signing-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "signing-keys" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/signing-keys\n\nמסמכים קודמים נשארים חתומים ומאומתים בתעודה הקודמת. בלי pin: המפתח החדש מוצפן בשרת (חתימה אוטומטית, בלי קוד ובלי האצלות). בעסק שאין לו קוד – מנהל העסק (manage); בעסק שקבע קוד חתימה, יצירת מפתח בלי קוד מסירה את השליטה הבלעדית, ולכן רק בעל העסק בכניסה עם סיסמה ועם currentPassword. עם pin: המפתח החדש נעטף רק בקוד החדש (בעל העסק, עם currentPassword). כשמדיניות המערכת דורשת קוד – רק עם pin, אחרת 422 עם signingError: policy_requires_pin. ההחלפה מוחקת את ההאצלות של המפתחות הקודמים, והמפתחות הקודמים נשארים כמו שהם." }, "response": [] }, { "name": "מצב מפתח החתימה: platform (ברירת המחדל – המפתח שמור בשרת והחתימה אוטומטית) או pin (קוד חתימה אישי, אפשרות מתקדמת), מתי נקבע הקוד, ההאצלות והיומן. הקוד עצמו לא נשמר ולא מוחזר", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/signing", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "signing" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/signing\n\nכל מי שיש לו גישת צפייה רואה את מצב ההגנה; ההאצלות והיומן רק למי שמנהל את העסק (אחרת רשימות ריקות)." }, "response": [] }, { "name": "מתקדם: קביעת קוד חתימה אישי (או החלפה עם currentPin). בפעם הראשונה העותק בשרת (סיסמת המערכת) נמחק מכל המפתחות של העסק, ומאז מפתח API או טוקן חותמים רק עם האצלה. רק בעל העסק, בכניסה עם סיסמה", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pin\": \"\",\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/signing/pin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "signing", "pin" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "PUT /v1/businesses/{id}/signing/pin\n\nלא נחוץ לשימוש רגיל: בלי קוד המפתח שמור בשרת והחתימה אוטומטית. עם קוד, המפתח הפרטי נעטף מחדש במפתח שנגזר מהקוד (PBKDF2-SHA256, 600,000 סבבים, מלח לכל מפתח; AES-256-GCM). העטיפה נבדקת לפני שהעותק הישן נמחק. הקוד לא נשמר בשום מקום ואי אפשר לשחזר אותו: חוזרים לחתימה אוטומטית עם הקוד (DELETE .../signing/pin), ומי ששכח יוצר מפתח חדש בחתימה אוטומטית (POST .../signing-keys בלי pin). 8 תווים לפחות, לא סיסמת החשבון." }, "response": [] }, { "name": "חזרה לחתימה אוטומטית: עם קוד החתימה הנוכחי, המפתח נשמר שוב בשרת, הקוד וההאצלות נמחקים. רק בעל העסק, בכניסה עם סיסמה", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pin\": \"\",\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/signing/pin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "signing", "pin" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "DELETE /v1/businesses/{id}/signing/pin\n\nכל מפתח של העסק שנעול בקוד הזה נעטף שוב בסיסמת המערכת והעטיפה בקוד נמחקת; המפתח והתעודה לא משתנים. ההאצלות של העסק נמחקות (מעכשיו כל מפתח API וטוקן שמפיקים בעסק חותמים בלי האצלה), ונרשם pin_removed ביומן – הכל בטרנזקציה אחת. קוד שגוי: 403 (pin_invalid), ואחרי 5 ניסיונות כושלים חסימה לרבע שעה (429, pin_locked), כמו בחתימה. לעסק אין קוד: 409 (pin_not_set). מדיניות המערכת דורשת קוד: 409 (policy_requires_pin)." }, "response": [] }, { "name": "האצלת חתימה למפתח API של העסק או לטוקן גישה אישי (גם של חיבור MCP): המפתח נעטף במפתח שנגזר מהסוד המלא. בעל העסק, עם קוד החתימה והסיסמה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credential\": \"\",\n \"pin\": \"\",\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/signing/delegations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "signing", "delegations" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/signing/delegations\n\ncredential הוא הסוד המלא (iek_... או iep_...). הסוד לא נשמר (רק ה-hash שלו, שכבר קיים), ולכן השרת לבדו לא פותח את העטיפה: רק בקשה שמגיעה עם הסוד. ביטול המפתח או הטוקן (או שינוי הסיסמה של בעל הטוקן) מוחק את ההאצלה." }, "response": [] }, { "name": "ביטול האצלת חתימה: העטיפה נמחקת, והמפתח או הטוקן ממשיכים לעבוד אבל לא חותמים", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/signing-delegations/:delegationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "signing-delegations", ":delegationId" ], "variable": [ { "key": "delegationId", "value": "", "description": "מזהה האצלת החתימה (UUID)" } ] }, "description": "DELETE /v1/signing-delegations/{delegationId}" }, "response": [] } ] }, { "name": "Webhooks", "description": "הודעות על אירועים", "item": [ { "name": "ה-webhooks של העסק, סוגי האירועים, המגבלות וההיסטוריה (בעל העסק)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "webhooks" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/webhooks" }, "response": [] }, { "name": "webhook חדש (בעל העסק בכניסה עם סיסמה, ועם הסיסמה שוב)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "webhooks" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/webhooks" }, "response": [] }, { "name": "נקודת קצה", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId" ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "GET /v1/webhooks/{endpointId}" }, "response": [] }, { "name": "שינוי: תיאור, אירועים, השהיה/הפעלה, כתובת או טוקן", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"document.issued\"\n ],\n \"enabled\": false,\n \"url\": \"https://example.com\",\n \"routineToken\": \"\",\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId" ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "PATCH /v1/webhooks/{endpointId}\n\nהשהיה וצמצום מותרים גם בטוקן גישה אישי. הפעלה מחדש, הוספת אירוע, כתובת וטוקן: בכניסה עם סיסמה ועם currentPassword. אם ה-webhook השתנה בינתיים כך שנדרש אימות: 409." }, "response": [] }, { "name": "מחיקה סופית, עם המשלוחים. בלתי הפיך", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId" ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "DELETE /v1/webhooks/{endpointId}" }, "response": [] }, { "name": "הכתובת המלאה, עם הפרמטרים (עם הסיסמה שוב)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId/reveal-url", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId", "reveal-url" ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "POST /v1/webhooks/{endpointId}/reveal-url" }, "response": [] }, { "name": "סוד חתימה חדש (רק standard; עם הסיסמה שוב)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId", "rotate-secret" ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "POST /v1/webhooks/{endpointId}/rotate-secret" }, "response": [] }, { "name": "הודעת בדיקה (webhook.test), עד 5 בשעה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId", "test" ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "POST /v1/webhooks/{endpointId}/test" }, "response": [] }, { "name": "המשלוחים, מהחדש לישן", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:endpointId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":endpointId", "deliveries" ], "query": [ { "key": "status", "value": "", "description": "רק משלוחים במצב הזה", "disabled": true }, { "key": "before", "value": "", "description": "next מהעמוד הקודם", "disabled": true }, { "key": "limit", "value": "", "description": "עד 200", "disabled": true } ], "variable": [ { "key": "endpointId", "value": "", "description": "מזהה ה-webhook (UUID)" } ] }, "description": "GET /v1/webhooks/{endpointId}/deliveries" }, "response": [] }, { "name": "שליחה חוזרת של משלוח שנכשל או בוטל (עד 50 בשעה)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhook-deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook-deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "deliveryId", "value": "", "description": "מזהה המשלוח" } ] }, "description": "POST /v1/webhook-deliveries/{deliveryId}/retry" }, "response": [] } ] }, { "name": "Integrations", "description": "מינויי אוטומציה ל-Zapier ול-Make (REST hooks, מנוע 0.19)", "item": [ { "name": "מינויי Zapier ו-Make של העסק, הכתובות המותרות והמגבלה", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/integration-hooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "integration-hooks" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/integration-hooks" }, "response": [] }, { "name": "מינוי (REST hook) של Zapier או Make, במפתח API או בטוקן גישה, רק לכתובות של הפלטפורמה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"platform\": \"zapier\",\n \"url\": \"https://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/integration-hooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "integration-hooks" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/integration-hooks\n\nמפתח API של העסק (iek_) או טוקן גישה אישי (iep_) של בעל העסק או עובד. הכתובת רק ברשימת ההיתר: hooks.zapier.com; hook.<אזור>.make.com, hook.integromat.com, *.make.com. המינוי קשור למפתח או לטוקן ונמחק בביטולם. אותה כתובת שוב באותו אישור: 200 עם הקיים." }, "response": [] }, { "name": "ביטול מינוי (מי שמפיק בעסק)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/integration-hooks/:hookId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "integration-hooks", ":hookId" ], "variable": [ { "key": "hookId", "value": "", "description": "מזהה מינוי Zapier / Make (UUID)" } ] }, "description": "DELETE /v1/integration-hooks/{hookId}" }, "response": [] } ] }, { "name": "Platform", "description": "ניהול מערכת: מנהלי פלטפורמה (בכניסה עם סיסמה) וטוקן המנהל", "item": [ { "name": "כל העסקים במערכת (מנהל פלטפורמה בכניסה עם סיסמה, או טוקן המנהל)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/platform/businesses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "businesses" ], "query": [ { "key": "q", "value": "", "description": "חיפוש בשם העסק, במספר העוסק ובאימייל של בעל העסק", "disabled": true }, { "key": "limit", "value": "", "description": "ברירת מחדל 50", "disabled": true }, { "key": "offset", "value": "", "description": "ברירת מחדל 0", "disabled": true } ] }, "description": "GET /v1/platform/businesses" }, "response": [] }, { "name": "מצב מסמכים אמיתיים בידי מנהל פלטפורמה (הערה חובה ואימות מחדש)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/platform/businesses/:id/real-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "businesses", ":id", "real-documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "PUT /v1/platform/businesses/{id}/real-documents" }, "response": [] }, { "name": "יומן המעברים בין מצב הדגמה למסמכים אמיתיים", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/platform/businesses/:id/mode-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "businesses", ":id", "mode-changes" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/platform/businesses/{id}/mode-changes" }, "response": [] }, { "name": "תקרות עוסק פטור ועסק זעיר לכל שנה, מה בתוקף היום (שיעור המע\"מ וסף ההקצאה מהקוד, לקריאה בלבד), האם צריך תזכורת שנתית, והיומן", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/platform/annual-parameters", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "annual-parameters" ] }, "description": "GET /v1/platform/annual-parameters" }, "response": [] }, { "name": "שמירה ואישור של התקרות לשנה (נרשם ביומן). מנהל פלטפורמה עם currentPassword (וקוד דו-שלבי), או טוקן המנהל", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"exemptCeilingAgorot\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/platform/annual-parameters/:year", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "annual-parameters", ":year" ], "variable": [ { "key": "year", "value": "", "description": "השנה (4 ספרות)" } ] }, "description": "PUT /v1/platform/annual-parameters/{year}" }, "response": [] }, { "name": "מדיניות החתימה של הפלטפורמה: האם מקור ממוחשב מחייב קוד חתימה של העסק (ברירת מחדל: לא), ויומן השינויים", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/platform/signing-policy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "signing-policy" ] }, "description": "GET /v1/platform/signing-policy" }, "response": [] }, { "name": "שינוי המדיניות: requirePin. מנהל פלטפורמה עם currentPassword (וקוד דו-שלבי), או טוקן המנהל. נרשם ביומן", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"requirePin\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/platform/signing-policy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "signing-policy" ] }, "description": "PUT /v1/platform/signing-policy" }, "response": [] } ] }, { "name": "Tax authority", "description": "חיבור לרשות המסים (מנוע 0.17): OAuth לכל עסק, מספרי הקצאה, תרומות, סעיף 46 ושידור המבנה האחיד", "item": [ { "name": "פרטי האפליקציה בפורטל המפתחים של רשות המסים, בלי הסוד (מנהל פלטפורמה או טוקן המנהל)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/platform/ita", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "ita" ] }, "description": "GET /v1/platform/ita" }, "response": [] }, { "name": "שמירת פרטי האפליקציה (כותב בלבד; הסוד לא חוזר). מנהל פלטפורמה עם currentPassword, או טוקן המנהל", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"environment\": \"sandbox\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"redirectUri\": \"\",\n \"scope\": \"\",\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/platform/ita", "host": [ "{{baseUrl}}" ], "path": [ "v1", "platform", "ita" ] }, "description": "PUT /v1/platform/ita" }, "response": [] }, { "name": "מצב החיבור של העסק לרשות המסים (ולעמותה גם תוקף סעיף 46)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/ita" }, "response": [] }, { "name": "ניתוק העסק מרשות המסים (הטוקנים נמחקים)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "DELETE /v1/businesses/{id}/ita" }, "response": [] }, { "name": "התחלת התחברות: כתובת ההזדהות ברשות המסים עם state לעשר דקות (בעל העסק בכניסה עם סיסמה, מהאתר)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/connect", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "connect" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/ita/connect" }, "response": [] }, { "name": "סיום התחברות: code ו-state מהדף /ita/callback; ההחלפה בטוקנים בשרת", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ita/callback", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ita", "callback" ] }, "description": "POST /v1/ita/callback" }, "response": [] }, { "name": "יומן החיבור: התחברות, חידוש, ניתוק (בלי טוקנים)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/log", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "log" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/ita/log" }, "response": [] }, { "name": "מה ממתין לרשות המסים: חשבוניות בלי מספר הקצאה וקבלות על תרומה שלא דווחו", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "pending" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/ita/pending" }, "response": [] }, { "name": "מצב המסמך מול רשות המסים: מספר הקצאה, עיכוב והחלטה, דיווח תרומה, וכל הפניות", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId/ita", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "ita" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "GET /v1/documents/{docId}/ita" }, "response": [] }, { "name": "בקשת מספר הקצאה (Approval v2) לחשבונית שכבר הופקה וממתינה לו", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId/ita/allocation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "ita", "allocation" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "POST /v1/documents/{docId}/ita/allocation" }, "response": [] }, { "name": "החלטה על חשבונית שעוכבה (460/461): cancel, continue או further_objection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"decision\": \"cancel\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/documents/:docId/ita/decision", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "ita", "decision" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "POST /v1/documents/{docId}/ita/decision" }, "response": [] }, { "name": "פרטי חשבונית שהעסק קיבל, לפי מספר ההקצאה שעליה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"confirmationNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/invoice-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "invoice-information" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/ita/invoice-information" }, "response": [] }, { "name": "מספר ההקצאה של חשבונית שהעסק קיבל, לפי פרטיה", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"supplierVatNumber\": \"\",\n \"paymentAmount\": 1,\n \"vatAmount\": 1,\n \"invoiceDate\": \"2026-11-01\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/confirmation-number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "confirmation-number" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/ita/confirmation-number" }, "response": [] }, { "name": "דיווח קבלה על תרומה (Donations/v1/Report) של עמותה עם סעיף 46", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/documents/:docId/ita/donation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":docId", "ita", "donation" ], "variable": [ { "key": "docId", "value": "{{documentId}}", "description": "המזהה הפנימי של המסמך (id, לא מספר המסמך)" } ] }, "description": "POST /v1/documents/{docId}/ita/donation" }, "response": [] }, { "name": "דיווח מרוכז (MultiReport) של כל הקבלות שממתינות", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/donations/report-pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "donations", "report-pending" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/ita/donations/report-pending" }, "response": [] }, { "name": "בדיקת תוקף אישור סעיף 46 של העמותה (Charity/v1/check46Clause)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/section46-check", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "section46-check" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/ita/section46-check" }, "response": [] }, { "name": "הפקת קובץ המבנה האחיד לתקופה ושידורו לרשות המסים (תוספת מס' 1)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"2026-11-01\",\n \"to\": \"2026-11-01\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/transmissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "transmissions" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "POST /v1/businesses/{id}/ita/transmissions" }, "response": [] }, { "name": "יומן השידורים של העסק", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/businesses/:id/ita/transmissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "ita", "transmissions" ], "query": [ { "key": "limit", "value": "", "description": "כמה (ברירת מחדל 20)", "disabled": true } ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "GET /v1/businesses/{id}/ita/transmissions" }, "response": [] }, { "name": "שידור אחד", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/ita/transmissions/:transmissionId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ita", "transmissions", ":transmissionId" ], "variable": [ { "key": "transmissionId", "value": "", "description": "מזהה השידור לרשות המסים (UUID)" } ] }, "description": "GET /v1/ita/transmissions/{transmissionId}" }, "response": [] }, { "name": "בדיקת הסטטוס ברשות המסים עכשיו (get-file-status)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/ita/transmissions/:transmissionId/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ita", "transmissions", ":transmissionId", "refresh" ], "variable": [ { "key": "transmissionId", "value": "", "description": "מזהה השידור לרשות המסים (UUID)" } ] }, "description": "POST /v1/ita/transmissions/{transmissionId}/refresh" }, "response": [] } ] }, { "name": "Admin", "description": "פעולות של טוקן המנהל", "item": [ { "name": "איפוס סיסמה למשתמש (מנהל)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "password" ] }, "description": "PUT /v1/users/password" }, "response": [] }, { "name": "כיבוי אימות דו-שלבי למשתמש (מנהל)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/two-factor", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "two-factor" ] }, "description": "DELETE /v1/users/two-factor" }, "response": [] }, { "name": "ביטול כל טוקני הגישה של משתמש (מנהל)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/tokens", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "tokens" ] }, "description": "DELETE /v1/users/tokens" }, "response": [] }, { "name": "הענקה או ביטול של מנהל פלטפורמה (רק טוקן המנהל)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"name@example.com\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/platform-admin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "platform-admin" ] }, "description": "PUT /v1/users/platform-admin" }, "response": [] }, { "name": "ספר הלקוחות של היצרן (נספח ה'(ה))", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/admin/customer-register", "host": [ "{{baseUrl}}" ], "path": [ "v1", "admin", "customer-register" ] }, "description": "GET /v1/admin/customer-register" }, "response": [] }, { "name": "מצב מסמכים אמיתיים (רק טוקן המנהל)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/businesses/:id/real-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "businesses", ":id", "real-documents" ], "variable": [ { "key": "id", "value": "{{businessId}}", "description": "מזהה העסק (UUID)" } ] }, "description": "PUT /v1/businesses/{id}/real-documents" }, "response": [] }, { "name": "שמירת פרטי האפליקציה של רשות המסים בטוקן המנהל (כמו PUT /v1/platform/ita)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"environment\": \"sandbox\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"redirectUri\": \"\",\n \"scope\": \"\",\n \"currentPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/admin/ita-app", "host": [ "{{baseUrl}}" ], "path": [ "v1", "admin", "ita-app" ] }, "description": "PUT /v1/admin/ita-app" }, "response": [] } ] } ] }