Version: Latest (2.0.0)

Import Receipts

Method	Description
createReceipt	Imports and updates newreceipts
deleteReceipt	Deletes receipt from tables
getReceipt	Request receipt and/or tax receipt from tables
restoreReceipt	Restore receipt from tables

Create Receipt

REST API /docsApi/v2/createReceipt

The following parameters should be included in a rows object (see example below)

Parameters	Description	Parameter Options/value	Default
flagwarnings	A flag indicating whether to display warnings	true / false	true
main_info Required	stock- (object name contains data)	See table below
pay_types Required	Payment methods - 'cheque', 'cash', 'backDeposit', 'credit'	See tables below

JSON Body Example

{
    "rows": {
        "flagwarnings": true,
        "main_info": {
           ...
        },
        "pay_types": {
            "cheque": {
                "chequesArr": [
                    {
                      ...
                    }
                ]
            },
            "cash": {
                ...
            },
            "bankDeposit": {
               ...
            },
            "credit": {
                ...
            }
        }
    }
}
    

Receipts Data

The following parameters should be included in a main-info object (see example below)

Name-trans	Type	Description	תיאור	Default
StockID	Integer number	מזהה טבלת stock. כאשר מעדכנים מסמך, חייבים להעביר מזהה. i אם שולחים StockID אמצעי התשלום הקיימים ידרסו ע"י מה שנשלח בעדכון.	ID in the stock table. Required when updating an existing document. i When sending a StockID, the existing payment methods will be overwritten by what is sent in the update.	0
doccurr	string max (5) values	מטבע	Currency	From company definition
accountkey Required	string max(15)	מפתח חשבון	Account key
identity	string max(9)	ת.ז.	ID	null
fullname	string max(50)	שם חשבון	Account fullname	From account definition
address	string max(50)	כתובת	Address	From account definition
city	string max(50)	עיר	City	From account definition
phone	string max(30)	טלפון	Phone	From account definition
remark	string max(250)	הערות	Remarks	""
DocNumber	Integer number	מספר המסמך. הספרור של מסמכים בעלי ספרור קשיח נקבע בעת ההפקה	Document number. When the document numeration isunchangeable, the number is determined when the document is issued.	From company definition
documentid Required	Integer number	סוג מסמך (לפי הגדרות בטבלת DocumentsDef)	Document type (according to the DocumentDef table)
contact	string max(30)	איש קשר	contact	""
email	string max(200)	כתובת דוא"ל שידור כתובת מייל אומר שליחת מקור למייל לא משנה מה מוגדר בחשבון (הפקה לא דיגיטלית או שליחה במייל לאחר תצוגה)	E-Mail address Sending an email address means the source will be sent to it regardless of what is defined the account (non-digital production or sending by email after display)	""
costcode	string max(8)	קוד תמחיר קיים	Existing cost center code	""
issueStock	boolean	הפקת המסמך	Issue the document	TRUE
deleteTemp	if errors found, delete document or not	true / false	false
Copies	Integer number	מספר עותקים להדפסה	Number of print copies	From company definition
PrintStyle	Integer number	מזהה פורמט הדפסה	Print format ID	From company definition
Ref3	Integer number	אסמכתא 3	Reference-3	0
sourceTax	Integer number	סכום ניכוי במקור ע"י לקוחות בש"ח	Withholding tax amount by customers in NIS	0
sourceTaxPrc	Integer number	אחוז ניכוי במקור ע"י לקוחות	Withholding tax percent by customers	0
taxSumDlr	Integer number	סכום ניכוי במקור ע"י לקוחות משוערך	Estimated amount of withholding tax by customers	0
sourceTaxRate	Integer number	שער ניכוי במקור	Withholding tax rate	0

Payment Methods

The following parameters should be included in a pay_types object (see example below)

Cash

The following parameters should be included in a cash object (see example below)

Name-trans	Type	Description	תיאור	Default
suf Required	Float number	הסכום שהתקבל	The amount received
sufDlr	Float number	סכום משוערך	Reevaluated amount	0
currencyDlr Required for foreign currency documents	string max(5) values	מטבע השיערוך	The revaluation currency	From company definition
details	string max(20)	פרטים	details	""
customerId Required	string max(20)	ת.ז לקוח	customer Id

JSON Example for a cash payment

{
    "rows": {
        "flagwarnings": true,
        "main_info": {
            "accountKey": "30002",
            "documentid": "31",
            "issueStock": true
        },
        "pay_types": {
            "cash": {
                "suf": "10"
            }
        }
    }
}

