NameDescriptionType/Additional information
DocumentId

The document's Id. You need to supply a unique Id that you will use to fetch or update the document.

string

0 - 50

DocumentNumberBranch

The document's branch number.
If you leave this field as null Caspit will use the default branck number of the API (which is 98)
Or you can send any other branch number you want: 1, 2, 3, ...

int32

TrxTypeId

See the enumeration in ApiGlobals.TrxTypes

int32

Required

Number

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

string

0 - 50

Date

תאריך המסמך

date

CustomerId

The document's customer id.

string

0 - 50

CustomerBusinessName

Customer's business name

string

0 - 200

CustomerOsekMorshe

מספר עוסק מורשה של הלקוח

string

0 - 20

CustomerContactName

שם איש הקשר -- ללקוח בכספית יכולים להיות 0, 1 או יותר אנשי קשר

string

0 - 100

CustomerAddress1

שורת כתובת1: שם הרחוב ומספר הבית

string

0 - 100

CustomerAddress2

שורת כתובת2: ת.ד., דירה, שכונה וכו'

string

0 - 100

CustomerCity

שם הישוב

string

0 - 100

CustomerPostalCode

המיקוד

string

0 - 20

CustomerCountry

שם המדינה של הלקוח

string

0 - 100

CustomerEmail

כתובת המייל של איש הקשר
השדה יכול להכיל כתובת אחת או מספר כתובות מופרדות בפסיק

string

0 - 100

MobilePhone

מספר הטלפון הנייד של איש הקשר

string

0 - 25

Details

פרטים שלא מוצגים ללקוח

string

0 - 1000

Comments

הערות שכן מוצגות ללקוח

string

0 - 5000

TotalLinesChargeVAT

סה"כ לפני מע"מ של שורות החשבונית (לאחר הנחת שורה), ולפני הנחות מסמך (=הנחה סתם, המחת עיגול) של הסכום שיש עליו מע"מ
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

Rebate

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

decimal

RebatePercent

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

decimal

RountTotal

אם תשלח false

boolean

RebateRounding

הנחת עיגול בש"ח
ההנחה יכולה להיות שלילית בכדי לעגל את סכום המסמך כלפי מעלה.
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

TotalBeforeVAT

decimal

TotalBeforeVATChargeVAT

סה"כ לפני מע"מ ואחרי הנחות (=הנחה סתם, המחת עיגול) של הסכום שיש עליו מע"מ
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

TotalNoChargeVat

סה"כ הסכום בש"ח שאין עליו מע"מ
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

Vat

המעמ בש"ח שנגבה במסמך
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

Total

סה"כ הסכום כולל מע"מ שנגבה במסמך
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

EffectiveTotal

הסכום "הפתוח" של החשבונית. כלומר הסכום שנותר לתשלום אחרי הפקת קבלה חלקית לחשבונית.
או יתרת התשלום לאחר הפקת חשבונית חלקית לקבלה.
לא בשימוש ביצירה/עדכון. מאוכלס בשליפה

decimal

VatRate

אחוז המעמ בחשבונית (17 מסמל 17%)
אם תשלח NULL אז השדה יאוכלס בערך המתאים לתאריך המסמך.

decimal

Payment

סכום התשלום

decimal

TaxDeduction

הניכוי במקור

decimal

TotalPayment

סה"כ שולם. שם לב, זהו הסכום הנומינלי ששולם.
כלומר, אם שולמו 40 דולר הערך בשדה יהיה 40 (ולא השווי בש"ח)
בכדי לקבל את הסכום ששולם בש"ח השתמש ב-TotalPaymentNIS

decimal

ReceiptCurrencySymbol

המטבע עבור חלק הקבלה
הסמלים הם ₪, $, €. יתכן שהמשתמש הוסיף גם מטבעות משלו

string

0 - 5

ReceiptRate

שער חליפין עבור חלק הקבלה

decimal

TaxDeductionNIS

ניכוי במקור בש"ח
מחושב לפי הסכום הנומינלי מוכפל בשער החליפין

decimal

PaymentNIS

שולם אחרי ניכוי במקור בש"ח
מחושב לפי הסכום הנומינלי מוכפל בשער החליפין

decimal

TotalPaymentNIS

סה"כ שולם בש"ח
מחושב לפי סה"כ התשלום הנומינלי מוכפל בשער החליפין

decimal

DocumentLines

שורות המסמך

Collection of

CaspitDocumentLine

שורה בחשבונית או במסמך דומה.

ReceiptLines

Collection of

CaspitReceiptLine

Represents a line in a Caspit receipt (קבלה) Note: Since we use the same fields to represent both check payments and a credit card payments some of the fields have multiple semantic meanings.

TrxCode

שמו של סיווג תנועה של המסמך. לדוגמה: "מכירות"

string

0 - 50

TrxCodeNumber

מספרו של סיווג תנועה של המסמך. לדוגמה: 3

int32

Status

See Globals.DocStatus

int32

DueDate

תאריך תשלום צפוי

date

RowVersion

This field is used to identify changes made to the Document by other user
When you update a socumend send the RowVersion value that you received when you fetched the document

Collection of byte

LinkToPdf

A link to the document's PDF

string

ViewUrl

A url which displayes the document's PDF
The field has a value only if the document was sent in the email

string

PaymentUrl

A URL to a payment page for an Invoice, Invoice Iska, Invoice Kabala
The field has value only if the business has a valid license to charge credit cards via Caspit

string

DateCreated

תאריך היצירה של הרשומה

date

UserCreated

שם המשתמש שיצר את הרשומה

string

Max length: 50

DateUpdated

תאריך העידכון האחרון של הרשומה

date

UserUpdated

המשתמש האחרון שעידכן את הרשומה

string

Max length: 50