Skip to main content

Import Indexes

NodeJS Example File

IndexApiExample.js

Import or Update Records

Imports or updates records to the selected index

REST APIIndexApi/importIndex
NodeJSimportIndexRecords

ParametersDescriptionParameter Options/valueDefault
myindex
Required
acc- for accounts
itm- for items
'acc'
'itm'
insertnewAllow inserting new records. If false only update is allowedtrue
false
false
rows
Required
items/accounts object arrayfor 'acc' - see table below
for 'itm' - see table below

JSON Body Example

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

Accounts Data

The following parameters should be included in a rows array when "myindex": "acc" (see example below)

FieldName-transTypeתיאורDescriptionDefaults
AccountKey
Required
String (max 15)מפתח חשבוןAccount key
FullNameString (max 50)שםNamenull
SortGroupInteger numberמיוןSorting code0
AddressString (max 50)כתובתAddressnull
CityString (max 20)עירCitynull
Additional fields
ZipString (max 10)מיקודZip codenull
CountryString (max 20)מדינהCountrynull
PhoneString (max 30)טלפוןPhonenull
FaxString (max 30)פקסFaxnull
BalanceCodeInteger number
values
קוד מאזןCode for the balance and profit and loss report68
CreditTermsCodeInteger numberקוד פיצול תשלומיםSplit payment code1
TFtalDiscountFloat number% הנחה ללקוח% customer discount0
VatExampt0/1פטור ממע"מVAT exempt0
FilterString (5)חתךFiltering^^^^^
WorFString (max 15)עיסוקOccupationnull
DetailsString (max 50)הערותRemarksnull
AvgLatePayInteger numberממוצע איחור תשלומיםAverage delay of payments0
MaxCreditFloat numberתקרת אשראיCredit limit0
MaxCreditCurrencyString (max 5)
values
מטבע אשראיCredit currencyCompanyMC i
MaxObligoFloat numberתקרת אובליגוCredit risk limit0
MaxObligoCurrencyString (max 5)
values
מטבע אובליגוCredit risk currencyCompanyMC i
CustomerNoteString (max 250)הודעת לקוחMessage for the customernull
AssignKeyString (max 15)מפתח חשבון מרכז (מפתח קיים)Central account key (existing account)null
AgentInteger numberסוכןSalesperson0
DeductionPrcFloat number% ניכוי במקור% withholding tax0
DeductionValidDate string – dd/mm/yyyyתוקף ניכוי במקורValidity date of the % withholding tax1991/01/01
BankCodeString (max 3)קוד בנקBank codenull
BranchCodeString (max 5)סניף בנקBank branch codenull
BankAccountString (max 20)מספר חשבון בנקBank account #null
TaxFileNumString (max 9)מספר עוסק מורשהVAT registration numbernull
MainAccountInteger number
values
קוד חשבון ראשיCode of the main account26
FixedOrderCostFloat numberמחיר הזמנה קבועFix cost of order0
AverageSupplyPeriodFloat numberזמן אספקה ממוצעAverage supply time0
CostCodeString (max 8)קוד תמחיר (חייב להיות קיים)Code of cost center (existing code)null
DifferAccString (max 15)חשבון הפרשים ( חשבון קיים)Account key for small differences (existing account)null
MatchCurrString (max 5)
values
מטבע ההתאמה במקרה של מט"חCurrency for reconciliation (when the price is in foreign currency)CompanyMC i
EmailString (max 50)כתובת דוא"לE-Mail addressnull
DeductFileString (max 20)מספר תיק מס הכנסהIncome file numbernull
DocCurrString (max 5)
values
מטבע ברירת מחדל למסמכי מט"חDefault value for foreign currencyCompanyEC i
WebSiteString (max 250)אתרWeb sitenull
DeductTypeInteger number
values
סוג ניכוי במקורDeduct Type0
TaxRepCodeInteger number
values
סעיף חשבונאי (6111)Tax Rep Code99990
Computerized0/1/2שליחה חשבוניות דיגיטלית
0 = הפקה לא דיגיטלית (הדפסה)
1 = שליחת חשבוניות מקור דיגיטליות והזמנות בדוא"ל, ללא תצוגה לפני השליחה
2 = שליחת חשבוניות מקור דיגיטליות והזמנות בדוא"ל, לאחר תצוגה לפני השליחה (הפקת חשבונית דרך הapi ישלח בתגובה url לתצוגה.)
Sending a digital invoice
0 - Non-digital (print)
1 - Email digital invoices and orders, without preview
2 - Email digital invoices and orders, after a preview (Generating an invoice through the api will return a display url.)
0
MailReceipt0/1/2שליחת קבלות דיגיטלית
0 = הפקה לא דיגיטלית (הדפסה)
1 = שליחת קבלות מקור דיגיטליות בדוא"ל, ללא תצוגה לפני השליחה
2 = שליחת קבלות מקור דיגיטליות בדוא"ל, לאחר תצוגה לפני השליחה (הפקת קבלה דרך הapi ישלח בתגובה url לתצוגה.)
Sending a digital receipts
0 - Non-digital (print)
1 - Email digital receipts, without preview
2 - Email digital receipts, after a preview (Generating a receipt through the api will return a display url.)
0
BooksPermission0/1אישור ניהול ספריםBookkeeping authorization0
b2bflag0/1לקוח עסקיb2b0

