Import Bank Statements
NodeJS Example File
BankPagesApiExample.js
Import Bank Page Records
Import or update records to chosen index
| REST API | BankPagesApi/importBankPage |
| NodeJS | importBankPageRecords |
| Parameters | Description | Parameter Options/value |
|---|---|---|
| rows
Required | bank pages object array | See table below |
JSON Body Example
{
"rows": [
{
...
},
{
...
}
]
}
Bank Pages
The following parameters should be included in a rows array (see example below)
| Sub-transactions | Type | תיאור | Description | Default |
|---|---|---|---|---|
| AccountKey Required | String (max 15) | מפתח חשבון (בנק) | Bank account key | |
| Reference | Integer number | אסמכתא | Reference | 0 |
| CreditDebit Required | Integer number | חובה-1 זכות- 0 | Debit - 1 Credit - 0 | |
| SuF Required | Float number | סכום | Amount | |
| Details | String (max 50) | פרטים | Remarks | null |
| DatF | Date string – dd-mm-yyyy | תאריך | date | --- |
| finalbalance | Array | מערך של חשבונות בנק ויתרות המשמש לבדיקת התאמה מול הנתונים הקיימים במערכת. אם קיימת אי־התאמה בין היתרה שנשלחה לבין היתרה המעודכנת בחברה, התנועות החדשות (עבור החשבון השגוי) לא ייקלטו. ראו טבלה למטה | An array of bank accounts and balances used to verify reconciliation against existing data in the system. If there is a mismatch between the submitted balance and the balance updated at the company, new transactions (for the incorrect account) will not be imported. See table below | --- |
finalbalance - Array items
| Field | Type | תיאור | Description |
|---|---|---|---|
| AccountKey | string | מפתח חשבון בנק | Bank account key |
| Balance | number | יתרת חשבון בנק | Bank account balance |
JSON Example
{
"rows": [
{
"AccountKey": "10001",
"Reference": "123",
"Details": "trans details",
"DatF": "31/10/2019",
"SuF": "1234.56",
"CreditDebit": "0"
},
{
"AccountKey": "10001",
"Reference": "125",
"Details": "trans details 111",
"DatF": "28/10/2019",
"SuF": "55123",
"CreditDebit": "1"
}
],
"finalbalance": [
{
"AccountKey": "10001",
"Balance": "1234.56"
}
]
}
Bank Pages OutputData
| Name | Options |
|---|---|
| statusCode | 200 – OK / 500 - Errors |
| status | |
| errors | OK / Errors: "error description" / No Permission |