Newer
Older
.\" -*- coding: utf-8 -*-
.\" This file was generated automatically by tools/make_man.sh.
woob-money \- import bank accounts into Microsoft Money
Romain Bignon
committed
.B woob
money [\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon
committed
.B woob
money [\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Console application that imports bank accounts into Microsoft Money
.SS Supported websites:
* afer (Association française d'épargne et de retraite)
.br
* amazonstorecard (Amazon Store Card)
.br
* americanexpress (American Express)
.br
* amundi (Amundi)
.br
* apivie (Apivie)
.br
* axabanque (AXA Banque)
.br
* banqueaccord (Banque Accord)
.br
* banquepopulaire (Banque Populaire)
.br
* barclays (Barclays)
.br
* becm (Banque Européenne Crédit Mutuel)
.br
* bforbank (BforBank)
.br
* binck (Binck)
.br
* bnpcards (BNP Cartes Entreprises)
.br
* bnporc (BNP Paribas)
.br
* bnppere (BNP Épargne Salariale)
.br
* bolden (Bolden)
.br
* boursedirect (Bourse direct)
.br
* boursorama (Boursorama)
.br
* bp (La Banque Postale)
.br
* bred (Bred)
.br
* btpbanque (BTP Banque)
.br
* caels (Crédit Agricole \- Épargne Longue des Salariés)
.br
* caissedepargne (Caisse d'Épargne)
.br
* capeasi (AXA Épargne Salariale)
.br
* carrefourbanque (Carrefour Banque)
.br
* cic (CIC)
.br
* cices (CIC Épargne Salariale)
.br
* citibank (Citibank)
.br
* cmb (Crédit Mutuel de Bretagne)
.br
* cmes (Crédit Mutuel Épargne Salariale)
.br
* cmso (Crédit Mutuel Sud\-Ouest)
.br
* courtois (Banque Courtois)
.br
* cragr (Crédit Agricole)
.br
* creditcooperatif (Crédit Coopératif)
.br
* creditdunord (Crédit du Nord, Banque Courtois, Kolb, Nuger, Laydernier, Tarneaud, Société Marseillaise de Crédit)
.br
* delubac (Banque Delubac & Cie)
.br
* erehsbc (HSBC Épargne Salariale)
.br
* esalia (Société Générale Épargne Salariale)
.br
* fortuneo (Fortuneo)
.br
* ganassurances (Gan Assurances)
.br
* gmf (GMF)
.br
* groupama (Groupama)
.br
* groupamaes (Groupama Épargne Salariale)
.br
* hellobank (BNP Paribas)
.br
* kolb (Banque Kolb)
.br
* laydernier (Banque Laydernier)
.br
* linebourse (linebourse website)
.br
* myedenred (MyEdenRed)
.br
* n26 (Bank N26)
.br
* nalo (Nalo)
.br
* nuger (Banque Nuger)
.br
* oney (Oney)
.br
* paypal (PayPal)
.br
* pradoepargne (Prado Épargne Salariale)
.br
* rhonealpe (Banque Rhône alpes)
.br
* smc (Société Marseillaise de Crédit)
* societegenerale (Société Générale)
Romain Bignon
committed
* sogecartenet (Sogecarte Net)
.br
* spirica (Spirica)
.br
* suravenir (Assurance\-vie Suravenir à travers différents courtiers (assurancevie.com, linxea, ...))
.br
* tarneaud (Banque Tarneaud)
.br
Romain Bignon
committed
.SH MONEY COMMANDS
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
.TP
\fBadd_recipient\fR iban label
.br
Add a recipient to a backend.
.TP
\fBbudgea\fR \fIUSERNAME\fR \fIPASSWORD\fR
.br
Export your bank accounts and transactions to Budgea.
.br
.br
Budgea is an online web and mobile application to manage your bank
.br
accounts. To avoid giving your credentials to this service, you can use
.br
this command.
.br
.br
https://www.budgea.com
.TP
\fBcoming\fR \fIID\fR [\fIEND_DATE\fR]
.br
Display future transactions.
.br
.br
If END_DATE is supplied, show all transactions until this date.
.br
.br
Default is limited to 10 results.
.TP
\fBdebug\fR
.br
Launch a debug Python shell
.TP
\fBemitters\fR
.br
Display transfer emitter account.
.TP
\fBhistory\fR \fIID\fR [\fIEND_DATE\fR]
.br
Display history of transactions.
.br
.br
If END_DATE is supplied, list all transactions until this date.
.br
.br
Default is limited to 10 results.
.TP
\fBinvestment\fR \fIID\fR
.br
Display investments of an account.
.TP
\fBlist\fR [\-\fIU\fR]
.br
List accounts.
.br
Use \-U to disable sorting of results.
.TP
\fBmarket_order\fR \fIID\fR
.br
Display market orders of an account.
.br
.br
Default is limited to 10 results.
.TP
\fBpocket\fR \fIID\fR
.br
Display pockets of an account.
.TP
\fBprofile\fR
.br
Display detailed information about person or company.
.TP
\fBrecipients\fR \fIACCOUNT\fR
.br
List recipients of ACCOUNT
.TP
\fBtransfer\fR [\fIACCOUNT\fR \fIRECIPIENT\fR \fIAMOUNT\fR [\fILABEL\fR [\fIEXEC_DATE\fR]]]
.br
.br
\- ACCOUNT the source account
.br
\- RECIPIENT the recipient
.br
\- AMOUNT amount to transfer
.br
\- LABEL label of transfer
.br
\- EXEC_DATE date when to execute the transfer
.TP
\fBtransfer_history\fR [\fIACCOUNT_ID\fR]
.br
Display history of transfer transactions.
.br
.br
Default is limited to 10 results.
.SH WOOB COMMANDS
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.br
ACTION is one of the following (default: list):
.br
* enable enable given backends
.br
* disable disable given backends
.br
* only enable given backends and disable the others
.br
* list list backends
.br
* add add a backend
.br
* register register a new account on a website
.br
* edit edit a backend
.br
* remove remove a backend
.br
* list\-modules list modules
.TP
\fBcd\fR [\fIPATH\fR]
.br
Follow a path.
.br
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
.br
If the "off" value is given, conditional filtering is disabled.
.br
.br
If no argument is given, print the current condition expression.
.TP
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br
.br
If no argument is given, print the current count value.
.TP
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br
.br
If the argument is "list", print the available formatters.
.br
.br
If the argument is "option", set the formatter options.
.br
Valid options are: header, keys.
.br
If on/off value is given, set the value of the option.
.br
If not, print the current value for the option.
.br
.br
If no argument is given, print the current formatter.
.TP
\fBlogging\fR [\fILEVEL\fR]
.br
Set logging level.
.br
.br
Availables: debug, info, warning, error.
.br
* quiet is an alias for error
.br
* default is an alias for warning
.TP
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
.br
List objects in current path.
.br
If an argument is given, list the specified path.
.br
Use \-U option to not sort results. It allows you to use a "fast path" to
.br
return results as soon as possible.
.br
Use \-d option to display information about a collection (and to not
.br
display the content of it). It has the same behavior than the well
.br
known UNIX "ls" command.
.br
.br
Default is limited to 40 results.
.TP
\fBquit\fR
.br
Quit the application.
.TP
\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
.br
If an argument is given, set the selected fields.
.br
$direct selects all fields loaded in one http request.
.br
$full selects all fields using as much http requests as necessary.
.br
.br
If no argument is given, print the currently selected fields.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
what backend(s) to enable (comma separated)
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages. Set up it twice to more verbosity
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression. See CONDITION section
for the syntax
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
limit number of results (from each backends)
.TP
\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
select result item keys to display (comma separated)
.SH FORMATTING OPTIONS
.TP
\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
select output formatter (csv, htmltable, json, json_line, list, multiline,
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
.SH MONEY OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR
list the accounts and balance, without generating any import to MSMoney
.TP
\fB\-F\fR, \fB\-\-force\fR
forces the retrieval of transactions (10 maximum), otherwise retrieves only the
transactions newer than the previous retrieval date
.TP
\fB\-U UNTIL_DATE\fR, \fB\-\-until\-date=UNTIL_DATE\fR
retrieves until date YYYY\-MM\-DD max
\fB\-A ACCOUNTS\fR, \fB\-\-accounts=ACCOUNTS\fR
retrieves only the specified accounts. By default, all accounts are retrieved
.TP
\fB\-N\fR, \fB\-\-no\-import\fR
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
no import. Generates the files, but they are not imported in MSMoney. Last
import dates are not modified
.TP
\fB\-D\fR, \fB\-\-display\fR
displays the generated OFX file
.SH CONDITION
The \-c and \-\-condition is a flexible way to filter and get only interesting results. It supports conditions on numerical values, dates, durations and strings. Dates are given in YYYY\-MM\-DD or YYYY\-MM\-DD HH:MM format. Durations look like XhYmZs where X, Y and Z are integers. Any of them may be omitted. For instance, YmZs, XhZs or Ym are accepted.
The syntax of one expression is "\fBfield operator value\fR". The field to test is always the left member of the expression.
.LP
The field is a member of the objects returned by the command. For example, a bank account has "balance", "coming" or "label" fields.
.SS The following operators are supported:
.TP
=
Test if object.field is equal to the value.
.TP
!=
Test if object.field is not equal to the value.
.TP
>
Test if object.field is greater than the value. If object.field is date, return true if value is before that object.field.
.TP
<
Test if object.field is less than the value. If object.field is date, return true if value is after that object.field.
.TP
|
This operator is available only for string fields. It works like the Unix standard \fBgrep\fR command, and returns True if the pattern specified in the value is in object.field.
.SS Expression combination
.LP
You can make a expression combinations with the keywords \fB" AND "\fR, \fB" OR "\fR an \fB" LIMIT "\fR.
.LP
The \fBLIMIT\fR keyword can be used to limit the number of items upon which running the expression. \fBLIMIT\fR can only be placed at the end of the expression followed by the number of elements you want.
.SS Examples:
.nf
Romain Bignon
committed
.B woob bank ls \-\-condition 'label=Livret A'
.fi
Display only the "Livret A" account.
.PP
.nf
Romain Bignon
committed
.B woob bank ls \-\-condition 'balance>10000'
.fi
Display accounts with a lot of money.
.PP
.nf
Romain Bignon
committed
.B woob bank history account@backend \-\-condition 'label|rewe'
.fi
Get transactions containing "rewe".
.PP
.nf
Romain Bignon
committed
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
.fi
Get transactions betweens the 2th December and 8th December 2013.
.PP
.nf
Romain Bignon
committed
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01 LIMIT 10'
.fi
Get transactions after the 2th December in the last 10 transactions
.SH COPYRIGHT
Copyright(C) 2018-2021 Bruno Chabrier
For full copyright information see the COPYING file in the woob package.
Romain Bignon
committed
Home page: https://woob.tech/applications/money