הנה מספר דוגמאות לאופן שבו ניתן להפעיל את ה-API של כספית. אלה דוגמאות לקריאות העיקריות של ה-API. 
ה-API עשיר ומכיל יכולות נוספות ראו הפירוט כאן.

קבלת אסימון

דוגמה לקבלת אסימון באמצעות POST. מאחר שאנחנו שולחים פרטים רגישים כמו שם משתמש וסיסמה, עדיף לשלוח ב-POST ולא ב-GET:

POST /api/v1/token/ HTTP/1.1

Host: app.caspitweb.biz
Content-Type: application/x-www-form-urlencoded
Content-Length: 52

UserName=demo&Password=demodemo&OsekMorshe=123456789
"B47C7DD29B64C46A774B8972DAB244E0B7F0366EA3D4608C"

שליפת כל הלקוחות

בקשה לשליפת כל הלקוחות. שם לב שהאסימון לא נשלח ב-Query אלא ב-Headers.

כספית מחזירה 50 לקוחות בכל פעם. בבקשה זו ביקשנו את דף 3 מתוך 9. הספירה מתחילה מ-0.

GET /api/v1/contacts?page=3 HTTP/1.1
Host: app.caspitweb.biz
Caspit-Token: B47C7DD29B64C46A774B8972DAB244E0B7F0366EA3D4608C
{
   "CurrentPage": 3,
   "TotalCount": 425,
   "TotalPages": 9,
   "PrevPageUrl": "https://app.caspitweb.biz/api/v1/contacts?page=2&token=B47C7DD29B64C46A774B8972...",
   "NextPageUrl": "https://app.caspitweb.biz/api/v1/contacts?page=4&token=B47C7DD29B64C46A774B8972...",
   "Results": [
       {
           "ContactId": "Bfirst_6065ADD5-4258-4D9D-8DF7-67C01262DA77",
           "ContactType": 0,
           "Number": 263,
           "BusinessName": "ירון ביילין",
           "OsekMorshe": "319854377",
           "Name": null,
           "Address1": "העמק 6",
           "Address2": "דירה 7",
           "City": "רעננה",
           "PostalCode": "",
           "Country": null,
           "Phone": null,
           "Mobile": null,
           "Fax": null,
           "Email": "gtr@gmail.com",
           "TrxCodeNumber": null,
           "TrxCode": null,
           "OpenBalance": 0.00,
           "Balance": 577.4500,
           "BalanceInvoiceIska": 6755.1000,
           "PriceListNum": 1,
           "Comments1": "נוסף מאתר bfirst",
           "Comments2": null,
           "Comments3": null,
           "InvoiceComment": null,
           "BankAcctNumber": null,
           "BankAcctBranch": null,
           "BankAcctBankId": null,
           "ChargeVAT": true,
           "IsIsraeli": true,
           "IsOccasional": false,
           "AffiliateId": null,
           "CCNumberToken": null,
           "CCExpDate": null,
           "CVV": null,
           "DateCreated": "2020-06-21T05:32:10.973",
           "UserCreated": "Anonymous",
           "DateUpdated": "2020-06-21T05:32:11.697",
           "UserUpdated": "Anonymous"
       }, ... 49 more records
    ]}

הוספת לקוח חדש

POST /api/v1/contacts/ HTTP/1.1
Host: app.caspitweb.biz
Content-Type: application/json
Caspit-Token: 1D1D6654D270D8DBE9DD3051AB869C261D9A81C7FAF11B7F
Content-Length: 555

{"ContactId":"5:2:668","ContactType":null,"Number":null,"BusinessName":"Jack Cohen","OsekMorshe":null,"Name":null,"Address1":"45 West St.","Address2":"Suite 6276","City":"Lousiville, KT","PostalCode":"72789","Country":null,"Phone":null,"Mobile":null,"Fax":null,"Email":null,"TrxCodeNumber":null,"TrxCode":null,"OpenBalance":null,"Balance":null,"BalanceInvoiceIska":null,"PriceListNum":null,"Comments1":"","Comments2":"","Comments3":"","InvoiceComment":"","BankAcctNumber":"","BankAcctBranch":"","BankAcctBankId":null,"ChargeVAT":null,"AffiliateId":null}
{
"ContactId": "5:2:668",
"ContactType": 0,
"Number": 4338,
"BusinessName": "Jack Cohen",
"OsekMorshe": null,
"Name": null,
"Address1": "45 West St.",
"Address2": "Suite 6276",
"City": "Lousiville, KT",
"PostalCode": "72789",
"Country": null,
"Phone": null,
"Mobile": null,
"Fax": null,
"Email": null,
"TrxCodeNumber": null,
"TrxCode": null,
"OpenBalance": 0.00,
"Balance": 0.00,
"BalanceInvoiceIska": 0.00,
"PriceListNum": 1,
"Comments1": "",
"Comments2": "",
"Comments3": "",
"InvoiceComment": "",
"BankAcctNumber": "",
"BankAcctBranch": "",
"BankAcctBankId": null,
"ChargeVAT": true,
"IsIsraeli": true,
"IsOccasional": false,
"AffiliateId": null,
"CCNumberToken": null,
"CCExpDate": null,
"CVV": null,
"DateCreated": "2021-04-07T02:04:29.137",
"UserCreated": "Anonymous",
"DateUpdated": "2021-04-07T02:04:31.1253486+03:00",
"UserUpdated": "Anonymous"
}