JSON Example

{

"myindex": "acc",
"insertnew": "true",
"rows": [
{
"AccountKey": "acc123",
"FullName": "name of acc123",
"SortGroup": "258",
"CostCode": "22",
"AssignKey": "777",
"DeductionPrc": 10.5,
"DeductionValid": "28/02/2019"
},
{
"AccountKey": "8888123664",
"FullName": "8888 name new",
"SortGroup": "1234",
"CostCode": "1"
}
]
}

Items Data

The following parameters should be included in a rows array when "myindex": "itm"

FieldName-transTypeתיאורDescriptionDefault
ItemKey
Required
String (max 20)מפתח פריטItem key
ItemNameString (max 100)שם פריטItem namenull
ForignNameString (max 100)שם לועזיItem name for export documentsnull
SortGroupInteger numberמיוןSorting code0
FilterString (10)חתךFiltering^^^^^^^^^^
PriceFloat numberמחיר מכירהList price0
Additional fields
CurrencyString (max 5)
values
מטבע מכירהList price currencyCompanyMC i
PurchPriceFloat numberמחיר קניה אחרוןLast purchasing price0
PurchCurrencyString (max 5)מטבע קניהPurchasing price currencyCompanyMC i
LastPurchDateDate string – dd/mm/yyyyתאריך קניה אחרוןLast purchasing price date1991/01/01
QuantityFloat numberיתרה במלאיInventory balance0
VatExampt0/1פטור ממע"מVAT exempt0
DiscountCodeString (max 5)קוד הנחהDiscount codenull
DiscountPrcFloat number% הנחת מבצע% of sale promotion discount0
SalesUnitString (max 5)יחידת מידה מכירותUnit measure for salesnull
PurchaseUnitString (max 5)יחידת מידה רכשUnit measure for purchasenull
LocalizationString (max 50)איתורLocalization (in the storehouse)null
BarCodeString (max 20)ברקודBarcodenull
WeigtFloat numberמשקלWeight0
VolumeFloat numberנפחVolume0
DutyPrcFloat number% מכס% customs0
StockLevelFloat numberרמת מלאיInventory level0
ReorderQuantFloat numberנקודת הזמנהPoint of order0
DefaultWarehouseInteger numberמחסןWarehouse1
DemandPerDayFloat numberצריכה יומיתAverage demand per day0
DemandPerMonthFloat numberצריכה חודשיתAverage demand per month0
StorageCostFloat numberעלות אחסנהCost of storage0
MaxStoragePeriodFloat numberזמן אחסנה מקסימליMaximum storage period0
CostOfShortageFloat numberעלות חוסרCost of shortage0
SalesAccString (max 15)חשבון הכנסות (חייב להיות קיים במערכת)Sales account (existing account key)null
PurchAccString (max 15)חשבון הוצאות (חייב להיות קיים במערכת)Expense account (existing account key)null
VatFreeSalesAccString (max 15)חשבון הכנסות פטור ממע"מ (חייב להיות קיים)VAT exempt sales account (existing account)null
WeightItem0/1דגל לציון פריט שקיל-1 =שקילWeightable item (1- positive)0

Indexs OutputData

NameOptions
statusCode200 – OK / 500 - Errors
status
errorsOK / Errors: "error description" / No Permission