מרכז הידע / ממשקים API

שאלו את ה-AI

✦ תשובת ה-AI

חושב…

מקורות

    קבלת מידע על מסמכים בטווח תאריכים - (Query invoice documents)

    מתי להשתמש בפונקציה זו?

    בתי עסקים המעוניינים לקבל מידע אודות מסמכים של לקוח ספציפי, סוג מסמך מסוים, או כל המסמכים בטווח תאריכים מסוים, יכולים להשתמש בפונקציה זו.

    בנוסף, ניתן להשתמש בפונקציה זו לצורך איסוף מידע והכנסתו למערכת ה-CRM או הממשק של בית העסק.

    - אי אפשר לקבל מידע על הפרטים במסמך דרך פונקציה זו

    מה מקבלים מהפונקציה הזאת?

    הפונקציה מחזירה מערך של מסמכים, הכולל את הנתונים הבאים:

    • שם הלקוח

    • סכום מסמך

    • תאריך המסמך

    • אימייל הלקוח

    • הערות המסמך

    המערך מאפשר גישה נוחה וממוקדת לפרטי המסמכים הרלוונטיים.

    להלן קישור לפונקציה בJSON.

    שיטת בקשה - POST.
    Query invoice documents

    https://secure.cardcom.solutions/api/v11/Documents/GetReport

    להלן הפרמטרים שצרים להעביר בפונקציה Query invoice documents.

    מקרא:

    פרמטר אדום - חובה

    פרמטר מודגש - מומלץ

    פרמטר לא אדום ולא מודגש - אופציונלי

    מספר פרמטר ערכים אפשריים לדוגמא תיאור
    1 ApiName "test2025" שם משתמש ממשקים. יש לקבל פרמטר זה מבית העסק. 
    2 ApiPassword "kzFKfohEvL6AOF8aMEJz" סיסמת API, מיועד לזיכוי וביטול עסקאות.
    3 FromDate "2025/03/23" מאיזה תאריך להתחיל חיפוש מסמכים.
    4 ToDate "2025/03/25" עד איזה תאריך לחפש מסמכים.
    5 FromDateYYYYMMDD "20250324" מאיזה תאריך להתחיל חיפוש מסמכים.
    6 ToDateYYYYMMDD "20250325" עד איזה תאריך לחפש מסמכים.
    7 AccountId 6549 תחת איזה כרטיס לקוח נחפש מסמכים.
    8 CusotmerName "שמוליק טסטים" תחת איזה שם לקוח נחפש מסמכים.
    9 DocType
     

    INT

    -1

    -2

    -3

     

    1 - חשבונית מס קבלה
    2 -  חשבונית זיכוי והחזר כספים
    3 - קבלה מלכ"ר / פטור מע"מ
    4 - קבלה מלכ"ר זיכוי (החזר כספים)

    50- הצעת מחיר

    100 - הזמנה (ללא תשלום)

    101 - אישור הזמנה - מאתר  ( מסמך פנימי לא להנח"ש) - הזמנה ששולמה
    102 - זיכוי הזמנה - מאתר (מסמך פנימי לא להנח"ש) - הזמנה שזוכתה

    200 - תעודת משלוח 210 - תעודת החזרה

    300 - חשבון עסקה

    301 - דרישה לתשלום

    302 - ביטול דרישה לתשלום

    305 - חשבונית מס

    330 - חשבונית זיכוי
    400 - קבלה (לחשבונית)

    410 - החזר כספים לקוחות(קבלה זיכוי)

    405 - קבלה על תרומה

    406 - זיכוי קבלה תרומה(החזר כספים)

    303 - חשבון קבלה (כמו חשבונית לעוסק פטור , נדיר לשימוש) 304 - חשבון קבלה זיכוי

    איזה סוגי מסמכים נחפש?

    -1

    את כל החשבוניות מס והקבלות הרגילים (בלי מסמכים זיכוי)

    -2

    את כל המסמכים שהופקו.

    -3

    את כל החשבוניות וקבלות זיכוי.
    10 CoinId

    1 -  שקל
    2  - דולר 
    978 - אירו

    ראה רשימת קודי מטבעות נוספים - רשימת קודי מטבעות

    		  מטבע מסמך
    11 OpenClose

     INT - 0 / 1 /2

     האם לחפש מסמכים פתוחים או סגורים?

    0 - לחפש את כל סוגי המסמכים.

    1 - מסמכים פתוחים.

    2 - מסמכים סגורים.
    12 VatFreeDocOnly  boolean - true \ false  האם להביא מסמכים בלי מע''מ בלבד. או להביא מסמכים עם מע''מ ובלי מע''מ ביחד.
    13 PageNumber  1 מאיזה עמוד למשוך את פרטי רשימת העסקאות .
    14 ItemsPerPage  20 מה יהיה כמות השורות בעמוד שמהם אנחנו נמשוך את פרטי רשימת העסקאות.

     

     RESPONSE של Query invoice documents.

    מספר פרמטר ערכים אפשריים לדוגמא תיאור
    1 ResponseCode 0 קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה.
    2 Description "OK" תיאור התשובה. ''OK'' זה טוב.

     

    ערכים של Documents (3).

    מספר  פרמטר ערכים אפשריים לדוגמא תיאור
    1 TotalNoVatNIS 19.00 סכום מחיר ללא מע''מ.
    2 TotalIncludeVATNIS 22.42 סכום מחיר כולל מע''מ. (שקל ישראלי)
    3 VATOnlyNIS 3.42 סכום מע''מ בלבד בשקלים.
    4 TotalVatFreeNIS 0.00 הסכום שאינו כולל מע''מ (למשל ירקות, יש פריטים שכוללים מע''מ ופירטים שאינם כוללים מע''מ.) בשקלים.
    5 TotalNoVat 19.00 סכום ללא מע''מ.
    6 TotalIncludeVAT 22.42 סכום מחיר כולל מע''מ.
    7 VATOnly 3.42 מע''מ בלבד.
    8 TotalVatFree 0.00 הסכום שאינו כולל מע''מ (למשל ירקות, יש פריטים שכוללים מע''מ ופירטים שאינם כוללים מע''מ.)
    9 ISORate 1.0000 כמה הוא ערך מטבע המסמך בשקלים.
    10 Cust_City "ראשון לציון" עיר הלקוח.
    11 Cust_Addres_Line1 "רוטשילד"

    כתובת ראשונה של הלקוח.
    12 Cust_Addres_Line2 "רחוב 12" כתובת שנייה של הלקוח.
    13 Cust_LinePH "03654118" טלפון קווי של הלקוח.
    14 Cust_MobilePH "0533333333" טלפון נייד של הלקוח.
    15 Comp_ID "518648487"

    מספר ח''פ \ ת''ז של הלקוח.
    16 Email "T@T.COM" אימייל לקוח.
    17 Cust_Name "שמוליק טסטים" שם לקוח.
    18 InvoiceDateOnly "2025-03-24T00:00:00" תאריך מסמך בלבד.
    19 InvoiceDate "2025-03-24T12:16:00" תאריך מסמך ביחד עם השעה שבו הוא הופק.
    20 Invoice_Number 887 מספר מסמך.
    21 InvoiceType

    1 - חשבונית מס קבלה

    2 -  חשבונית זיכוי והחזר כספים
    3 - קבלה מלכ"ר / פטור מע"מ
    4 - קבלה מלכ"ר זיכוי (החזר כספים)

    50- הצעת מחיר

    100 - הזמנה (ללא תשלום)

    101 - אישור הזמנה - מאתר  ( מסמך פנימי לא להנח"ש) - הזמנה ששולמה
    102 - זיכוי הזמנה - מאתר (מסמך פנימי לא להנח"ש) - הזמנה שזוכתה

    200 - תעודת משלוח 210 - תעודת החזרה

    300 - חשבון עסקה

    301 - דרישה לתשלום

    302 - ביטול דרישה לתשלום

    305 - חשבונית מס

    330 - חשבונית זיכוי
    400 - קבלה (לחשבונית)

    410 - החזר כספים לקוחות(קבלה זיכוי)

    405 - קבלה על תרומה

    406 - זיכוי קבלה תרומה(החזר כספים)

    303 - חשבון קבלה (כמו חשבונית לעוסק פטור , נדיר לשימוש) 304 - חשבון קבלה זיכוי

    		 סוג מסמך.
    22 Terminal_Number 1001 מספר מסוף
    23 CoinID

    1 - שקל

    2 - דולר

    לקודי מטבע נוספים - רשימת קודי מטבעות

    		 מטבע המסמך.
    24 DepartmentID 21 מספר מחלקה.
    25 IsOpen boolean - true \ false

    האם המסמך פתוח (לדוגמא חשבונית מס בלי קבלה לחשבונית)

    או שהוא סגור ( לדוגמא חשבונית מס קבלה או חשבונית זיכוי והחזר כספים.) 
    26 ValueDate "2025-03-24T00:00:00"

    תאריך ערך למסמך,

    תאריך יעד / סגירה / לתשלום תאריך סגירת המסמך. לדוגמה בהפקת חשבונית, זהו התאריך המשוער לקבלת התשלום.
    27 UserID 0 מספר משתמש שיצר מסמך.
    28 Customer_Number 13167 מספר לקוח במערכת של קארדקום.
    29 group_number null  שדה מותאם אישית בעסקת אשראי (נמצא רק בטסטים)
    30 Languge "HE " \ "EN שפת מסמך.
    31 UserComments "העמותה נתמכת על ידי סעיף 46" הערות למסמך.
    32 Discount INT סכום הנחה.
    33 DiscountNIS INT הנחה בשקלים.
    34 ValidateItemsisPriceIncludeVat boolean - true \ false האם המחיר כולל מע''מ או לא.
    35 ExternalId  (String) מזהה מערכת חיצוני ברמת מסמך בלבד
    (לא נשמר ברמת כרטיס לקוח)
    36 ZReport 4524 לאיזה מספר דוח Z זה שייך.
    37 Asmachta 123456-ZZC מספר אסמכתה פעולה 
    38 SumBeforeDiscountNIS 75 סכום לאחר הנחה
    39 TotalChashNIS 50 סכום כולל של מזומנים בשקלים.
    40 TotalChequesNIS 60 סכום כולל של צ'קים בשקלים.
    41 TotalCreditCardNIS 70 סכום כולל של אשראי בשקלים.
    42 TotalCustomeTransactionNIS 180 סכום כולל של אמצעי תשלום אחר בשקלים.
    43 TotalRicipientNIS 360 סכום כולל של המסמך.
    44 TotalChash 25 סכום כולל של מזומן.
    45 TotalCheques 30 סכום כולל של צ'קים.
    46 IsNegetive boolean - true \ false האם הסכום שלילי?
    47 TotalCreditCard 70 סכום כולל באשראי.
    48 TotalCustomeTransaction 180 סכום כולל של אמצעי תשלום אחר.
    49 TotalRicipient 180 סכום כולל של המסמך.

     

    להלן קוד לדוגמא לפונקציה ביחד עם התשובה.

    דוגמא לקריאה לקבלת פרטי המסמכים:

    {
      "ApiName": "test2025",
      "ApiPassword": "test5000$",
      "FromDateYYYYMMDD": "20250325",
      "ToDateYYYYMMDD": "20250325",
      "CusotmerName":"סרגיי בורד בן 11",
      "DocType": -1,
      "PageNumber": 1,
      "ItemsPerPage": 50
    }

    התשובה המתקבלת:

    {
        "ResponseCode": 0,
        "Description": "Successful operation",
        "Documents": [
            {
                "TotalNoVatNIS": 83.90,
                "TotalIncludeVATNIS": 99.00,
                "VATOnlyNIS": 15.10,
                "TotalVatFreeNIS": 0.00,
                "TotalNoVat": 83.90,
                "TotalIncludeVAT": 99.00,
                "VATOnly": 15.10,
                "TotalVatFree": 0.00,
                "ISORate": 1.0000,
                "Cust_City": "",
                "Cust_Addres_Line1": "",
                "Cust_Addres_Line2": "",
                "Cust_LinePH": "",
                "Cust_MobilePH": "0504358886",
                "Comp_ID": "                    ",
                "Email": "ecw+6446de103e5f9b77e8e40c01@200apps.co",
                "Cust_Name": "סרגיי בורד בן 11",
                "InvoiceDateOnly": "2025-03-25T00:00:00",
                "InvoiceDate": "2025-03-25T06:00:00",
                "Invoice_Number": 586364,
                "InvoiceType": 1,
                "Terminal_Number": 1000,
                "CoinID": 1,
                "DepartmentID": 0,
                "IsOpen": false,
                "ValueDate": "2025-03-25T00:00:00",
                "UserID": 3622,
                "Customer_Number": 0,
                "group_number": 0,
                "Languge": "HE ",
                "UserComments": null,
                "Discount": 0.00,
                "DiscountNIS": 0.00,
                "ValidateItemsisPriceIncludeVat": true,
                "ExternalId": null,
                "ZReport": null,
                "Asmachta": null,
                "SumBeforeDiscountNIS": 99.00,
                "TotalChashNIS": 0.00,
                "TotalChequesNIS": 0.00,
                "TotalCreditCardNIS": 99.00,
                "TotalCustomeTransactionNIS": 0.00,
                "TotalRicipientNIS": 99.00,
                "TotalChash": 0.00,
                "TotalCheques": 0.00,
                "IsNegetive": false,
                "TotalCreditCard": 99.00,
                "TotalCustomeTransaction": 0.00,
                "TotalRicipient": 99.00
            },
            {
                "TotalNoVatNIS": 83.90,
                "TotalIncludeVATNIS": 99.00,
                "VATOnlyNIS": 15.10,
                "TotalVatFreeNIS": 0.00,
                "TotalNoVat": 83.90,
                "TotalIncludeVAT": 99.00,
                "VATOnly": 15.10,
                "TotalVatFree": 0.00,
                "ISORate": 1.0000,
                "Cust_City": "",
                "Cust_Addres_Line1": "",
                "Cust_Addres_Line2": "",
                "Cust_LinePH": "",
                "Cust_MobilePH": "0504358886",
                "Comp_ID": "                    ",
                "Email": "ecw+6446de103e5f9b77e8e40c01@200apps.co",
                "Cust_Name": "סרגיי בורד בן 11",
                "InvoiceDateOnly": "2025-03-25T00:00:00",
                "InvoiceDate": "2025-03-25T06:00:00",
                "Invoice_Number": 586363,
                "InvoiceType": 1,
                "Terminal_Number": 1000,
                "CoinID": 1,
                "DepartmentID": 0,
                "IsOpen": false,
                "ValueDate": "2025-03-25T00:00:00",
                "UserID": 3622,
                "Customer_Number": 0,
                "group_number": 0,
                "Languge": "HE ",
                "UserComments": null,
                "Discount": 0.00,
                "DiscountNIS": 0.00,
                "ValidateItemsisPriceIncludeVat": true,
                "ExternalId": null,
                "ZReport": null,
                "Asmachta": null,
                "SumBeforeDiscountNIS": 99.00,
                "TotalChashNIS": 0.00,
                "TotalChequesNIS": 0.00,
                "TotalCreditCardNIS": 99.00,
                "TotalCustomeTransactionNIS": 0.00,
                "TotalRicipientNIS": 99.00,
                "TotalChash": 0.00,
                "TotalCheques": 0.00,
                "IsNegetive": false,
                "TotalCreditCard": 99.00,
                "TotalCustomeTransaction": 0.00,
                "TotalRicipient": 99.00
            },
            {
                "TotalNoVatNIS": 83.90,
                "TotalIncludeVATNIS": 99.00,
                "VATOnlyNIS": 15.10,
                "TotalVatFreeNIS": 0.00,
                "TotalNoVat": 83.90,
                "TotalIncludeVAT": 99.00,
                "VATOnly": 15.10,
                "TotalVatFree": 0.00,
                "ISORate": 1.0000,
                "Cust_City": "",
                "Cust_Addres_Line1": "",
                "Cust_Addres_Line2": "",
                "Cust_LinePH": "",
                "Cust_MobilePH": "0504358886",
                "Comp_ID": "                    ",
                "Email": "ecw+6446de103e5f9b77e8e40c01@200apps.co",
                "Cust_Name": "סרגיי בורד בן 11",
                "InvoiceDateOnly": "2025-03-25T00:00:00",
                "InvoiceDate": "2025-03-25T06:00:00",
                "Invoice_Number": 586362,
                "InvoiceType": 1,
                "Terminal_Number": 1000,
                "CoinID": 1,
                "DepartmentID": 0,
                "IsOpen": false,
                "ValueDate": "2025-03-25T00:00:00",
                "UserID": 3622,
                "Customer_Number": 0,
                "group_number": 0,
                "Languge": "HE ",
                "UserComments": null,
                "Discount": 0.00,
                "DiscountNIS": 0.00,
                "ValidateItemsisPriceIncludeVat": true,
                "ExternalId": null,
                "ZReport": null,
                "Asmachta": null,
                "SumBeforeDiscountNIS": 99.00,
                "TotalChashNIS": 0.00,
                "TotalChequesNIS": 0.00,
                "TotalCreditCardNIS": 99.00,
                "TotalCustomeTransactionNIS": 0.00,
                "TotalRicipientNIS": 99.00,
                "TotalChash": 0.00,
                "TotalCheques": 0.00,
                "IsNegetive": false,
                "TotalCreditCard": 99.00,
                "TotalCustomeTransaction": 0.00,
                "TotalRicipient": 99.00
            }
        ],
        "Page": 1,
        "Count": 3
    }

    האם המאמר הזה עזר לך?