{"id":17959131,"url":"https://github.com/tribut/aqbanking","last_synced_at":"2025-04-03T17:46:02.020Z","repository":{"id":68614869,"uuid":"93275831","full_name":"tribut/aqbanking","owner":"tribut","description":"Fork of Gwenhywfar, upstream is at https://git.aqbanking.de/git/aqbanking","archived":false,"fork":false,"pushed_at":"2017-06-03T21:55:36.000Z","size":25990,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-09T06:26:48.250Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tribut.png","metadata":{"files":{"readme":"README","changelog":"NEWS","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-03T21:53:55.000Z","updated_at":"2017-06-16T09:12:36.000Z","dependencies_parsed_at":"2023-03-22T09:20:09.134Z","dependency_job_id":null,"html_url":"https://github.com/tribut/aqbanking","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tribut%2Faqbanking","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tribut%2Faqbanking/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tribut%2Faqbanking/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tribut%2Faqbanking/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tribut","download_url":"https://codeload.github.com/tribut/aqbanking/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247052033,"owners_count":20875677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-29T11:01:31.827Z","updated_at":"2025-04-03T17:46:02.007Z","avatar_url":"https://github.com/tribut.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n                                Content\n                                =======\n\n               1.   What Is AqBanking ?\n               1.1.   Generic Online Banking Interface\n               1.2.   Generic Financial Data Importer/Exporter Framework\n               1.3.   Bank/Account Information\n               2.   Supported Platforms\n               3.   Supported Backends\n               3.1.   HBCI\n               3.2.   OFX Direct Connect\n               3.3.   EBICS\n               3.4.   Paypal\n               3.5.   None\n               4.   What Do I Need ?\n               4.1.   Required Packages\n               4.2.   Applications\n               5.   Building AqBanking\n               5.1.   Building from the Tar File\n               5.2.   Building from CVS/SVN\n               5.3.   Building the API Documentation\n               6.   Windows Registry Keys Used\n               6.1.   Software\\\\AqBanking\\\\Paths\\\\pkgdatadir\n               6.2.   Software\\\\AqBanking\\\\Paths\\\\sysconfdir\n               6.3.   Software\\\\AqBanking\\\\Paths\\\\bankinfodir\n               6.4.   Software\\\\AqBanking\\\\Paths\\\\providerdir\n               6.5.   Software\\\\AqBanking\\\\Paths\\\\importerdir\n               7.   Environment Variables Used\n               7.1.   AQBANKING_LOGLEVEL\n               7.2.   AQBANKING_STORE_JOBLOGS\n               7.3.   AQHBCI_LOGBOOKED\n               7.4.   AQHBCI_LOGNOTED\n               7.5.   AQHBCI_DEBUG_JOBS\n               7.6.   AQOFX_LOG_COMM\n               8 .  Using Your Own Profiles for Im-/Exporters\n               9.   Thanks\n               10.  Translation\n\n\n\n1. What Is AqBanking ?\n======================\n\nAqBanking is a library for online banking and financial\napplications. It has three major goals which are described in the\nfollowing paragraphs.\n\n(Note: Information in German can be found on\nhttp://linuxwiki.de/AqBanking )\n\nThe homepage of AqBanking is http://www.aqbanking.de/\n\n\n1.1. Generic Online Banking Interface\n-------------------------------------\n\nThe intention of AqBanking is to provide a middle layer between the program\nand the various Online Banking libraries (e.g. AqHBCI, OpenHBCI etc). \n\nThe real work is done in so-called banking backends. See chapter 3 for a\nlist of supported backends.\n\n\n\n1.2. Generic Financial Data Importer/Exporter Framework\n-------------------------------------------------------\n\nAqBanking uses various plugins to simplify import and export of financial\ndata. It also provides the administration of profiles on a per import/export\nplugin basis.\n\nCurrently there are plugins for the following formats:\n\n- Importers:\n  - DTAUS (German financial format)\n  - SWIFT (MT940 and MT942)\n  - OFX\n  - CSV\n  - OpenHBCI1 transactions\n  - ERI\n  - Q43\n  \n- Exporters\n  - DTAUS (German financial format)\n  - CSV\n\n\n1.3. Bank/Account Information\n-----------------------------\n\nAqBanking supports plugins which allow lookup and verification of\nbank code/ account id pair validity. For Germany the library\nKtoBlzCheck is used for validation, but the bank information is\nshipped with aqbanking.\n\nCurrently AqBanking provides informations about:\n- ca 25,000 US banks\n- ca 20,000 German banks\n- ca  3,600 Swiss banks\n- ca  2,300 Austrian banks\n\nAqBanking also provides information about countries: Country name, ISO-3166\ncountry code (both numeric and alpha) and currency information (ISO 4217\ncurrency codes).\n\n\n\n2. Supported Platforms\n======================\n\nAqBanking uses the library Gwenhywfar (http://www.aqbanking.de/) for \nabstraction of the underlying system. So it should work on any system for \nwhich Gwenhywfar is available. \n\nThis includes (but is not limited to): \n - Linux (of course ;-)\n - Windows (WIN32 platforms, such as Windows95 up to Windows XP)\n - MacOSX 10.5 and newer\n - most POSIX systems (such as the BSDs) should also be supported, \n   however, this is untested\n\n\n\n3. Supported Backends\n=====================\n\nAqBanking includes all its currently known banking backends.\n\n\n3.1. HBCI\n---------\n\nThe backend AqHBCI provides support for the German online banking protocol\ncalled \"Homebanking Computer Interface\". It is a national standard provided\nby most German credit institutes.\n\nThe following security media are supported:\n - DDV chipcard (DES-DES-Verfahren)\n - RSA chipcard (RSA-DES-Hybrid mode)\n - OpenHBCI keyfile (either OpenHBCI 1 or 2, this medium allows continued use \n                     with OpenHBCI in parallel)\n - PIN/TAN (PIN/TAN mode using HTTP over SSL)\n\nThis backend supports the HBCI versions 2.01, 2.10, 2.20 and 3.00\n\n\n3.2. OFX Direct Connect\n-----------------------\n\nThis backend provides support for an online banking protocol used in the \nUnited States, Canada and maybe in the United Kingdom.\n\n\n3.3. EBICS\n----------\n\nEBICS is the successor of the German banking protocol FTAM. It is used in commercial\nenvironments. The tool AqBanking-CLI comes with optional support for this protocol.\n\n\n3.4. Paypal\n-----------\n\nThis backend uses Paypal's native API for retrieving transactions.\n\n\n3.5. None\n---------\n\nThis is a fallback module which can be used by applications for accounts which\nare not managed by any online banking backend.\n\n\n\n4. What Do I Need ?\n===================\n\n\n4.1. Required Packages\n----------------------\n\nAqBanking has several direct dependencies:\n\n- \"Gwenhywfar\" \u003e= 3.99.0, available from\nhttp://gwenhywfar.sf.net/, is absolutely required\n\n- \"GMP\", the GNU MP Bignum Library available from \n  http://gmplib.org/index.html is required for calculations\n\n- \"KtoBlzCheck\" \u003e= 1.0 from http://sf.net/projects/ktoblzcheck is\nrequired for the German bank account number checking, otherwise\nthe account number checking will not be compiled.\n\n- The python module \"ctypes\" http://sf.net/projects/ctypes is\nrequired for the python wrappers of aqbanking. The python wrappers\nare installed by default (to disable it, use --disable-python),\nbut they cannot be used unless \"ctypes\" is installed.\n\n\n4.2. Applications\n-----------------\n\nThese applications fully or partially support AqBanking:\n - AqFinance (http://www2.aquamaniac.de/sites/aqfinance/index.php)\n - QBankManager (http://www.aquamaniac.de/qbanking/, discontinued)\n - Gnucash (http://www.gnucash.org/)\n - KMyMoney (http://www.kmymoney.org/)\n - OrgaMon (http://orgamon.org/)\n - Pecunia 0.2 (http://www.pecuniabanking.de/Pecunia/Home.html)\n\nThe aqbanking package also includes several command-line tools\n(aqbanking-tool, aqhbci-tool).\n\n\n\n5. Building AqBanking\n=====================\n\n\n5.1. Building from the Tar File\n-------------------------------\n\n#\u003e./configure\n#\u003emake\n#\u003emake install\n\n(the last step most probably requires you to be root)\n\nCompilation hints for specific platforms:\n\n- For FreeBSD and potentially other non-Linux platform, it might be\n  necessary to use \"gmake\" instead of the \"make\" program.\n\n- Also, if your \"make\" program happens to complain about the variable\n  definition \"I18NFILES = $(shell cat ...\" (in Makefile.in around line\n  230) and related definitions, then you need to look for comments in\n  the Makefile about \"old make programs\". Follow the instructions in\n  these comments, i.e. set some variable definitions to an empty\n  variable manually. This should remove all potentially incompatible\n  directives from the Makefile.\n\n- (especially on Mac/Darwin): If your configure run does not\n  detect the QT libraries and it says \"checking for qt3\n  libraries... not found\", then you need to specify the linker\n  flags for qt3 manually in the env variable qt3_libs. I.e. if\n  your qt3 library files are in /opt/qt/lib and is called\n  libqt-mt, then you need to specify \n  ./configure qt3_libs=\"-L/opt/qt/lib -lqt-mt\"\n\n\n5.2. Building from CVS/SVN\n--------------------------\n\n#\u003emake -fMakefile.cvs\n\nand continue as described in \"5.1. Building from the Tar File\".\n\n\n5.3. Building the API Documentation\n-----------------------------------\n\n#\u003emake srcdoc\n\nIf you want to install a linked API documentation (which links against the\nAPI documentations of the projects AqBanking depends on) use this:\n\n#\u003emake install-srcdoc\n\nThis installs the linked doc to the path you gave to ./configure\nby \"--with-docpath=PATH\". It defaults to \"$HOME/apidoc\", which\nmeans it does *not* obey the --prefix argument.\n\n\n\n6. Windows Registry Keys Used\n=============================\n\nSome AqBanking versions might use registry keys below HKEY_CURRENT_USER.  \nThese are at the moment only versions shipped with GnuCash (at least that\nused to be the case which is why handling of registry keys was introduced\nin the first place). Most versions of AqBanking don't use the registry\nto determine installation paths because those versions are filesystem\nrelocatable, so they don't need the registry.\n\nAt any rate, those versions that still do use the registry use the\nfollowing keys. These keys are created by the setup.exe which\ncontains the binary package for WIN32 platforms.\n\n\n6.1. Software\\\\AqBanking\\\\Paths\\\\pkgdatadir\n-------------------------------------------\nThis is the data folder (i.e. $PREFIX/share/aqbanking on POSIX systems).\n\n\n6.2. Software\\\\AqBanking\\\\Paths\\\\sysconfdir\n-------------------------------------------\nThis is the folder containing system configuration files.\n(i.e. $PREFIX/etc on POSIX systems).\n\n\n6.3. Software\\\\AqBanking\\\\Paths\\\\bankinfodir\n-------------------------------------------\nThis folder is used to store bankinfo plugins.\n\n\n6.4. Software\\\\AqBanking\\\\Paths\\\\providerdir\n-------------------------------------------\nThis folder is used to store provider (backend) plugins.\n\n\n6.5. Software\\\\AqBanking\\\\Paths\\\\importerdir\n-------------------------------------------\nThis folder is used to store importer/exporter plugins.\n\n\n\n7. Environment Variables Used\n=============================\n\n\n7.1. AQBANKING_LOGLEVEL\n-----------------------\n\nThis variable stores the loglevel to be used for AqBanking.\nPossible values are: emergency, alert, critical, error, warning, notice,\ninfo, debug and verbous. Each following log level includes the previous\none.\n\n\n7.2. AQBANKING_STORE_JOBLOGS\n----------------------------\nIf this variable is defined then AqBanking will always store job logs with \njobs. Otherwise job logs are only stored for jobs with a status other than\n\"finished\". Job logs can become quite big.\n\n\n7.3. AQHBCI_LOGBOOKED\n---------------------\nIf this environment variable exists then the file \"/tmp/booked.mt\" is created\nupon reception of transactions via the job GetTransactions. This file then\ncontains a SWIFT MT940 document which can be very helpfull in case there is\na problem in the SWIFT parser.\n\n\n7.4. AQHBCI_LOGNOTED\n--------------------\nSame as AQHBCI_LOGBOOKED but for noted transactions (which are transactions\nwhich are noted but not yet booked)\n\n\n7.5. AQHBCI_DEBUG_JOBS\n----------------------\nIf this variable exists then additional debugging data is stored with each\njob.\n\n\n7.6. AQOFX_LOG_COMM\n-------------------\nIf this variable exists then all OFX communication is logged to /tmp/ofx.log.\nThis is only needed when debugging AqOfxConnect.\nWARNING: This might expose your user id and password to everyone who can read\nthat file!\n\n\n\n\n8. Using Your Own Profiles for Im-/Exporters\n============================================\n\nYou can create your own profiles to be used with the various importers.\nFor AqBanking to recognize your private profiles they must be stored in\nthe user local folder. \nE.g. CSV profiles on Linux must be stored in \n\"$HOME/.aqbanking/imexporters/csv/profiles/\".\n\n\n\n9. Thanks\n==========\n\nI wish to thank the following (among others) people for their support in \nmaking AqBanking work:\n- Christian Stimming (build-system and tarball cleanup, translations, inputs)\n- Jens Koerner (did some huge jobs to provide German translation)\n- David Reiser (for helping in debugging the OFX DirectConnect code)\n- Christoph Bohl (for helping with the YellowNet backend)\n\n- and of course the many people who submitted bug reports !!\n\n\n\n10. Translation\n===============\n\nTo work on translation of this project you need the folowing packages on\nDebian based systems:\n- po4edit \n- translate-toolkit (for \"msghack\")\n\nYou can then create the necessary files with:\n- make catalogs\n- make merge\n\nThis will create the necessary *.pot and *.po files, the latter should then be\ntranslated.\n\n\nMartin Preuss, Wilhelmshaven/Germany, 2016/12/11\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftribut%2Faqbanking","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftribut%2Faqbanking","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftribut%2Faqbanking/lists"}