Credit

tip

Automatic (instant) Credit Payment

Click here for a full explanation and examples of importing receipts with an automatic credit card payment.

Manual Credit Payment

The following parameters should be included in a credit object (see example below)

Name-trans	Type	Description	תיאור	Default
maunualcreditflag	boolean	דגל המציין האם אשראי ידני / רגיל: 1= ידני 0= רגיל	A flag indicating whether the credit is manual or regular: 1= manual 0=regular	0
masofid	smallint	מספר מסוף	masof (terminal) id	Manual/default terminal
suf Required	float number	סכום	sum	0
fstarstotal	float number	סכום כוכבים /מיילים /נקודות		0
type	string max(50)	סוג תשלום	Type of payment	Default
payments	smallint	מספר תשלומים	Number of payments	Defined by card type
firstpayment	float number	תשלום ראשון	First Payment	Calculated based on number of payments
paymentssum	float number	תשלום קבוע	Fixed payment	Calculated based on number of payments
fvoucher	string max(7)	מספר אישור	confirmation number
fshovar	integer number	מספר שובר	shovar number	0
creditfirm	string max(50)	חברת אשראי	credit Company	Default
last4dig Required	string max(4)	4 ספרות אחרונות	Last 4 digits
fvalidmonth	string max(2)	תוקף חודש	valid month	Current month
fvalidyear	string max(2)	תוקף שנה	valid year	Current year
fid	string max(60)	ת.ז (באשראי ידני)		""
details	string max(250)	פרטים	details	""
sufdlr	float number	סכום משוערך	Reevaluated amount	0
currencydlr Required for foreign currency documents	string max(5) values	מטבע השערוך	The revaluation currency	From company definition
istoken	boolean	הפקה ללא חלון תשלום	if true, make a transaction without a payment window read more about Tokenization	false

JSON Example for a credit payment

{
    "rows": {
        "flagwarnings": true,
        "main_info": {
            "accountKey": "30002",
            "documentid": "31",
            "issueStock": true
        },
        "pay_types": {
             "credit": {
                "maunualcreditflag": 1,
                "suF": 100,
                "fvoucher": 3659,
                "last4dig": "6598",
                "payments": "3",
                "type": "תשלומים",
                "firstpayment": 30,
                "paymentssum": 35,
                 "istoken": true
            }
        }
    }
}

Cheque

The following parameters should be included in a cheque object (see example below)

Name-trans	Type	Description	תיאור	Default
pikadonFlag	bool	זיכוי קופת שיקים לפיקדון במקום קופת שיקים ברירת מחדל	Use deposit instead of regular registry	false
chequesArr Required	See table below	מערך של שיקים	Array of cheques

The following parameters should be included in a chequesArr array (see example below)

Name-trans	Type	Description	תיאור	Default
cheqnumber Required	integer number	מספר שק	cheque number
banknumber Required	string max(2)	מספר בנק	bank number
branch Required	string max(3)	סניף	branch
bankaccnum Required	string max(20)	מספר חשבון בנק	Bank account number
valuedate	datetime	תאריך	date	תאריך נוכחי
suf Required	float number	סכום	sum
sufdlr	float number	סכום משוערך	Reevaluated amount	0
CurrencyDlr	string max(5) values	מטבע	currency	From account definition
details	string max(20)	פרטים	sdetails	""
customerid	string max(11)	ת.ז. לקוח	customer id	From account definition

JSON Example for a cheque payment

{
    "rows": {
        "flagwarnings": true,
        "main_info": {
            "accountKey": "30002",
            "documentid": "31",
            "issueStock": true
        },
        "pay_types": {
                    "cheque": {
                "chequesArr": [
                    {
                        "CheqNumber": "125545",
                        "BankNumber": "12",
                        "Branch": "5",
                        "BankAccNum": "785",
                        "ValueDate": "2020-01-02",
                        "Suf": "60",
                        "SufDlr": "3.56",
                        "CurrencyDlr": "$",
                        "Details": ""
                    },
                    {
                        "CheqNumber": "125547",
                        "BankNumber": "12",
                        "Branch": "5",
                        "BankAccNum": "785",
                        "ValueDate": "2020-01-02",
                        "Suf": "100",
                        "SufDlr": "3.56",
                        "CurrencyDlr": "$",
                        "Details": ""
                    }
                ]
            }
        }
    }
}

