Import Documents

NodeJS Example File

DocumentApiExample.js

Method	Description
createDoc	Imports and updates new or already existing temporary documents
issueDocument	Check issue and input the document to the permanent storage
delDocument	Delete document from tables
addLineDoc	Add a line or multiple to a temporary document
delLine	Delete a line or multiple from a temporary document
getDoc	Show document data
invoiceDecision	In case of error 460 Invoice Rejection from the Tax Authority
restoreDoc	Restore a specific document

Creating Documents

Imports and updates new or already existing temporary documents. You may check for errors or issue and input the documents into the permanent storage (if no errors were found).

REST API	`invApi/createDoc`
NodeJS	`createDocument`

Parameters	Description	Parameter Options/value	Default value
issueStock	issue the document	true / false	false
deleteTemp	if errors found, delete document or not	true / false	false
rows Required	document data object	See table below
moves Required	sub-transactions array for each `rows` array	See table below
matrix	sub-transactions array for each `moves` array	See table below

JSON Body Example

{
   ...
   
    "rows": { 
      ...  
        "moves": [ 
            { ... }, 
            { ... 
              "matrix": [
                {
                ...
              }
              ]
            } 
        ] 
    }
}

FieldName-stock

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

FieldName-stock	Type	Description	תיאור	Default Value
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
DocumentID Required	Integer number	סוג מסמך (לפי הגדרות בטבלת DocumentsDef)	Document type (according to the DocumentDef table)
DocNumber	Integer number	מספר המסמך. הספרור של מסמכים בעלי ספרור קשיח נקבע בעת ההפקה	Document number. When the document numeration is unchangeable, the number is determined when the document is issued.	1
AccountKey Required	String (max 15)	מפתח חשבון (לקוח/ספק)	The customer or supplier account key

Additional fields

AccountName	String (max 50)	שם חשבון	Account name	null
Address	String (max 100)	כתובת	Address	null
City	String (max 50)	עיר	City	null
Phone	String (max 30)	טלפון	Phone	null
ValueDate	Date string – yyyy-mm-dd	תאריך	Date	null
DiscountPrc	Float number	אחוז הנחה כללית במסמך	% of general discount	null
Tftal	Float number	סכום כולל של מסמך	Total amount	null
SumDiscount	Float number	סכום ההנחה במסמך	The discount amount	null
Ref3	Integer number	אסמכתא 3	Reference-3	0
Remarks	String (max 250)	הערות	Remarks	null
Details	String (max 250)	פרטים	details	null
Warehouse	Integer number	מחסן	Warehouse	null
Agent	Integer number	סוכן	Salesperson	null
CostCode	String (max 8)	קוד תמחיר קיים	Existing cost center code	null
Quantity	Float number	כמות	Quantity	0
Osek874	String (max 9)	עוסק מורשה	VAT registration number	null
InterFlag	Integer number	קליטת נתונים בחנות וירטואלית	Import data for virtual store	0
Email	String (max 45)	כתובת דוא"ל	E-Mail address	null
TransAgent	number	העברה בין מחסנים: סוכן מקור	Transfer between warehouses: Source agent	0
TransStore	number	העברה בין מחסנים: מחסן מקור	Transfer between warehouses: Source warehouse	1
CurrencyCode	string(5) values	מטבע	currency	null
MainRate	number	שער למטבע המסמך	currency rate	null
EvalCurrencyCode	string(5) values	מטבע לשערוך	The revaluation currency	null
Rate	number	שער לשערוך בהנהח"ש	Rate for revaluation	null
ExtraText1	String(max 50)	הערה נוספת 1	Extra text 1	null
ExtraText2	String(max 50)	הערה נוספת 2	Extra text 2	null
ExtraText3	String(max 50)	הערה נוספת 3	Extra text 3	null
ExtraText4	String(max 50)	הערה נוספת 4	Extra text 4	null
ExtraText5	String(max 50)	הערה נוספת 5	Extra text 5	null
ExtraSum1	Float number	סכום נוסף 1	Extra sum 1	null
ExtraSum2	Float number	סכום נוסף 2	Extra sum 2	null
ExtraSum3	Float number	סכום נוסף 3	Extra sum 3	null
ExtraDate1	Date string – yyyy-mm-dd	תאריך נוסף 1	Extra date 1	null
ExtraDate2	Date string – yyyy-mm-dd	תאריך נוסף 2	Extra date 2	null
ExtraNum1	Integer number	מספר נוסף 1	Extra number 1	null
ExtraNum2	Integer number	מספר נוסף 2	Extra number 2	null
Copies	Integer number	מספר עותקים להדפסה	Number of print copies	From company definition
PrintStyle	Integer number	מזהה פורמט הדפסה	Print format ID	From company definition
taxnum	Integer number	מספר הקצאה (חשבונית רכש, חשבונית שריון ספק וחשבונית סוכן)	Allocation number (Purchase invoice, supplier reserve invoice and agent invoice)	null
cancelvat	boolean	ביטול מע"מ	Cancel VAT	0
new_round	numeric (0-3)	שיטת העיגול במסמך: 0 - ללא עיגול 1 - עיגול לעשרות אגורות 2 - עיגול לשקלים 3 - עיגול לעשרות שקלים	Rounding method in document: 0 – No rounding 1 – Round to the nearest tenth of a monetary unit 2 – Round to the nearest whole monetary unit 3 – Round to the nearest ten monetary units	0
change_t	numeric (1-3)	1-מחשב סה"כ לפי %הנחה. 2-מחשב סה"כ לפי סכום הנחה. 3-מעדכן % הנחה לפי סה"כ במסך(Tftal).	1-Calculate total by % discount. 2-Calculate total by discount amount. 3-Updates % discount by total on screen(Tftal).	1