שליפת חשבונית/קבלה

אפשר לשלוף מסמך לפי ה-ID שלו ולפי פרמטרים אחרים כמו מספרו. ה-ID של המסמך הוא ה-ID שאתה נתת לו (כלומר שלחת לכספית) כשיצרת אותו. אם המסמך נוצר בכספית הוא יקבל ID שתיתן לו כספית, לדוגמה: 843a7628-6fbc-4e75-aa50-e6cd1985c254 

GET /api/v1/documents/843a7628-6fbc-4e75-aa50-e6cd1985c254 HTTP/1.1
Host: app.caspitweb.biz
Caspit-Token: D6C02015082F98A578DE01F8B0ABD3CED407CB7A10F660E3

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

{
"DocumentId": "843a7628-6fbc-4e75-aa50-e6cd1985c254",
"DocumentNumberBranch": 17,
"TrxTypeId": 7,
"Number": "17/20029",
"Date": "2019-09-14T00:00:00",
"CustomerId": "1629",
"CustomerBusinessName": "גיא שץ",
"CustomerOsekMorshe": null,
"CustomerContactName": "גיא שץ",
"CustomerAddress1": null,
"CustomerAddress2": null,
"CustomerCity": null,
"CustomerPostalCode": null,
"CustomerCountry": null,
"CustomerEmail": null,
"MobilePhone": null,
"Details": null,
"Comments": null,
"TotalLinesChargeVAT": 1282.0513,
"Rebate": 0.0000,
"RebatePercent": 0.00000,
"RountTotal": true,
"RebateRounding": 0.0000,
"TotalBeforeVAT": 1282.0513,
"TotalBeforeVATChargeVAT": 1282.0513,
"TotalNoChargeVat": 0.0000,
"Vat": 217.9487,
"Total": 1500.0000,
"EffectiveTotal": 0.0000,
"VatRate": 17.00,
"Payment": 1500.0000,
"TaxDeduction": 0.0000,
"TotalPayment": 1500.0000,
"ReceiptCurrencySymbol": "₪",
"ReceiptRate": 1.0000,
"TaxDeductionNIS": 0.00000000,
"PaymentNIS": 1500.00000000,
"TotalPaymentNIS": 1500.00000000,
"DocumentLines": [
{
"Number": 1,
"ProductId": null,
"ProductCatalogNumber": null,
"ProductName": "1",
"Details": "שירותי ייעוץ",
"UnitPrice": 1282.0513,
"Qty": 1.0000,
"CurrencySymbol": "₪",
"Rate": 1.0000,
"Rebate": 0.0000,
"ExtendedPrice": 1282.051300000000,
"ChargeVAT": true,
"VATRate": 17.00,
"VAT": 217.9487
}
],
"ReceiptLines": [
{
"Number": 1,
"PaymentTypeId": 4,
"AccountNumber": null,
"BranchOrValidTo": null,
"BankId": null,
"CheckNumber": null,
"PaymentDate": null,
"Payment": 1500.0000,
"Rate": 1.0000,
"CanBeChanged": true,
"DateCreated": null,
"UserCreated": null,
"DateUpdated": null,
"UserUpdated": null
}
],
"TrxCode": "הכנסות/מכירות",
"TrxCodeNumber": 3,
"Status": 2,
"DueDate": null,
"RowVersion": "AAAAAAUd8n0=",
"LinkToPdf": "https://app.caspitweb.biz:443/api/v1/Pdf/843a7628-6fbc-4e75-aa50-e6cd1985c254?token=_REPLACE_WITH_YOUR_TOKEN_",
"ViewUrl": "http://casp.it/my0p0MowQR",
"PaymentUrl": null,
"DateCreated": "2019-09-14T13:32:22.067",
"UserCreated": "demo",
"DateUpdated": "2019-10-02T10:02:50.967",
"UserUpdated": "demo"
}