Bank Deposit

The following parameters should be included in a bankDeposit object (see example below)

Name-trans	Type	Description	תיאור	Default
suf Required	float number	סכום	sum	0
sufdlr	float number	סכום משוערך	Reevaluated amount	0
currencydlr Required for foreign currency documents	string max(5) values	מטבע השערוך	The revaluation currency	From account definition
bankacc Required	string max(15)	מספר חשבון בנק	Bank accoun
duedate	datetime	תאריך ערך	due date	Current date
details	string max(40)	פרטים	details	""

JSON Example for a bank deposit payment

{
    "rows": {
        "flagwarnings": true,
        "main_info": {
            "accountKey": "30002",
            "documentid": "31",
            "issueStock": true
        },
        "pay_types": {
                "bankDeposit": {
                "suf": "14",
                "bankAcc": "10002"
            }
        }
    }
}

JSON Example

{
    "rows": {
        "flagwarnings": true,
        "main_info": {
            "accountKey": "30002",
            "documentid": "31",
            "issueStock": true
        },
        "pay_types": {
            "cheque": {
                "chequesArr": [
                    {
                        "CheqNumber": "125545",
                        "BankNumber": "12",
                        "Branch": "5",
                        "BankAccNum": "785",
                        "ValueDate": "2020-01-02",
                        "Suf": "60",
                        "SufDlr": "3.56",
                        "CurrencyDlr": "$",
                        "Details": ""
                    },
                    {
                        "CheqNumber": "125547",
                        "BankNumber": "12",
                        "Branch": "5",
                        "BankAccNum": "785",
                        "ValueDate": "2020-01-02",
                        "Suf": "100",
                        "SufDlr": "3.56",
                        "CurrencyDlr": "$",
                        "Details": ""
                    },
                    {
                        "CheqNumber": "127545",
                        "BankNumber": "17",
                        "Branch": "5",
                        "BankAccNum": "785",
                        "ValueDate": "2020-01-02",
                        "Suf": "40",
                        "SufDlr": "3.56",
                        "CurrencyDlr": "$",
                        "Details": ""
                    }
                ]
            },
            "cash": {
                "suf": "10"
            },
            "bankDeposit": {
                "suf": "14",
                "bankAcc": "10002"
            },
            "credit": {
                "maunualcreditflag": 1,
                "suF": 100,
                "fvoucher": 3659,
                "last4dig": "6598",
                "payments": "3",
                "type": "תשלומים",
                "firstpayment": 30,
                "paymentssum": 35
            }
        }
    }
}
    

createReceipt OutputData

Name	Options
statuscode	200 (OK) / 500 (error)
stockid	New stockid
docnumber	Document number
docurl	Email destination or dispatch text (e.g. send-to address)
pdf	PDF file URL
errtax	Tax-related message or status (e.g. “Bad Request”)
data	All JSON data

For a temporary document:

Name	Options
statuscode	200 (OK) — success and temporary-document responses 500 (error) — error responses
stockid	New stockid
message	הקבלה עודכנה למאגר זמני
data	All JSON data

JSON Output Examples

Success

{
    "statuscode": 200,
    "stockid": 49209,
    "docnumber": 1425,
    "docurl": "send to eiman.sultane@gmail.com",
    "pdf": "https://michalf22.wizcloud.co.il/IWIZ/HTMC9E1_wizdb7n86_49209_2251426854.pdf",
    "errtax": "Bad Request",
    "data": {
        "main_info": {
            "stockid": 49209,
            "documentid": 31,
            "docnumber": 1425,
            "status": 1,
            "accountkey": "30002",
            "accountname": "new acc",
            "address": "קניון איילון *",
            "city": null,
            "phone": "03-7458123",
            "batch": 9999,
            "valuedate": "2026-02-24",
            "duedate": "2026-02-24",
            "paydate": "2026-02-24",
            "copies": 1,
            "discountprc": 0,
            "tftal": 1,
            "vatprc": 0,
            "tftalvatfree": 0,
            "tftalvat": 0,
            "reference": null,
            "remarks": "הערה כללית למסמך חוזה 241 עבור 02/26",
            "printstyle": 0,
            "details": "",
            "agent": 3,
            "currency": "ש\"ח",
            "rate": 0,
            "mainrate": 0,
            "issuedate": "2026-02-24",
            "taxapinumber": null,
            "email": "eiman.sultane@gmail.com"
        },
        "payment": {
            "bankdeposit": {
                "suf": 1,
                "sufdlr": 0.32247662044501774,
                "currencydlr": "$",
                "bankacc": "10001",
                "duedate": "2026-02-24",
                "details": ""
            }
        }
    }
}

