attachment:aqbanking-tool-README.txt von AqBanking

   1 This folder contains a tool for basic operations on AqBanking.
   2 
   3 Usage:
   4 aqbanking-tool [GLOBAL-OPTIONS] COMMAND [COMMAND-SPECIFIC-OPTIONS]
   5 
   6 Every command may have local command line options which must follow the
   7 command. These local arguments are described with the individual commands
   8 below.
   9 
  10 
  11 Return Values
  12 =============
  13  0: ok
  14  1: parameter error (missing/bad/invalid arguments)
  15  2: setup error (AB_Banking_Init)
  16  3: error executing the command
  17  4: error *after* executing the command
  18  5: deinit error (AB_Banking_Fini)
  19 99: job has been executed but is still pending (mostly used with transfer
  20     requests which are delayed by the bank)
  21 
  22 
  23 
  24 Global Options
  25 ==============
  26 
  27 This tool has global options and command-specific options.
  28 
  29 Globals options are those before the COMMAND, command-specific options
  30 follow the COMMAND.
  31 
  32 [-C           ARG]     AqBanking configuration file
  33 [-P           ARG]     PINFILE to be used for automatic PIN lookup
  34                        For HBCI pins you can use the tool "aqhbci-tool" to 
  35                        create an empty pin file:
  36                        "aqhbci-tool mkpinlist -o PINFILE"
  37                        After that just edit the newly created file with your
  38                        favorite editor and insert the pins you want to use
  39                        automatically.
  40 [-n              ]     Work in non-interactive mode
  41 [--charset   =ARG]     Select the character set for console output (defaults
  42                        to "ISO-8859-15")
  43 [--logtype   =ARG]     type of logging (console, file)
  44 [--loglevel  =ARG]     log level (info, notice, warning, error)
  45 [--logfile   =ARG]     log file (if log type is "file")
  46 
  47 
  48 The following is a list of commands which are implemented so far.
  49 
  50 
  51 "listaccs"
  52 ==========
  53 
  54 This command prints a TAB separated list of currently available accounts
  55 to stdout.
  56 
  57 
  58 Options
  59 -------
  60 --bank       =ARG      Bank code ("Bankleitzahl")
  61 --account    =ARG      Account number
  62 --bankname   =ARG      Bank name
  63 --accountname=ARG      Account name
  64 Wildcards ("*") and jokers ("?") are allowed. Every missing option of those
  65 above automatically matches any account.
  66 
  67 
  68 Examples
  69 --------
  70 aqbanking-tool listaccs
  71 aqbanking-tool listaccs --bank=28250110
  72 aqbanking-tool listaccs --bankname="*Sparkasse*"
  73 aqbanking-tool listaccs --account=123456
  74 
  75 
  76 
  77 "request"
  78 =========
  79 
  80 This command enqueues a request for specified accounts. To actually perform
  81 the request (i.e. send it to the bank) you will have to use the command
  82 "exec" after "request".
  83 
  84 
  85 Options
  86 -------
  87 [--bank       =ARG]      Bank code ("Bankleitzahl")
  88 [--account    =ARG]      Account number
  89 [--bankname   =ARG]      Bank name
  90 [--accountname=ARG]      Account name
  91 Wildcards ("*") and jokers ("?") are allowed. Every missing option of those
  92 above automatically matches any account.
  93 
  94 At least one of the following options must be specified:
  95 [--transactions   ]      Add a request for transactions
  96 [--balance        ]      Add a request for account balance
  97 [--sto            ]      Add a request for standing orders
  98 
  99 For transaction requests these options are supported in addition:
 100 [--fromdate   =ARG]      Specify the first date for which transactions are to
 101                          requested
 102 [--todate     =ARG]      Specify the last date for which transactions are to
 103                          requested
 104 
 105 
 106 Examples
 107 --------
 108 aqbanking-tool request --balance
 109 aqbanking-tool request --transactions
 110 aqbanking-tool request --transactions --fromdate=20050501
 111 aqbanking-tool request --transactions --fromdate=20050501 --todate=20050513
 112 aqbanking-tool request --transactions --balance
 113 aqbanking-tool request --transactions --balance --sto
 114 
 115 
 116 
 117 "exec"
 118 ======
 119 
 120 This command executes previously enqueued requests.
 121 The results are either printed to stdout or written to a file.
 122 
 123 
 124 Options
 125 -------
 126 [--ctxfile    =ARG]      Specify the file to which the results are to be
 127                          stored. This file is needed for some other commands
 128                          so it is best to specify it. Defaults to stdout.
 129 
 130 
 131 Examples
 132 --------
 133 aqbanking-tool exec --ctxfile=result.ctx
 134 
 135 
 136 
 137 "listtrans"
 138 ===========
 139 
 140 This command inspects the result file from the command "exec" and dumps 
 141 transaction statements from this file to stdout or a file.
 142 
 143 
 144 Options
 145 -------
 146 [--bank        =ARG]     Bank code ("Bankleitzahl")
 147 [--account     =ARG]     Account number
 148 [--bankname    =ARG]     Bank name
 149 [--accountname =ARG]     Account name
 150 Wildcards ("*") and jokers ("?") are allowed. Every missing option of those
 151 above automatically matches any account.
 152 
 153 [--ctxfile     =ARG]     The result file to be used (defaults to stdin)
 154 [--outfile     =ARG]     Name of the output file to which the transactions
 155                          are to be stored. Defaults to stdout.
 156 [--exporter    =ARG]     Name of the export plugin to be used for storage.
 157                          This defaults to "csv".
 158 [--profile     =ARG]     Name of the profile of the exporter plugin to be
 159                          used. Defaults to "default" (for every exporter
 160                          plugin a "default" profile is provided by AqBanking).
 161 
 162 Normally the system-wide profiles (and local AqBanking profiles of the user)
 163 are used when searching for a profile. However, with the following option
 164 you can use your own profiles database.
 165 [--profile-file=ARG]     Optional profile database file (a GWEN_DB)
 166 
 167 
 168 Examples
 169 --------
 170 aqbanking-tool listtrans --ctxfile=result.ctx --outfile=result.csv
 171 aqbanking-tool listtrans --bankname="*Sparkasse*" --ctxfile=result.ctx
 172                          --outfile=result.csv
 173 aqbanking-tool listtrans --ctxfile=result.ctx --outfile=result.csv
 174                          --profile=MyOwnProfile
 175 
 176 
 177 
 178 "listbal"
 179 ===========
 180 
 181 This command inspects the result file from the command "exec" and dumps 
 182 account balances from this file to stdout or a file (format: CSV).
 183 
 184 
 185 Options
 186 -------
 187 [--bank        =ARG]     Bank code ("Bankleitzahl")
 188 [--account     =ARG]     Account number
 189 [--bankname    =ARG]     Bank name
 190 [--accountname =ARG]     Account name
 191 Wildcards ("*") and jokers ("?") are allowed. Every missing option of those
 192 above automatically matches any account.
 193 
 194 [--ctxfile     =ARG]     The result file to be used (defaults to stdin)
 195 [--outfile     =ARG]     Name of the output file to which the transactions
 196                          are to be stored. Defaults to stdout.
 197 
 198 
 199 Output Format
 200 -------------
 201 The statements are written in TAB-delimited CSV lines. Each line contains
 202 the following data:
 203 
 204 Column! Data                                     ! Example Data
 205 ------!------------------------------------------!---------------------
 206  1    ! "Account" (fixed)                        ! Account
 207  2    ! Bank code (Bankleitzahl)                 ! 20050550
 208  3    ! Account number                           ! 1234567890
 209  4    ! Bank name (if known, empty otherwise)    ! Hamburger Sparkasse
 210  5    ! Account name (empty if unknown)          ! Giro
 211       !                                          !
 212  6-9  ! Booked balance                           !
 213  6    ! Date of balance (DD.MM.YYYY or empty)    ! 19.05.2005
 214  7    ! Time of balance (hh:mm or empty)         ! 16:53
 215  8    ! Balance (10 digits, precision 2)         ! 12345,04
 216  9    ! Currency (ISO code, empty if unknown)    ! EUR
 217       !                                          !
 218 10-13 ! Noted balance                            !
 219 10    ! Date of balance (DD.MM.YYYY or empty)    ! 19.05.2005
 220 11    ! Time of balance (hh:mm or empty)         ! 16:53
 221 12    ! Balance (10 digits, precision 2)         ! 12345,04
 222 13    ! Currency (ISO code, empty if unknown)    ! EUR
 223 
 224 
 225 
 226 Examples
 227 --------
 228 aqbanking-tool listbal --ctxfile=result.ctx --outfile=result.csv
 229 aqbanking-tool listbal --bankname="*Sparkasse*" --ctxfile=result.ctx
 230                        --outfile=result.csv
 231 
 232 
 233 
 234 "transfer"
 235 ===========
 236 
 237 This command enqueues a transfer request. To actually perform the request
 238 the command "exec" must be used afterwards.
 239 
 240 
 241 Options
 242 -------
 243 The following options can be used to specify the local account. It must be
 244 specified unambiguously.
 245 [--bank        =ARG]     Bank code ("Bankleitzahl")
 246 [--account     =ARG]     Account number
 247 [--bankname    =ARG]     Bank name
 248 [--accountname =ARG]     Account name
 249 Wildcards ("*") and jokers ("?") are allowed. Every missing option of those
 250 above automatically matches any account.
 251 
 252 --rbank        =ARG      Remote bank id
 253 --raccount     =ARG      Remote account id
 254 --value        =ARG      Amount to transfer including currency (1234,56:EUR)
 255 --textkey      =ARG      Text key (defaults to 51 for standard transfers)
 256 --rname        =ARG      Remote name (payee name), can be specified multiple
 257                          times
 258 --purpose      =ARG      Purpose of the transfer, can be specified multiple
 259                          times
 260 --force-check            If given then the check for the combination of
 261                          remote bank code and account number is required to
 262                          succeed in order to allow the transfer.
 263                          If omitted the transfer will only be rejected if
 264                          AqBanking is sure that the combination is invalid.
 265 -x                       Immediately execute the queue after enqueing the
 266                          transfer
 267 
 268 
 269 There are special return values when using this command:
 270 0:   everything is ok
 271 1-x: error (see above)
 272 99:  transfer has been executed and accepted by the bank, but the bank did not
 273      yet decide on whether the transfer is to be performed (job is pending)
 274 
 275 
 276 Examples
 277 --------
 278 aqbanking-tool transfer --bank=2345678 --account=12345
 279                         --rbank=12345678 --raccount=67890
 280                         --rname=Test-User
 281                         --value="123,45:EUR"
 282                         --textkey=51
 283                         --purpose="Small test"
 284                         --force-check
 285 
 286 
 287 "debitnote"
 288 ===========
 289 
 290 This command enqueues a debit note request. To actually perform the request
 291 the command "exec" must be used afterwards.
 292 
 293 
 294 Options
 295 -------
 296 The following options can be used to specify the local account. It must be
 297 specified unambiguously.
 298 [--bank        =ARG]     Bank code ("Bankleitzahl")
 299 [--account     =ARG]     Account number
 300 [--bankname    =ARG]     Bank name
 301 [--accountname =ARG]     Account name
 302 Wildcards ("*") and jokers ("?") are allowed. Every missing option of those
 303 above automatically matches any account.
 304 
 305 --rbank        =ARG      Remote bank id
 306 --raccount     =ARG      Remote account id
 307 --value        =ARG      Amount to draw including currency (1234,56:EUR)
 308 --textkey      =ARG      Text key (defaults to 51 for standard debitnotes)
 309 --rname        =ARG      Remote name (payee name), can be specified multiple
 310                          times
 311 --purpose      =ARG      Purpose of the debit note, can be specified multiple
 312                          times
 313 --force-check            If given then the check for the combination of
 314                          remote bank code and account number is required to
 315                          succeed in order to allow the debitnote.
 316                          If omitted the debit note will only be rejected if
 317                          AqBanking is sure that the combination is invalid.
 318 -x                       Immediately execute the queue after enqueing the
 319                          transfer
 320 
 321 
 322 There are special return values when using this command:
 323 0:   everything is ok
 324 1-x: error (see above)
 325 99:  transfer has been executed and accepted by the bank, but the bank did not
 326      yet decide on whether the transfer is to be performed (job is pending)
 327 
 328 
 329 Examples
 330 --------
 331 aqbanking-tool debitnote --bank=2345678 --account=12345
 332                          --rbank=12345678 --raccount=67890
 333                          --rname=Test-User
 334                          --value="123,45:EUR"
 335                          --textkey=5
 336                          --purpose="Small test"
 337                          --force-check
 338 
 339 
 340 "import"
 341 ========
 342 
 343 This command imports a given file (or from stdin) using a given importer and
 344 writes the imported data to a new context-file which can be used for the
 345 commands "listtrans" etc.
 346 
 347 
 348 Options
 349 -------
 350 [--ctxfile     =ARG]     The result file to be used (defaults to stdout)
 351 [--infile      =ARG]     Name of the input file from which the transactions
 352                          are to be read. Defaults to stdin.
 353 [--importer    =ARG]     Name of the import plugin to be used for storage.
 354                          This defaults to "csv".
 355 [--profile     =ARG]     Name of the profile of the importer plugin to be
 356                          used. Defaults to "default" (for every importer
 357                          plugin a "default" profile is provided by AqBanking).
 358 
 359 Normally the system-wide profiles (and local AqBanking profiles of the user)
 360 are used when searching for a profile. However, with the following option
 361 you can use your own profiles database.
 362 [--profile-file=ARG]     Optional profile database file (a GWEN_DB)
 363 
 364 
 365 Examples
 366 --------
 367 aqbanking-tool import --ctxfile=out.ctx --infile=testfile 
 368                       --importer=swift --profile=SWIFT-MT940
 369 aqbanking-tool import --ctxfile=out.ctx --infile=testfile 
 370                       --importer=csv --profile=MyProfile
 371                       --profile-file=myProfileFile