יצירת חשבונית

דוגמה ליצירת חשבונית. שולחים רק שורות מסמך ללא שורות קבלה. האסימון נמצא ב-Headers.

POST /api/v1/documents/ HTTP/1.1
Host: app.caspitweb.biz
Content-Type: application/json
Caspit-Token: 9DDFE08B075E05F7B9D06B1771B66298D0A0BDBB95E2951C
Content-Length: 1677

{
"DocumentLines": [

{
"Number":1,
"ProductId": "05ac4686-fc64-4686-81d3-97a30454e005",
"ProductName":"V20-BATTERY",
"Details":"",
"UnitPrice":2,
"Qty":1,
"CurrencySymbol":"₪",
"Rate":1.0,
"Rebate":0.0,
"ChargeVAT":true
}
,
{
"Number":2,
"ProductId": "87317dfe-bbca-479d-b0ed-70f74c277e0a",
"ProductName":"LG5-BATTERY",
"Details":"",
"UnitPrice":12,
"Qty":1,
"CurrencySymbol":"₪",
"Rate":1.0,
"Rebate":0.0,
"ChargeVAT":true
}
,
{
"Number":3,
"ProductId": "3243c8d5-cc17-4cbd-8de7-bda64cbbbd70",
"ProductName":"GLX4-BATTERY",
"Details":"",
"UnitPrice":12,
"Qty":1,
"CurrencySymbol":"₪",
"Rate":1.0,
"Rebate":0.0,
"ChargeVAT":true
}
,
{
"Number":4,
"ProductId": "3dbf69ef-9b0e-4ee0-a4c5-becae7a35daf",
"ProductName":"SAM7",
"Details":"",
"UnitPrice":24,
"Qty":10,
"CurrencySymbol":"₪",
"Rate":1.0,
"Rebate":0.0,
"ChargeVAT":true
}
,
{
"Number":5,
"ProductId": "5220834b-d72a-4a39-b8f4-f6f7d14956b4",
"ProductName":"SAM13",
"Details":"",
"UnitPrice":30,
"Qty":1,
"CurrencySymbol":"₪",
"Rate":1.0,
"Rebate":0.0,
"ChargeVAT":true
}

],
"DocumentId":"DEMO_2021_04_06_0134",
"TrxTypeId": 1,
"Date":"2021-04-06T01:49:55",
"CustomerId":"Bfirst_6065ADD5-4258-4D9D-8DF7-67C01262DA77",
"CustomerBusinessName":"ירון ביילין",
"CustomerOsekMorshe":"",
"CustomerContactName":"",
"CustomerAddress1":"",
"CustomerAddress2":"",
"CustomerCity":"",
"CustomerPostalCode":"",
"CustomerEmail":"",
"Details":"",
"Comments":"",
"Rebate":0.00,
"RountTotal":false,
"TaxDeduction":0.00,
"ReceiptCurrencySymbol":"₪",
"ReceiptRate":1.00,
"ReceiptLines":[],
"TrxCode":null,
"TrxCodeNumber": 3,
"DueDate":null

}

תשובה מכספית:

{
    "DocumentId": "DEMO_2021_04_06_0134",
    "DocumentNumberBranch": 98,
    "TrxTypeId": 16,
    "Number": "98/10086",
    "Date": "2021-04-06T01:49:55",
    "CustomerId": "Bfirst_6065ADD5-4258-4D9D-8DF7-67C01262DA77",
    "CustomerBusinessName": "ירון ביילין",
    "CustomerOsekMorshe": "",
    "CustomerContactName": "",
    "CustomerAddress1": "",
    "CustomerAddress2": "",
    "CustomerCity": "",
    "CustomerPostalCode": "",
    "CustomerCountry": null,
    "CustomerEmail": null,
    "MobilePhone": null,
    "Details": "",
    "Comments": "ההצעה בתוקף ל-30 יום.",
    "TotalLinesChargeVAT": 296.00,
    "Rebate": 0.0,
    "RebatePercent": 0.0,
    "RountTotal": false,
    "RebateRounding": 0.0,
    "TotalBeforeVAT": 296.00,
    "TotalBeforeVATChargeVAT": 296.00,
    "TotalNoChargeVat": 0.00,
    "Vat": 50.3200,
    "Total": 346.3200,
    "EffectiveTotal": 346.3200,
    "VatRate": 17.00,
    "Payment": 0.0,
    "TaxDeduction": 0.0,
    "TotalPayment": 0.0,
    "ReceiptCurrencySymbol": "₪",
    "ReceiptRate": 1.0,
    "TaxDeductionNIS": 0.0,
    "PaymentNIS": 0.0,
    "TotalPaymentNIS": 0.0,
    "DocumentLines": [
        {
            "Number": 1,
            "ProductId": null,
            "ProductCatalogNumber": null,
            "ProductName": "V20-BATTERY",
            "Details": null,
            "UnitPrice": 2.0,
            "Qty": 1.0,
            "CurrencySymbol": "₪",
            "Rate": 1.0,
            "Rebate": 0.0,
            "ExtendedPrice": 2.0,
            "ChargeVAT": true,
            "VATRate": 17.00,
            "VAT": 0.34
        },
        {
            "Number": 2,
            "ProductId": null,
            "ProductCatalogNumber": null,
            "ProductName": "LG5-BATTERY",
            "Details": null,
            "UnitPrice": 12.0,
            "Qty": 1.0,
            "CurrencySymbol": "₪",
            "Rate": 1.0,
            "Rebate": 0.0,
            "ExtendedPrice": 12.0,
            "ChargeVAT": true,
            "VATRate": 17.00,
            "VAT": 2.04
        },
        {
            "Number": 3,
            "ProductId": null,
            "ProductCatalogNumber": null,
            "ProductName": "GLX4-BATTERY",
            "Details": null,
            "UnitPrice": 12.0,
            "Qty": 1.0,
            "CurrencySymbol": "₪",
            "Rate": 1.0,
            "Rebate": 0.0,
            "ExtendedPrice": 12.0,
            "ChargeVAT": true,
            "VATRate": 17.00,
            "VAT": 2.04
        },
        {
            "Number": 4,
            "ProductId": null,
            "ProductCatalogNumber": null,
            "ProductName": "SAM7",
            "Details": null,
            "UnitPrice": 24.0,
            "Qty": 10.0,
            "CurrencySymbol": "₪",
            "Rate": 1.0,
            "Rebate": 0.0,
            "ExtendedPrice": 240.0,
            "ChargeVAT": true,
            "VATRate": 17.00,
            "VAT": 40.80
        },
        {
            "Number": 5,
            "ProductId": null,
            "ProductCatalogNumber": null,
            "ProductName": "SAM13",
            "Details": null,
            "UnitPrice": 30.0,
            "Qty": 1.0,
            "CurrencySymbol": "₪",
            "Rate": 1.0,
            "Rebate": 0.0,
            "ExtendedPrice": 30.0,
            "ChargeVAT": true,
            "VATRate": 17.00,
            "VAT": 5.10
        }
],
"ReceiptLines": [],
"TrxCode": "הכנסות/מכירות",
"TrxCodeNumber": 3,
"Status": 0,
"DueDate": "2021-05-31T00:00:00",
"RowVersion": "AAAAAAXw7QI=",
"LinkToPdf": "https://app.caspitweb.biz:443/api/v1/Pdf/DEMO_2021_04_06_0134?token=_REPLACE_WITH_YOUR_TOKEN_",
"ViewUrl": null,
"PaymentUrl": null,
"DateCreated": "2021-04-07T01:36:50.73",
"UserCreated": "Anonymous",
"DateUpdated": "2021-04-07T01:36:52.7420718+03:00",
"UserUpdated": "Anonymous"
}

הדפסה של מסמך