Sub-transactions for each StockID

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

Sub-transactions	Type	Description	תיאור	Default Value
StockID	Integer number	מזהה טבלת stock	ID in the stock table	0
MoveID	Integer number	מזהה טבלת stockmoves	ID in the stockmoves table	0
ItemKey Required	String (max 20)	מפתח פריט	Item key
ItemName	String (max 100)	שם פריט	Item name	null
Price	Float number	מחיר	Price	null
Quantity Required	Float number	כמות	Quantity

Additional fields

Tftal	Float number	סה"כ בשורה	Total amount of the line	null
DiscountPrc	Float number	% הנחה	% discount	null
Rate	Float number	שער	Currency rate	null
CurrencyCode	String(max 5) values	מטבע	Currency	null
CommitionPrc	Float number	% עמלה	% commission	null
LineNoForSorting	Integer number	מספור שורה	Line ID	null
Agent	Integer number	סוכן	Salesperson	null
Warehouse	Integer number	מחסן	Warehouse	null
Details	String(max 20)	פרטים	Details	null
costcode	String (max 8)	קוד תמחיר קיים	Existing cost center code	null
Counter				null
Reference	Integer number	אסמ2	Reference-2	0
packs	Float number	אריזות	Packs	null
alternum	String (max 18)	מספר חליפי	Alter num	null
DUEDATE	Date string – yyyy-mm-dd	תאריך ערך	Due date	null
unit	String(max 5)	יחידת מידה	Unit	null
ExtraText1	String(max 50)	הערה נוספת 1	Extra text 1	null
ExtraText2	String(max 50)	הערה נוספת 2	Extra text 2	null
ExtraSum1	Float number	סכום נוסף 1	Extra sum 1	null
ExtraSum2	Float number	סכום נוסף 2	Extra sum 2	null
ExtraDate1	Date string – yyyy-mm-dd	תאריך נוסף 1	Extra date 1	null
ExtraDate2	Date string – yyyy-mm-dd	תאריך נוסף 2	Extra date 2	null
BaseMoveId	number	מזהה שורת פריט במסמכי בסיס	id base stockmoves	0

Sub-transactions for each Matrix item

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

Sub-transactions	Type	Description	תיאור	Default Value
matrixsonkey	String (max 20)	מפתח פריט	Item key	""
matrixsonquantity	Float number	כמות	Quantity	0
matrixfatherkey	Float number	מפתח פריט האב	Father-item key	""

JSON Example

{
    "issueStock": "true",
    "deleteTemp": "false",
    "rows": {
        "StockID": 0,
        "DocumentID": 1,
        "DocNumber": 1,
        "AccountKey": "30005",
        "AccountName": "כיתנס",
        "Address": "מנחם בגין 169",
        "City": "תל אביב",
        "Phone": "0525554434",
        "ValueDate": "2021-11-11",
        "DiscountPrc": 15,
        "Remarks": "הערות בתחתית המסמך",
        "Warehouse": 2,
        "Agent": 20,
        "Osek874": 123456789,
        "moves": [
            {
                "ItemKey": "1004",
                "ItemName": "עציץ גוזמניה",
                "Price": 35,
                "Quantity": 4,
                "DiscountPrc": 10,
                "Rate": 3.5,
                "CurrencyCode": "$",
                "DUEDATE": "2021-01-25"
            },
            {
                "ItemKey": "1003",
                "ItemName": "סוקולנט",
                "Price": 20,
                "Quantity": 4,
                "Tftal": 70
            },
            {
               "matrix":  [
                    {
                        "matrixsonkey": "1453",
                        "matrixsonquantity": 5,
                        "matrixfatherkey": "1004"
                    }
                ]
            }
        ]
    }
}

Issuing Documents

Check issue and input the document to the permanent storage

REST API	`invApi/issueDocument`
NodeJS	`issueDoc`

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

JSON Example

{
  "stockID": 626
}

Deleting Documents

Delete document from tables

REST API	`invApi/delDocument`
NodeJS	`delDocument`

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