Error

{
    "status": "error",
    "statusCode": 500,
    "errors": [
        {
            "text": "account 3000j2 is not valid",
            "type": "error"
        }
    ],
    "data": {
        "main_info": {
            "accountkey": "3000j2",
            "conid": 241,
            "copies": 1,
            "deletetemp": true,
            "doccurr": "ש\"ח",
            "documentid": 54,
            "issuestock": false,
            "periodfromdate": "2026-02-03",
            "periodtodate": "2026-03-02",
            "remark": "הערה כללית למסמך חוזה 241 עבור 02/26"
        },
        "payment": {
            "bankdeposit": {
                "bankacc": "10001",
                "currencydlr": "$",
                "suf": 1,
                "sufdlr": 0.32247662044501774
            }
        }
    }
}

Temporary document

{
    "statuscode": 200,
    "stockid": 49215,
    "message": "הקבלה עודכנה למאגר זמני",
    "data": {
        "main_info": {
            "stockid": 49215,
            "documentid": 31,
            "docnumber": 1428,
            "status": 0,
            "accountkey": "30002",
            "accountname": "new acc",
            "address": "קניון איילון *",
            "city": null,
            "phone": "03-7458123",
            "batch": 9999,
            "valuedate": "2026-02-25",
            "duedate": "2026-02-25",
            "paydate": "2026-02-25",
            "copies": 1,
            "discountprc": 0,
            "tftal": 1,
            "vatprc": 0,
            "tftalvatfree": 0,
            "tftalvat": 0,
            "reference": null,
            "remarks": "הערה כללית למסמך חוזה 241 עבור 02/26",
            "printstyle": 0,
            "details": "",
            "agent": 3,
            "currency": "ש\"ח",
            "rate": 0,
            "mainrate": 0,
            "issuedate": "2026-02-25",
            "taxapinumber": null,
            "email": "eiman.sultane@gmail.com"
        },
        "payment": {
            "bankdeposit": {
                "suf": 1,
                "sufdlr": 0.32247662044501774,
                "currencydlr": "$",
                "bankacc": "10001",
                "duedate": "2026-02-25",
                "details": ""
            }
        }
    }
}

Delete Receipt

Deletes receipt from tables

REST API docsapi/delReceipt/

Parameters	Type	Description
StockID Required	Integer number	ID in the stock table

JSON Example

{
  "stockID": 626
}

Output Data

{ 
  statusCode: 200, 
  message: 'המסמך נמחק בהצלחה' 
}

Get Receipt

Request receipt and/or tax receipt from tables

REST API docsapi/getReceipt/

Parameters	Type	Description
StockID Required	Integer number	ID in the stock table

JSON Example

{
  "stockID": 626
}

Output Data

{ 
  statusCode: 200, 
  data: req.data
}

Restore Receipt

Restore receipt from tables

REST API docsapi/restoreDoc/

Parameters	Type	Description
doctype Required	Integer number	Document type (according to the DocumentDef table)
StockID Required	Integer number	ID in the stock table

JSON Example

{
  "stockID": 626,
  "doctype": 4
}

Output Data

Success:

{ 
   status: 200 , 
   fileName: 'קישור למסמך'
}

Error:

{ 
   status:500, message:errors : "" 
}
        

Create Receipt​

JSON Body Example​

Receipts Data​

Payment Methods​

Cash​

Credit​

Automatic (instant) Credit Payment​

Manual Credit Payment​

Cheque​

Bank Deposit​

JSON Example​

createReceipt OutputData​

For a temporary document:​

JSON Output Examples​

Delete Receipt​

JSON Example​

Output Data​

Get Receipt​

JSON Example​

Output Data​

Restore Receipt​

JSON Example​

Output Data​

Create Receipt

JSON Body Example

Receipts Data

Payment Methods

Cash

Credit

Automatic (instant) Credit Payment

Manual Credit Payment

Cheque

Bank Deposit

JSON Example

createReceipt OutputData

For a temporary document:

JSON Output Examples

Delete Receipt

JSON Example

Output Data

Get Receipt

JSON Example

Output Data

Restore Receipt

JSON Example

Output Data