יצירת מסמך שמשויך לעסקה - (Create a document associated to a deal)
מתי להשתמש בפונקציה זו?
הפונקציה הזאת נועדה במיוחד להפקת מסמך עבור עסקאות שאינן משויכות למסמך.
עסקאות כאלה עשויות להיווצר במקרים בהם לא נשלחו פרמטרים להפקת מסמך, או במקרים בהם קיימים דפי נחיתה שהוסרה מהם ההגדרה להפקת מסמך, או בהוראות קבע ללא הגדרה להפקת מסמך.
פעולות נפוצות בפונקציה.
הפונקציה יכולה להפיק מסמך ולשייך אותו למספר העסקה הספציפי.
בנוסף, הפונקציה יכולה להפיק מסמך באופן עצמאי, ללא קשר לשיוך לעסקה, עם פרטי תשלום שונים כגון מזומן, צ'קים, העברות בנקאיות ועוד.
דרישות & מודלים נחוצים.
מודל מסמכים.
עסקה ללא מסמך משויך.
להלן קישור לפונקציה בJSON.
שיטת בקשה - POST.
Create a document associated to a deal
https://secure.cardcom.solutions/api/v11/Documents/CreateDocument
להלן הפרמטרים שצרים להעביר בפונקציה Create a document associated to a deal.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ApiName | test2025 | שם משתמש ממשקים. יש לקבל פרמטר זה מבית העסק. |
2 | ApiPassword | "kzFKfohEvL6AOF8aMEJz" | סיסמת API, מיועד לזיכוי וביטול עסקאות. |
4 | Cash | 50 | כמה שולם במזומן. |
7 | DealNumbers מערך של אובייקטים | DealNumber - 204477861 | DealNumber - מספר פנימי של העסקה שנעשתה. |
8 | IsSendSMS | boolean - true \ false | האם לשלוח מסמך עם SMS. |
ערכים למסמך - אובייקט Document (3).
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | DocumentTypeToCreate | "Auto" - אוטומטי, לפי מה שיש בהגדרות 3->4. "TaxInvoiceAndReceipt" – חשבונית מס וקבלה "TaxInvoiceAndReceiptRefund" – חשבונית זיכוי והחזר כספים "Receipt" – קבלה מלכ''ר "ReceiptRefund" – קבלה מלכ"ר זיכוי ( החזר כספים) "Quote" – הצעת מחיר "Order" – הזמנה "OrderConfirmation" – אישור הזמנה - מאתר "OrderConfirmationRefund" – זיכוי אישור הזמנה - מאתר "DeliveryNote" – תעודת משלוח "DeliveryNoteRefund" – תעודת החזרה "ProformaInvoice" – חשבון עסקה "DemandForPayment" – דרישה לתשלום "DemandForPaymentRefund" – ביטול דרישה לתשלום "ProformaDealInvoice" – חשבון קבלה פרופורמה "ProformaDealInvoiceRefund" –חשבון קבלה זיכוי "TaxInvoice" – חשבונית מס "ProformaInvoiceRefund" – זיכוי חשבון עסקה "TaxInvoiceRefund" – חשבונית מס זיכוי "ReceiptForTaxInvoice" – קבלה (לחשבונית) "DonationReceipt" – קבלה על תרומה "DonationReceiptRefund" – זיכוי קבלה תרומה (החזר כספים) "ReceiptForTaxInvoiceRefund" – החזר כספים לקוחות (קבלה זיכוי)
| סוג המסמך להפקה. |
2 | Name | מר טסט | שם הלקוח. |
3 | TaxId | 040617640 | מספר ת.ז. או ח.פ חברה |
4 | israel@gmail.com | כתובת דואר הלקוח , שלשם ישלח המסמך. (ניתן לשרשר כמה מיילים באמצעות נקודה פסיק ; ) | |
5 | IsSendByEmail | true \ false | האם לשלוח מסמך בדואר אלקטרוני. |
6 | AddressLine1 | Saharov 22 | כתובת לקוח , שורה ראשונה |
7 | AddressLine2 | P.O. 1234 | כתובת לקוח, שורה שנייה |
8 | City | Reshin-Le-Zion | עיר |
9 | Mobile | 03-9619611 | טלפון קווי |
10 | Phone | 0549876543 | טלפון נייד (במודול SMS ישלח SMS לנייד זה) |
11 | Comments | דוגמא: אחריות של שנה מיום החשבונית (עד 250 תווים ) | הערות למסמך - יודפסו במסמך למטה |
12 | IsVatFree | true = מע"מ 0 | האם המסמך כולו הוא ללא מע"מ - מתאים ללקוח חו"ל |
13 | DepartmentId | 123 (int) | קוד מחלקה להצגה בדוחות והעברה להנח"ש |
14 | AdvancedDefinition אובייקט עם פרמטרים בתוכו. | IsAutoCreateUpdateAccount (bool) - false - כל הלקוחות ירשמו על "לקוחות שונים". ------------------------------ AccountForeignKey (string) - לדוגמא 300 ------------------------------ SiteUniqueId (string) ------------------------------ AccountID (integer) - 123 ------------------------------ IsLoadInfoFromAccountID (boolean) - true \ false
| IsAutoCreateUpdateAccount (bool) - האם ליצור ללקוח כרטיס לקוח במערכת. במידה ולא מועבר יתבצע איתור לפי מפתח זר ולאחר מכן לפי מזהה ייחודי אתר ואז לפי EMAIL לקוח. (הפרמטר הראשון שנמצע בשרת מוצלב ולא ממשיך לחפש עוד ) ------------------------------ AccountForeignKey (string) - מספר מפתח זר של הלקוח - פעיל רק אם יוצר ללקוח כרטיס לקוח. (מספר הנח"ש) ------------------------------ SiteUniqueId (string) - מזהה ייחודי לאתר - פרמטר אינפורמטיבי. (מזהה נוסף) ------------------------------ AccountID (integer) - 123 - מספר הלקוח במערכת אישורית זהב לשיוך המסמך ------------------------------ IsLoadInfoFromAccountID (boolean) - אם יש AccountID. אפשר לקחת מהכרטיס לקוח שמשויך למספר לקוח את הנתונים ולהכניס אותם למסמך. |
15 | Products מערך עם אובייקטים בתוכו. | ProductID (string) - ZZASA AASSA - 12 ------------------------------ Description (string) - קורס אינטרנטי ------------------------------ Quantity (integer) - 2 ------------------------------ UnitCost (integer) - 50.57 ------------------------------ TotalLineCost (integer) - 51 ------------------------------ IsVatFree (boolean) - true \ false | ProductID (string) - קוד פריט , מק"ט , קוד מוצר - מומלץ להעביר לשם דוחות , ניתן לראות ב דוח פריטים במסמך במקרה של שני פריטים ניתן להפריד כך: InvoiceLines1.ProductID=AAA InvoiceLines2.ProductID=BBB ------------------------------ Description (string) - תיאור המוצר ------------------------------ Quantity (integer) - כמות הפריטים ------------------------------ UnitCost (integer) - מחיר יחידה. -----------------------------TotalLineCost (integer)- מומלץ במקרה וכמות המוצרים הוא מספר לא שלם. זה יכול למנוע בעיות עיגול מחיר. ----------------------------- IsVatFree (boolean) - האם המוצר הזה יהיה עם מע''מ או בלי מע''מ.
|
16 | ExternalId | (String) | מזהה מערכת חיצוני שמתכנת מעביר ברמת מסמך בודד. |
17 | ManualNumber | 585177 | מספור ידני של המסמך. ניתן לשימוש רק ביצירת מסמך ללא חיוב. יש לבקש הרשאה מיוחדת לשימוש בפרמטר זה. ראה הערות בסוף המאמר. במקרים נדירים ניתן להעביר את מספר החשבוניות שהמערכת תיצור במקום להשתמש במונה הפנימי של המערכת. שם לב! במידה וישנה התנגשות במונים החשבונית לא תיוצר , יש לבקש הרשאה מיוחדת לשימוש בפרמטר זה. |
18 | DocumentDate | "05/03/2025" | תאריך הפקת מסמך. |
19 | ValueDate | "12/03/2025" | תאריך ערך של המסמך (נועד להפקדות יומן) |
20 | ISOCoinID | 1 - שקל 2 - דולר לקודי מטבע נוספים - רשימת קודי מטבעות | מטבע לחיוב העסקה. |
21 | ISOCoinName | ILS \ USD \ EUR | המקביל לפרמטר ISOCoinId, בפרמטר הזה מקבלים את השם מטבע ולא את המספר מטבע. |
22 | Language | "he" \ "en" | שפת מסמך |
ערכים של מערך של אובייקטים Cheques (5).
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ChequeNumber | "1234" | מספר המחאה |
2 | BankNumber | 12 | מספר בנק |
3 | SnifNumber | 1 | מספר סניף בנק |
4 | AccountNumber | "123456" | מספר חשבון |
5 | DateCheque | " MM/dd/yyyy" | תאריך פירעון המחאה |
6 | Sum | 50 | סכום המחאה |
ערכים של מערך של אובייקטים CustomFields (6).
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | TransactionID | 32 | מספר חשבון המוגדר מראש במערכת הסליקה אישורית זהב. |
2 | TranDate | "MM/dd/yyyy" | תאריך אסמכתה |
3 | Description | "קבלת תשלום מPayPal" | תיאור פעולה |
4 | asmacta | "123456-ZZC" | מספר אסמכתה פעולה |
5 | Sum | 50 | סכום |
RESPONSE של Create a document associated to a deal
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ResponseCode | 0 | 0 - הפעולה תקינה |
2 | Description | "העסקה בוצעה בהצלחה" | תיאור התשובה , במידה ומתקבל תשובה שונה, העסקה לא בוצעה בהצלחה. |
3 | DocumentType | "Auto" - אוטומטי, לפי מה שיש בהגדרות 3->4. "TaxInvoiceAndReceipt" – חשבונית מס וקבלה "TaxInvoiceAndReceiptRefund" – חשבונית זיכוי והחזר כספים "Receipt" – קבלה מלכ''ר "ReceiptRefund" – קבלה מלכ"ר זיכוי ( החזר כספים) "Quote" – הצעת מחיר "Order" – הזמנה "OrderConfirmation" – אישור הזמנה - מאתר "OrderConfirmationRefund" – זיכוי אישור הזמנה - מאתר "DeliveryNote" – תעודת משלוח "DeliveryNoteRefund" – תעודת החזרה "ProformaInvoice" – חשבון עסקה "DemandForPayment" – דרישה לתשלום "DemandForPaymentRefund" – ביטול דרישה לתשלום "ProformaDealInvoice" – חשבון קבלה פרופורמה "ProformaDealInvoiceRefund" –חשבון קבלה זיכוי "TaxInvoice" – חשבונית מס "ProformaInvoiceRefund" – זיכוי חשבון עסקה "TaxInvoiceRefund" – חשבונית מס זיכוי "ReceiptForTaxInvoice" – קבלה (לחשבונית) "DonationReceipt" – קבלה על תרומה "DonationReceiptRefund" – זיכוי קבלה תרומה (החזר כספים) "ReceiptForTaxInvoiceRefund" – החזר כספים לקוחות (קבלה זיכוי)
| סוג המסמך להפקה. |
4 | DocumentNumber | 65451 | מספר מסמך. |
5 | AccountId | (string) "123" | מספר כרטיס לקוח. |
6 | ForeignAccountNumber | 21451 | מספר הנהלת חשבונות של הלקוח, רק אם נוצר או בוצע איחוד לכרטיס לקוח. |
7 | SiteUniqueId | (String) | מזהה ייחודי לאתר - פרמטר אינפורמטיבי. |
8 | DocumentUrl | (String) | נותן את הURL של המסמך |
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
קריאה להפקת מסמך עבור עסקה בלי מסמך:
{
"ApiName": "test2025",
"ApiPassword": "test5000$",
"Document": {
"DocumentTypeToCreate": "TaxInvoiceAndReceipt",
"Name": "plz",
"Email": "t@t.com",
"Products": [
{
"Description": "test",
"UnitCost": 21,
"Quantity": 1,
"IsVatFree": false
}
],
"ISOCoinID": "1"
},
"DealNumbers": [
{
"DealNumber": "205078451"
}
]
}
התשובה המתקבלת:
{
"ResponseCode": 0,
"Description": "",
"DocumentType": "TaxInvoiceAndReceipt",
"DocumentNumber": 586136,
"AccountId": 0,
"ForeignAccountNumber": null,
"SiteUniqueId": null,
"DocumentUrl": "https://secure.cardcom.solutions/api/v11/documents/DownloadDoc/?c=1&code=iKm1mI1S7d6CAqzerQN+IMRsYjKepupkHsjFFvZkRnlaLuk6UA78U3RaWJxUL4nu"
}