JSON Example

{
  "stockID": 626
}

Editing Documents

Adding a line

Add a line or multiple to a temporary document

REST API invApi/addLineDoc

Same parameters as in invApi/createDoc

row parameters	StockID is Required
move parameters

JSON Example

{
  "rows": [
    {
      "StockID": 22015,
      "AccountKey": "30000",
      "moves": [
        {
          "Price": 855,
          "ItemKey": "1",
          "ItemName": null,
          "Quantity": 1
        },
        {
          "Price": 400,
          "ItemKey": "1",
          "ItemName": null,
          "Quantity": 1
        }
      ],
      "DiscountPrc": "0",
      "Tftal": 1200
    }
  ]
}

Deleting a line

Delete a line or multiple from a temporary document

REST API invApi/delLine

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

JSON Example

{
  "stockid":22015,
  "moveid":3711499
}

Showing Documents

Show document data

REST API	`invApi/getDoc`
NodeJS	`showDocument`

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

JSON Example

{
  "stockID": 626
}

invoiceDecision

warning

If you receive error 460 Invoice Rejection from the Tax Authority, you need to send the following request:

REST API invApi/invoiceDecision

Parameters	Type	Description
action Required	Integer number	1 = cancel document 2 = continue issuing the document without the allocation number 3 = Chargeback 4 = Request a hearing

Restore Document

Restore a specific document

REST API	`restoreDoc`
REST API	`/inv_issue/restoreDoc`
NodeJS	`restoreDoc`

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

JSON Example

{
"StockID": 621599,
"DocType": 1
}

restoreDoc OutputData

Name	Options
statusCode	200 – OK / 500 - Errors
status
filePath	The document URL
errors	OK / Errors: "error description"

/inv_issue/restoreDoc OutputData

Name	Options
statusCode	200 – OK / 500 - Errors
status
filePath	The document URL
fileName	The document name
errors	OK / Errors: "error description"

Documents OutputData

Name	Options
NewDocumentStockID	New stockid
DocumentIssuedStatus	IsError:"error description" / OK / IN TEMP
TempDocumentDeleted	Yes / No
ErrorsOnDoc	For temp documents only
DocumentDetails	All document data

JSON Examples

 [
  {
        "NewDocumentStockID": 22771,
        "DocumentIssuedStatus": "OK",
        "DocumentDetails": [
            [
                {
                    "StockID": 22771,
                    "DocumentID": 78,
                    "DocNumber": 18067,
                    "status": 1,
                    "AccountKey": "20000",
                    "accountname": "ספק כללי",
                    "Address": null,
                    "City": null,
                    "Phone": null,
                    "batch": 9999,
                    "ValueDate": "2024-06-20",
                    "duedate": "2024-06-20",
                    "paydate": "2024-06-20",
                    "copies": 2,
                    "DiscountPrc": 0.025900025900005286,
                    "Tftal": 17.37,
                    "vatprc": 17,
                    "tftalvatfree": 0,
                    "tftalvat": 14.85,
                    "reference": null,
                    "remarks": null,
                    "printstyle": 1,
                    "Details": null,
                    "Agent": 0,
                    "currency": "ש\"ח",
                    "rate": null,
                    "mainrate": 1,
                    "issuedate": "2024-06-20"
                }
            ],
            [
                {
                    "StockID": 22771,
                    "moveid": 34762,
                    "itemkey": "1",
                    "itemname": "כללי",
                    "Warehouse": 1,
                    "Agent": 0,
                    "Details": null,
                    "duedate": "2024-06-20",
                    "status": 1,
                    "CurrencyCode": "ש\"ח",
                    "rate": 1,
                    "Price": 14.85,
                    "Quantity": 1,
                    "Tftal": 14.85,
                    "DiscountPrc": 0
                }
            ]
        ],
        "tax": "ok"
    }
]

Import Documents

Creating Documents​

JSON Body Example​

FieldName-stock​

Sub-transactions for each StockID​

Sub-transactions for each Matrix item​

JSON Example​

Issuing Documents​

JSON Example​

Deleting Documents​

JSON Example​

Editing Documents​

Adding a line​

JSON Example​

Deleting a line​

JSON Example​

Showing Documents​

JSON Example​

invoiceDecision​

Restore Document​

JSON Example​

restoreDoc OutputData​

/inv_issue/restoreDoc OutputData​

Documents OutputData​

JSON Examples​

Creating Documents

JSON Body Example

FieldName-stock

Sub-transactions for each StockID

Sub-transactions for each Matrix item

JSON Example

Issuing Documents

JSON Example

Deleting Documents

JSON Example

Editing Documents

Adding a line

JSON Example

Deleting a line

JSON Example

Showing Documents

JSON Example

invoiceDecision

Restore Document

JSON Example

restoreDoc OutputData

/inv_issue/restoreDoc OutputData

Documents OutputData

JSON Examples