לא ניתן ממש להדפיס את המסמך לנייר. אבל אפשר "להדפיס" במובן שכספית תפעיל את הלוגיקה של ההדפסה (חישוב סכום המסמך, נעילה שלו, וכו') ואז לקבל מכספית קובץ PDF ובו המסמך.

POST /api/v1/PrintDocument/?Token=840BE2CC6E288F1CB4E88D462DDB72E63EEB6B6D7A92850D&id=DEMO_2021_04_06_0147 HTTP/1.1
Host: app.caspitweb.biz

התשובה היא קובץ PDF

%PDF-1.6
%����
1 0 obj
<< /Creator(Telerik Reporting 10.1.16.504 \(http://www.telerik.com/products/reporting.aspx\)) /CreationDate(D:20210407042924+03'00') /Producer(Telerik Reporting 10.1.16.504 \(http://www.telerik.com/products/reporting.aspx\)) >>
endobj ... ... ... trailer
<</ID [<f2070a725d1fdfe28531630174b1b62d><f2070a725d1fdfe28531630174b1b62d>]/Info 1 0 R/Prev 69718/Root 2 0 R/Size 28>>
%iText-7.1.10 for .NET
startxref
87817
%%EOF

משלוח מסמך במייל

POST /api/v1/EmailDocument/DEMO_2021_04_06_0147?token=840BE2CC6E288F1CB4E88D462DDB72E63EEB6B6D7A92850D HTTP/1.1
Host: app.caspitweb.biz
Content-Type: application/json
Cookie: .Stackify.Rum=5d997583-
Content-Length: 98

{Subject: "בדיקה 1443", To: "dror@caspit.biz", Body: "שלום, 
רצב מסמך מכספית 
צוות כספית"}
"Document sent to: dror@caspit.biz"

שליפת ערך המע"מ

שליפה של שיעור המע"מ ביום 2020-02-14.

בדוגמה זו שלחנו את האסימון ב-Query. ניתן לשלוח אותו ב-Query או ב-Header כמו בדוגמאות הקודמות.

GET /api/v1/VatRate?token=D79C00E804FDB078A4DD62E25A9319D8AFCBBC607C42ADAF&date=2020-02-14 HTTP/1.1
Host: app.caspitweb.biz

המשמעות של התשובה היא שתאריך השינוי האחרון של שיעור המע"מ לפני יום 2020-02-14 היה ביום 2015-10-01 ומאז יום זה שיעור המע"מ הוא 17%.

{
"CurrentPage": 0,
"TotalCount": 1,
"TotalPages": 1,
"PrevPageUrl": null,
"NextPageUrl": null,
"Results": [
{
"StartDate": "2015-10-01T00:00:00",
"VatRatePercent": 17.00,
"DateCreated": null,
"UserCreated": null,
"DateUpdated": null,
"UserUpdated": null
}
]
}

שליפה של רשומות פריטים

שליפה של רשימת הפריטים בכספית:

GET /api/v1/products/?token=840BE2CC6E288F1CB4E88D462DDB72E63EEB6B6D7A92850D HTTP/1.1
Host: app.caspitweb.biz
{
"CurrentPage": 0,
"TotalCount": 100,
"TotalPages": 2,
"PrevPageUrl": "",
"NextPageUrl": "https://app.caspitweb.biz/api/v1/products?page=1&token=840BE2CC6E288F1CB4E88D462DDB72E63EEB6B6D7A92850D",
"Results": [
{
"ProductId": "e5645243-7780-4573-921d-947fb5aa3e73",
"Name": " AEUADV1",
"Description": "EU ADAPTOR",
"NameEnglish": null,
"DescriptionEnglish": null,
"Comments": null,
"SerialNumber": null,
"CatalogNumber": "8887754",
"SupplierCatalogNumber1": null,
"SupplierCatalogNumber2": null,
"SupplierCatalogNumber3": null,
"Status": true,
"Warranty": null,
"PurchasePrice": 0.0000,
"SalePrice1": 34.0000,
"SalePrice2": 560.0000,
"SalePrice3": 0.0000,
"SalePrice4": 0.0000,
"ChargeVat": false,
"CurrencySymbol": "₪",
"QtyInStock": 20.00,
"MinQtyInStock": 10.0000,
"MaxQtyInStock": 0.0000,
"UnitName": null,
"Class": "ACCESSORIES",
"IsPriceIncludeVat": false,
"DateCreated": null,
"UserCreated": null,
"DateUpdated": null,
"UserUpdated": null
}, ... 49 more records

שליפה של רשומות לוג

הלוג של כספית מכיל מידע עבור שגיאות הפעלה, משלוח מייל ללקוחות ומידע אחר. כאשר מתרחשת שגיאה במהלך קיראת ה-API כספית תחזיר לך סטטוס שגיאה (לדוגמה 500) ואת מספר הרשומה בלוג. בכדי להבין את השגיאה שלוף את הרשומה המתאימה.

GET /api/v1/log?logid=9557542&token=E6A766A8E7B4A6B0F84F494541AED58425D4582955C88E1C HTTP/1.1
Host: app.caspitweb.biz
{
"CurrentPage": 0,
"TotalCount": 1,
"TotalPages": 1,
"PrevPageUrl": "",
"NextPageUrl": "",
"Results": [
{
"LogId": 9557542,
"LogType": 4,
"Source": 6,
"ObjectType": 58,
"ObjectId": 817,
"Content": "Invalid Token. Timeout. Token: CDBCF85AD43205B888FE3EB3CC41FAB43436FCAC5D219188",
"UserName": "demo",
"IP": "87.68.211.172",
"DateCreated": "2021-02-23T23:27:02.39",
"UserCreated": null,
"DateUpdated": "2021-02-23T23:27:02.747",
"UserUpdated": null
}
]}