> For the complete documentation index, see [llms.txt](https://invoice4u.gitbook.io/invoice4u-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://invoice4u.gitbook.io/invoice4u-docs/he/documents/create-document.md). # יצירת מסמך ‫יוצר מסמך חתום וממוספר. זוהי המתודה המרכזית של ה-API.‬ ## ‫מתודה‬ | | | | ----------- | --------------------------------------------- | | ‫**מתודה**‬ | `POST` | | ‫**נתיב**‬ | `/CreateDocument` | | ‫**תשובה**‬ | ‫אובייקט `Document` — בדקו את `Errors` תחילה‬ | ‫וריאציות:‬ | ‫נתיב‬ | ‫מתודה‬ | ‫הערות‬ | | ----------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | | `/CreateDocument` | POST | ‫הסטנדרטי.‬ | | `/CreateDocumentREST` | GET/POST | ‫וריאציית REST מפורשת, אותו גוף.‬ | | `/CreateDocumentWithIdentifierValidation` | POST | ‫דוחה כפילויות לפי `ApiIdentifier` — ראו [עמוד ייעודי](/invoice4u-docs/he/documents/create-document-with-validation.md).‬ | ## ‫סכימת הבקשה‬ | ‫שדה‬ | ‫טיפוס‬ | ‫חובה‬ | ‫תיאור‬ | | ------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `doc` | Document | ‫כן‬ | ‫המסמך ליצירה. ראו [אובייקט המסמך](/invoice4u-docs/he/documents/document-object.md) ודרישות פר סוג ב[סוגי מסמכים](/invoice4u-docs/he/documents/document-types.md).‬ | | `token` | string | ‫כן‬ | ‫טוקן אימות.‬ | ## ‫דוגמת בקשה — חשבונית מס קבלה (סוג 3)‬ ```http POST /Services/ApiService.svc/CreateDocument HTTP/1.1 Host: apiqa.invoice4u.co.il Content-Type: application/json { "doc": { "DocumentType": 3, "Subject": "Monthly subscription", "ClientID": 88231, "TaxIncluded": true, "Currency": "ILS", "ApiIdentifier": "my-system-order-10045", "Items": [ { "Name": "Pro plan - June", "Quantity": 1, "Price": 117.00, "PriceIncludeTax": 117.00 } ], "Payments": [ { "PaymentType": 1, "Amount": 117.00, "Date": "2026-07-05T00:00:00", "NumberOfPayments": 1, "PaymentNumber": "4242" } ], "AssociatedEmails": [ { "Mail": "billing@acme.example", "IsUserMail": false } ] }, "token": "" } ``` ## ‫דוגמת תשובה‬ ```json { "CreateDocumentResult": { "ID": "7f6a2c1e-8b4d-4f2a-9c3e-0d1e2f3a4b5c", "DocumentNumber": 20260123, "DocumentType": 3, "Subject": "Monthly subscription", "Total": 117.0, "TotalWithoutTax": 100.0, "TotalTaxAmount": 17.0, "StatusID": 2, "ApiIdentifier": "my-system-order-10045", "PrintOriginalPDFLink": "https://newview.invoice4u.co.il/Views/PDF.aspx?cipher=...", "PrintCertifiedCopyPDFLink": "https://newview.invoice4u.co.il/Views/PDF.aspx?cipher=...", "Errors": [] } } ``` {% hint style="info" %} ‫ב-QA קישורי ה-PDF מפנים ל-`newviewqa.invoice4u.co.il`; בפרודקשן ל-`newview.invoice4u.co.il`.‬ {% endhint %} ## ‫הערות התנהגות‬ * ‫**הסכומים מחושבים בצד השרת** מתוך `Items` (סוגים מבוססי פריטים) או `Payments` (+`Deduction`) — אתם לא שולחים `Total`.‬ * ‫ב**חשבונית מס קבלה**, סכום התשלומים חייב להיות שווה לסכום הפריטים (פער עיגול של ±0.01 ניתן לתיקון אוטומטי — ראו `AutoFixPaymentsMismatchItems` ב[אובייקט המסמך](/invoice4u-docs/he/documents/document-object.md)). אי-התאמה ← `PaymentAmountDoesntMatchItemsAmount` (56) עם `OpenInfo.PaymentMismatchDelta`.‬ * ‫**משלוח אימייל** מתבצע אוטומטית כאשר `AssociatedEmails` מוגדר; **משלוח SMS** כאשר `SmsMessages` מוגדר.‬ * ‫ארגונים המחוברים ל-**2Sign** עם תהליכי מסמכים לחתימה מקבלים את המסמך כמשימת חתימה במקום אימייל רגיל.‬ * ‫חלון כפילויות: מסמך זהה בתוך `ApiDuplicityTimeValidation` שניות (ברירת מחדל 60) ← `DocumentAlreadyCreated` (134).‬ ## ‫מסמכים במטבע חוץ‬ ‫תשובות לשאלות שעולות הכי הרבה כשצריך להפיק מסמך במטבע חוץ (למשל `USD`) במקום במטבע הבסיס של הארגון.‬ **‫האם ניתן להפיק מסמך בתצורת מטבע חוץ (USD, ללא המרה ל-ILS) דרך ה-API?‬** ‫כן. הגדירו את `Currency` באובייקט [המסמך](/invoice4u-docs/he/documents/document-object.md) לסימול ה-ISO הרצוי (למשל `"USD"`). המסמך נוצר ונשמר במלואו באותו מטבע — `Items`, `Payments` והתוצאה `Total`/`TotalWithoutTax`/`TotalTaxAmount` כולם ב-USD, לא ב-ILS. ה-API אף פעם לא ממיר את הסכומים ששלחתם בשקט.‬ **‫אילו שדות נדרשים בדיוק? (Currency="USD", ConversionRate=<שער>, ואיזה ערך נדרש ל-ConvertToILS או לשדה אחר?)‬** ‫רק `Currency` נדרש כדי להפיק מסמך במטבע חוץ:‬ * `Currency` — ‫הגדירו ל-`"USD"` (או כל סימול שקיים ברשימת המטבעות; סימול לא מוכר ← `CurrencyDoesntExists`, 36).‬ * `ConversionRate` — ‫אופציונלי, ראו את השאלה הבאה. הוא נשמר כמטא-דאטה לצורכי דיווח/התאמה מול מטבע הבסיס של הארגון; הוא **לא** משנה את הסקאלה של `Total` או של סכום פריט/תשלום כלשהו.‬ * `ConvertToILS` — ‫לא קשור בכלל ליצירת המסמך. זהו **דגל תצוגה בדוחות/הדפסה** בו משתמשים רק שירותי הייצוא ל-PDF ו-Excel (דוחות חשבונות פתוחים והכנסות) כדי להחליט האם להציג בנוסף סכום מומר לצד הסכום במטבע המקורי. השאירו אותו לא מוגדר — `CreateDocument` מתעלם ממנו.‬ **‫האם ConversionRate חובה כשהמטבע אינו ILS, או שמספיק לשלוח 0 לחישוב אוטומטי?‬** ‫שליחת `0` (או השמטת השדה, שברירת המחדל שלו היא `0`) מספיקה — השרת מחשב אוטומטית את השער בין מטבע הארגון ל-`Currency` מטבלת השערים היומית. שלחו `ConversionRate` מפורש ושונה מאפס רק אם אתם צריכים לנעול שער ספציפי בעצמכם (למשל שער שכבר סוכם מול הלקוח).‬ {% hint style="info" %} ‫דוגמה: ארגון שמטבע הבסיס שלו הוא ILS ומפיק חשבונית ב-USD צריך רק `"Currency": "USD"` בגוף הבקשה — ניתן להשמיט את `ConversionRate` לגמרי.‬ {% endhint %} ## ‫שגיאות נפוצות‬ | ‫שגיאה (ID)‬ | ‫משמעות‬ | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `UnauthorizedUser` (80) | ‫טוקן לא תקין.‬ | | `DocumentTypeNotInRange` (33) | ‫`DocumentType` לא מוכר.‬ | | `ClientDoesntExists` (7) / `ClientIDDoesntExists` (37) | ‫לקוח חסר/לא מוכר.‬ | | `CurrencyDoesntExists` (36) | ‫סימול `Currency` לא נמצא ברשימת המטבעות הנתמכים.‬ | | `DocumentItemsNotSpecified` (34) / `DocumentItemMissingName` (39) / `DocumentItemQuantityCannotBeZero` (40) / `DocumentItemPriceCannotBeZero` (41) | ‫ולידציית פריטים. `Paramters` מכיל את מספר השורה.‬ | | `PaymentsNotSpecified` (45) / `PaymentDateMissing` (46) / `PaymentAmountCannotBeZero` (47) / `PaymentTypeOutOfRange` (51) | ‫ולידציית תשלומים.‬ | | `PaymentAmountDoesntMatchItemsAmount` (56) | ‫תשלומים ≠ סכום הפריטים.‬ | | `InvalidDateRange` (3) | ‫`IssueDate` עתידי או לפני המסמך האחרון שלכם.‬ | | `DocumentAlreadyCreated` (134) | ‫זוהתה כפילות.‬ | | `NotEnoughDocuments` (65) / `NotEnoughCredits` (18) | ‫מכסת המסמכים נגמרה.‬ | | `ExpiredAccount` (66) | ‫תוקף מנוי החשבון פג.‬ | | `ActionRestrictedForUser` (141) | ‫המשתמש מוגבל מיצירת סוג מסמך זה.‬ | | `TimeoutDB` (147) | ‫שגיאת שרת בעת היצירה — אמתו עם [GetDocumentByApiIdentifier](/invoice4u-docs/he/documents/get-document.md) לפני ניסיון חוזר.‬ | ## ‫נסו את זה‬ ## Create a document > Creates a signed, numbered document. Totals are computed server-side from Items/Payments. Check the returned Errors list before using the result. ```json {"openapi":"3.0.3","info":{"title":"Invoice4U API","version":"1.0.0"},"tags":[{"name":"Documents","description":"Create and retrieve documents (invoices, receipts, etc.)."}],"servers":[{"url":"https://api.invoice4u.co.il/Services/ApiService.svc","description":"Production"},{"url":"https://apiqa.invoice4u.co.il/Services/ApiService.svc","description":"QA (staging)"}],"paths":{"/CreateDocument":{"post":{"tags":["Documents"],"operationId":"CreateDocument","summary":"Create a document","description":"Creates a signed, numbered document. Totals are computed server-side from Items/Payments. Check the returned Errors list before using the result.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["doc","token"],"properties":{"doc":{"$ref":"#/components/schemas/Document"},"token":{"type":"string"}}}}}},"responses":{"200":{"description":"The created document (or a document carrying Errors).","content":{"application/json":{"schema":{"type":"object","properties":{"CreateDocumentResult":{"$ref":"#/components/schemas/Document"}}}}}}}}}},"components":{"schemas":{"Document":{"allOf":[{"$ref":"#/components/schemas/CommonObject"},{"type":"object","required":["DocumentType"],"properties":{"ID":{"type":"string","format":"uuid","readOnly":true},"DocumentNumber":{"type":"integer","format":"int64","readOnly":true,"description":"Legal sequential number, per type."},"DocumentType":{"type":"integer","description":"1 Invoice, 2 Receipt, 3 InvoiceReceipt, 4 InvoiceCredit, 5 ProformaInvoice, 6 InvoiceOrder, 7 InvoiceQuote, 8 InvoiceShip, 9 Deposits, 10 SupplierInvoiceToInventory, 13 PurchaseOrder.","enum":[1,2,3,4,5,6,7,8,9,10,13]},"Subject":{"type":"string","nullable":true},"ClientID":{"type":"integer","nullable":true,"description":"Existing customer ID. Required unless GeneralCustomer is supplied or the type doesn't need a customer."},"GeneralCustomer":{"$ref":"#/components/schemas/GenerelCustomer"},"Items":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/DocumentItem"}},"Payments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Payment"}},"Invoices":{"type":"array","nullable":true,"description":"Referenced documents (each with ID and ReceiptAmount). Requires DocumentReffType.","items":{"type":"object","properties":{"ID":{"type":"string","format":"uuid"},"ReceiptAmount":{"type":"number","format":"double"}}}},"DocumentReffType":{"type":"integer","description":"Type of the referenced documents."},"IssueDate":{"type":"string","format":"date-time","nullable":true,"description":"Defaults to today. Not in the future; not before your latest document of the type."},"Currency":{"type":"string","nullable":true},"ConversionRate":{"type":"number","format":"double","description":"Auto-resolved when 0."},"TaxPercentage":{"type":"number","format":"double","nullable":true},"TaxIncluded":{"type":"boolean","description":"Whether item prices include VAT."},"Discount":{"$ref":"#/components/schemas/Discount"},"BranchID":{"type":"integer","nullable":true,"description":"Defaults to the organization's default branch."},"Language":{"type":"integer","description":"1 Hebrew, 2 English."},"AssociatedEmails":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/AssociatedEmail"}},"ExternalComments":{"type":"string","nullable":true,"maxLength":5000},"InternalComments":{"type":"string","nullable":true},"EmailCustomComment":{"type":"string","nullable":true},"ApiIdentifier":{"type":"string","nullable":true,"description":"Idempotency key. Auto-generated if missing."},"ApiDuplicityTimeValidation":{"type":"integer","description":"Duplicate-detection window in seconds. Default 60."},"PaymentDueDate":{"type":"string","format":"date-time","nullable":true},"Deduction":{"type":"number","format":"double","description":"Withholding-tax deduction (receipts)."},"CloseReceipt":{"type":"boolean"},"IsSelfInvoice":{"type":"boolean"},"SupplierId":{"type":"integer","nullable":true},"SupplierName":{"type":"string","nullable":true},"UseDecimalValues":{"type":"boolean"},"AutoFixPaymentsMismatchItems":{"type":"boolean","description":"Auto-fix ±0.01 rounding gaps between payments and items."},"AutoFixMismatchItemName":{"type":"string","nullable":true},"Total":{"type":"number","format":"double","readOnly":true},"TotalWithoutTax":{"type":"number","format":"double","readOnly":true},"TotalTaxAmount":{"type":"number","format":"double","readOnly":true},"StatusID":{"type":"integer","readOnly":true,"description":"1 Open, 2 Closed, 3 FullyCredited, 4 PartiallyCredited, 5 Cancelled."},"PrintOriginalPDFLink":{"type":"string","readOnly":true},"PrintCertifiedCopyPDFLink":{"type":"string","readOnly":true},"CipherText":{"type":"string","readOnly":true},"CipherTextOriginal":{"type":"string","readOnly":true},"AllocationNumber":{"type":"string","nullable":true,"readOnly":true},"Paid":{"type":"number","format":"double","readOnly":true},"CreditAmount":{"type":"number","format":"double","readOnly":true},"Balance":{"type":"number","format":"double","readOnly":true}}}]},"CommonObject":{"type":"object","description":"Response envelope inherited by most objects. Server-generated — never send these fields in requests. Always check Errors before using the payload.","properties":{"Errors":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/CommonError"}},"Info":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/CommonInfo"}},"OpenInfo":{"type":"object","readOnly":true,"additionalProperties":{"type":"string"},"nullable":true}}},"CommonError":{"type":"object","properties":{"ID":{"type":"integer","description":"Numeric error code, e.g. 80 = UnauthorizedUser, 134 = DocumentAlreadyCreated."},"Error":{"type":"string","description":"Error name."},"Paramters":{"type":"string","nullable":true,"description":"Optional context, e.g. \"Row Number - 0\"."}}},"CommonInfo":{"type":"object","properties":{"ID":{"type":"integer"},"Info":{"type":"string"},"Paramters":{"type":"string","nullable":true}}},"GenerelCustomer":{"type":"object","required":["Name"],"description":"One-off (general) customer for documents without a stored customer record.","properties":{"ID":{"type":"integer"},"Name":{"type":"string"},"Identifier":{"type":"string","description":"VAT/ID number."}}},"DocumentItem":{"type":"object","required":["Name","Quantity","Price"],"properties":{"Name":{"type":"string"},"Description":{"type":"string","nullable":true},"Price":{"type":"number","format":"double","description":"Unit price."},"PriceIncludeTax":{"type":"number","format":"double","description":"Price including VAT (when TaxIncluded)."},"Quantity":{"type":"number","format":"double"},"TaxPercentage":{"type":"number","format":"double","nullable":true,"description":"Per-item VAT override."},"Discount":{"$ref":"#/components/schemas/Discount"},"Code":{"type":"string","nullable":true,"description":"Catalog code."},"LawyerIdentifier":{"type":"string","nullable":true,"description":"Lawyer accounts: \"1\" deposits, \"2\" expenses."},"InventoryId":{"type":"integer","nullable":true},"WarehouseId":{"type":"integer","nullable":true},"Total":{"type":"number","format":"double","readOnly":true},"TotalWithoutTax":{"type":"number","format":"double","readOnly":true},"TotalTax":{"type":"number","format":"double","readOnly":true}}},"Discount":{"type":"object","required":["Value"],"properties":{"Value":{"type":"number","format":"double"},"IsNominal":{"type":"boolean","description":"true = fixed amount, false = percent."},"BeforeTax":{"type":"boolean"}}},"Payment":{"type":"object","required":["PaymentType","Amount"],"properties":{"ID":{"type":"integer","description":"Existing payment ID — used for Deposits documents."},"PaymentType":{"type":"integer","description":"1 CreditCard, 2 Check, 3 MoneyTransfer, 4 Cash, 5 Credit, 6 WithholdingTax, 7 Other, 8 Bit, 9 PayBox.","enum":[1,2,3,4,5,6,7,8,9]},"Amount":{"type":"number","format":"double"},"Date":{"type":"string","format":"date-time","nullable":true},"DateStr":{"type":"string","nullable":true,"description":"Alternative string date when Date is not set."},"NumberOfPayments":{"type":"integer","description":"Credit-card installments."},"CreditCardName":{"type":"string","nullable":true,"description":"Card brand name; resolved against configured credit companies."},"CreditCardType":{"type":"integer","nullable":true},"PaymentNumber":{"type":"string","nullable":true,"description":"Check number / last 4 card digits."},"BankName":{"type":"string","nullable":true},"BranchName":{"type":"string","nullable":true},"AccountNumber":{"type":"string","nullable":true},"PayerID":{"type":"string","nullable":true},"ExpirationDate":{"type":"string","nullable":true},"PaymentTypeOtherId":{"type":"integer","description":"Sub-type when PaymentType=7 (Other)."},"PaymentTypeLiteral":{"type":"string","nullable":true}}},"AssociatedEmail":{"type":"object","required":["Mail"],"properties":{"Mail":{"type":"string","format":"email"},"IsUserMail":{"type":"boolean","description":"true marks the copy sent to the account owner."},"ClientId":{"type":"integer","nullable":true},"IsSendDoc":{"type":"boolean","nullable":true}}}}}} ```