Skip to main content

Beancount Importer for N26 CSV exports

Project description

Beancount N26 Importer

image image image Ruff

beancount-n26 provides a Beancount Importer for converting CSV exports of N26 account summaries to the Beancount format.

Installation

$ pip install beancount-n26

In case you prefer installing from the Github repository, please note that main is the development branch so stable is what you should be installing from.

Note that v1.x will only work with Beancount 3.x, while v0.x will only work with Beancount 2.x, due to incompatibilities between Beancount 3.x and 2.x.

Usage

Beancount 3.x

Beancount 3.x has replaced the config.py file based workflow in favor of having a script based workflow, as per the changes documented here. As a result, the importer's initialization parameters have been shifted to pyproject.toml.

Add the following to your pyproject.toml in your project root.

[tool.beancount-n26.ec]
ibn = "IBAN_NUMBER" # required
account_name = "Assets:N26" # required
language = "en"
file_encoding = "utf-8"

Beancount 2.x

Add the following to your config.py.

from beancount_n26 import N26Importer

CONFIG = [
    N26Importer(
        IBAN_NUMBER,
        'Assets:N26',
        language='en',
        file_encoding='utf-8',
    ),
]

Classification

To classify specific recurring transactions automatically, you can specify an account_patterns parameter. The key should be the account name and the items in the list are regular expressions that should match a payee.

A few helper functions have been provided in beancount_n26/utils/patterns_generation.py to help you generate this dictionnary.

Beancount 3.x

[tool.beancount-n26.account_patterns]
"Expenses:Supermarket" = ["REWE", "ALDI"]

Beancount 2.x

from beancount_n26 import N26Importer

CONFIG = [
    N26Importer(
        ...
        account_patterns={"Expenses:Supermarket": ["REWE", "ALDI"]}
    ),
]

Multiple-currency transactions

To mark transaction fees associated with multiple-currency transactions, you can specify the exchange_fees_account parameter.

Beancount 3.x

[tool.beancount-n26]
ibn = "IBAN_NUMBER" # required
account_name = "Assets:N26" # required
language = "en"
file_encoding = "utf-8"
exchange_fees_account = "Expenses:TransferWise"

Beancount 2.x

from beancount_n26 import N26Importer

CONFIG = [
    N26Importer(
        IBAN_NUMBER,
        'Assets:N26',
        language='en',
        file_encoding='utf-8',
        exchange_fees_account='Expenses:TransferWise',
    ),
]

With this in place, for transactions where both the amount in EUR and amount in foreign currency are given, the importer will calculate the transaction fee based on the exchange rate included in the CSV export and automatically allocate the value to the account specified in exchange_fees_account.

Contributing

Please make sure you have Python 3.9+ and Poetry installed.

  1. Git clone the repository - git clone https://github.com/siddhantgoel/beancount-n26

  2. Install the packages required for development - poetry install

  3. That's basically it. You should now be able to run the test suite - poetry run task test.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beancount_n26-1.2.1.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

beancount_n26-1.2.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file beancount_n26-1.2.1.tar.gz.

File metadata

  • Download URL: beancount_n26-1.2.1.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.9 Darwin/24.3.0

File hashes

Hashes for beancount_n26-1.2.1.tar.gz
Algorithm Hash digest
SHA256 db632fe2203e846b5a71ec9f82d664a7f8b6369594e4ca7ff405e0122f3d8117
MD5 0ede8bdc38f8275aaaf2332c042446cd
BLAKE2b-256 9e37455af0434f8e408923f8f8cc59b5f80ea506d5aca0a4f502c6a2223dc4c0

See more details on using hashes here.

File details

Details for the file beancount_n26-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: beancount_n26-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.9 Darwin/24.3.0

File hashes

Hashes for beancount_n26-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0694c18561a746ca158cf148221ed9f8c13e70998aba204455e3f77be936660
MD5 390b0533d9e20e0b77ff17bf1dde9eff
BLAKE2b-256 32ea94f628514d64a563ea9c3c6988a3cf53443bd86c3645a718de60a1abca5f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page