israeli-banks-actual-budget-importer
v1.10.4
Published
[](https://github.com/semantic-release/semantic-release) [](ht
Readme
Israeli Banks → Actual Budget
This project provides an importer from Israeli banks (via israeli-bank-scrapers) into Actual Budget.
Features
Multi Bank Support
Supports all of the institutions that the israeli-bank-scrapers library covers (Bank Hapoalim, Cal, Leumi, Discount, etc.).Prevents duplicate transactions
Uses Actual’simported_idlogic.Automatic Account Creation
If the bank account does not exist in Actual, it will be created automatically.Reconciliation
Optional reconciliation to adjust account balances automatically.Credit Card / Multi-Account Mapping (Targets)
Supports mapping multiple scraped accounts/cards into one Actual account, or mapping each scraped card into its own Actual account (viatargetsandaccounts).Concurrent Processing
Uses a queue (via p-queue) to manage scraping tasks concurrently.Pending transactions are skipped
Only completed transactions are imported into Actual, which avoids provisional card amounts and pre-conversion foreign-currency rows landing in the final ledger.
Installation
Docker
https://hub.docker.com/r/tomerh2001/israeli-banks-actual-budget-importer
Example
services:
importer:
image: tomerh2001/israeli-banks-actual-budget-importer:latest
restart: always
cap_add:
- SYS_ADMIN
environment:
- TZ=Asia/Jerusalem
- SCHEDULE=0 0 * * * # Optional (Used to run periodically - remove to run once)
volumes:
- ./config.json:/app/config.json
- ./cache:/app/cache # Optional
- ./chrome-data:/app/chrome-data # Optional (Used to solve 2FA issues like with hapoalim)Actual version compatibility
This importer bundles a specific @actual-app/api version, and Actual versions
the API package and the server together.
If you upgrade your Actual server, upgrade this importer image as well. A stale
importer image against a newer Actual server can fail during startup with
errors such as out-of-sync-migrations.
The importer now checks the server version before downloading the budget and fails early with a clear mismatch message that includes both versions.
Configuration
The application configuration is defined using JSON and validated against a schema.
The main configuration file is config.json.
The configuration has two independent top-level sections:
actual– Configures the Actual Budget connection.banks– Configures bank scrapers and account mappings.
1) actual section
This section configures the connection to your Actual Budget server and budget.
It is always required, regardless of how you configure banks or targets.
{
"actual": {
"init": {
"dataDir": "./data",
"password": "your_actual_password",
"serverURL": "https://your-actual-server.com"
},
"budget": {
"syncId": "your_sync_id",
"password": "your_budget_password"
}
}
}Nothing in this block changes when using targets, credit cards, or multi-account mappings.
2) banks section
The banks section defines:
- Which banks to scrape
- The credentials for each bank
- How scraped accounts/cards are mapped into Actual accounts
Each bank entry includes the credentials required by israeli-bank-scrapers
(e.g. userCode, username, password, etc.).
targets sub-section
A single bank scrape (for example visaCal) may return multiple accounts/cards.
Different users model these differently in Actual, so the importer supports targets.
Each target represents:
- One Actual account
- One or more scraped accounts/cards that feed into it
For each target:
- Imported transactions = concatenation of transactions from selected cards
- Reconciliation (if enabled) = sum of balances of selected cards
(only cards with a valid numeric balance are included)
Reconciliation behavior
- Reconciliation is controlled by the
reconcileboolean. - When
reconcile: true, a new reconciliation transaction is created on every run (no updates, no reconciliation). - Existing reconciliation transactions are never modified or reused.
- If
reconcileis omitted or set tofalse, no reconciliation transaction is created.
Example A: One Actual account for all VisaCal cards
{
"actual": {
"init": {
"dataDir": "./data",
"password": "your_actual_password",
"serverURL": "https://your-actual-server.com"
},
"budget": {
"syncId": "your_sync_id",
"password": "your_budget_password"
}
},
"banks": {
"visaCal": {
"username": "bank_username",
"password": "bank_password",
"targets": [
{
"actualAccountId": "actual-creditcards-all",
"reconcile": true,
"accounts": "all"
}
]
}
}
}Example B: One Actual account per VisaCal card
{
"actual": {
"init": {
"dataDir": "./data",
"password": "your_actual_password",
"serverURL": "https://your-actual-server.com"
},
"budget": {
"syncId": "your_sync_id",
"password": "your_budget_password"
}
},
"banks": {
"visaCal": {
"username": "bank_username",
"password": "bank_password",
"targets": [
{
"actualAccountId": "actual-card-8538",
"reconcile": true,
"accounts": ["8538"]
},
{
"actualAccountId": "actual-card-7697",
"reconcile": true,
"accounts": ["7697"]
}
]
}
}
}Example C: Grouped cards into a single Actual account (subset)
{
"actual": {
"init": {
"dataDir": "./data",
"password": "your_actual_password",
"serverURL": "https://your-actual-server.com"
},
"budget": {
"syncId": "your_sync_id",
"password": "your_budget_password"
}
},
"banks": {
"visaCal": {
"username": "bank_username",
"password": "bank_password",
"targets": [
{
"actualAccountId": "actual-cal-primary",
"reconcile": true,
"accounts": ["8538", "7697"]
}
]
}
}
}Legacy configuration (single Actual account per bank)
This configuration style is fully supported for backward compatibility,
but does not allow fine-grained control over multiple cards/accounts.
It maps all scraped accounts from the bank into a single Actual account.
{
"actual": {
"init": {
"dataDir": "./data",
"password": "your_actual_password",
"serverURL": "https://your-actual-server.com"
},
"budget": {
"syncId": "your_sync_id",
"password": "your_budget_password"
}
},
"banks": {
"hapoalim": {
"actualAccountId": "account-123",
"userCode": "bank_user",
"password": "bank_password",
"reconcile": true
},
"leumi": {
"actualAccountId": "account-456",
"username": "bank_username",
"password": "bank_password"
}
}
}Notes
- The
actualblock is always required and independent of bank configuration. targetsare optional but strongly recommended for credit-card providers.- Duplicate transactions are prevented using a stable
imported_id. - Credit card balances are often negative; reconciliation uses the values as returned by the bank.
License
This project is open-source. Please see the LICENSE file for licensing details.
Acknowledgments
- israeli-bank-scrapers: Thanks to the contributors of the bank scraper libraries.
- Actual App: For providing a powerful budgeting API.
- Open-source Community: Your support and contributions are appreciated.
