NameDescriptionType/Additional information
PreAuthorizedDebitId

המפתח של הוראת הקבע

string

0 - 80

PreAuthorizedDebitNumber

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

int32

ContactId

המפתח של הלקוח שיחויב בהוראת הקבע
בהקמת הוראת קבע אתה יכול לשלוח את המפתח של הלקוח בשדה זה או בשדה CustomerId ב-Document

string

0 - 50

TemplateId

המפתח של המסמך שישמש תבנית לחשבונית של הוראת הקבע

string

0 - 50

InvoiceTemplate

המסמך שמשמש תבנית להוראת הקבע.
חובה לשלוח בהקמה של הוראת קבע

CaspitDocument

Represents a Caspit document (e.g. חשבונית מס, חש/קבלה, קבלה, תעודת משלוח) An invoice will only have DocumentLines, a receipt will only have ReceiptLines, a חש/קבלה will have both

Status

(int)ApiGlobals.PreAuthorizedDebitStatus.Active
Inactive = 0, Active = 1, Finished = 2, Deleted = 3
בהקמה ניתן לשלוח רק 0 או 1

int32

Required

ChargePeriod

תכיפות החיוב: שבועי, חודשי, רבעוני, חצי שנתי, שנתי
שבועי = 999, חודשי = 1, דו_חודשי = 2, תלת_חודשי = 3, חצי_שנתי = 6, שנתי = 12
Globals.PreAuthorizedDebitPeriods

int32

Required

DateStart

המועד שבו יש לבצע את החיוב הראשון.
כספית מחייבת בכל יום בשעה 6:30 בבוקר.
אם התאריך קודם ל-"היום" אז כספית תבצע חיוב אחד בכל יום עד להשלמת כל החיובים החסרים.

date

Required

DateEnd

מועד הסיום של החיובים.
כספית מחשבת את מועד הסיום כמועד ההתחלה + מספר החיובים X תדירות החיוב.
לדוגמה: אם מועד ההתחלה הוא 23/1/2019, וישנם 12 חיובים חודשיים, אז תאריך הסיום הוא 23/12/2019
שם לב שכספית מתעלמת ממועד הסיום שאתה שולח ומחשבת אותו לפי מה שהוסבר לעיל.

date

DateOfLastCharge

התאריך שבו בוצע החיוב האחרון של הוראת הקבע
שליפה בלבד

date

NumOfCharges

מספר החיובים שיש לבצע
בכדי לציין חיובים ללא תאריך סיום שלח 999

int32

Required

NumOfChargesAlreadyCharged

מספר החיובים עד כה
שליפה בלבד

int32

Description

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

string

Comments

הערות עבור המשתמש של כספית

string

0 - 2000

NextDocument

המסמך הבא שיופק לאחר חיוב: קבלה, חש/קבלה וכו'
Globals.PreAuthorizedDebitNextDocument: 0 = חש/קבלה, 2=קבלה, 3=קבלה לתרומה

int32

Required

NextDocumentTrxCodeId

סיווג התנועה של המסמך שיופק: 3-מכירות, וכו'

int32

Required

ChargeAmount

החיוב (החודשי, שנתי) בש"ח. נלקח מהתבנית
שליפה בלבד

decimal

IsActive

NumOfChargesAlreadyCharged < NumOfCharges
שליפה בלבד

boolean

DebitCharges

רשימה של חיובי אשראי שבוצעו עבור הוראת הקבע
שליפה בלבד

Collection of

CaspitPreAuthorizedDebitCharge

חיוב בכרטיס אשראי של הלקוח בעקבות הוראת קבע

FileName

File attached to the Debit
שליפה בלבד

string

0 - 500

TrxId

If this PreAuthorizedDebit was created via a SalesPage then this is the TrxId that was sent by the caller of the SalesPage
The TrxId is not used by Caspit but may be used by 3rd side systems that integrate with Caspit

string

DateCreated

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

date

UserCreated

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

string

Max length: 50

DateUpdated

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

date

UserUpdated

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

string

Max length: 50