Newer
Older
.\" This file was generated automatically by tools/make_man.sh.
woob-bill \- get/download documents and bills
Romain Bignon
committed
.B woob
bill [\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon
committed
.B woob
bill [\-\-help] [\-\-version]
Console application allowing to get/download documents and bills.
.br
* amelipro (Ameli website: French Health Insurance for Professionals)
.br
* april (Pour les domaines d'assurance à titre individuel suivants (uniquement): Santé, de prêt, Prévoyance, Indépendance, Santé chien chat.)
.br
* banquepopulaire (Banque Populaire)
.br
* bnporc (BNP Paribas)
.br
* bnppere (BNP Épargne Salariale)
.br
* boursorama (Boursorama)
.br
* bp (La Banque Postale)
.br
* caissedepargne (Caisse d'Épargne)
.br
* capeasi (AXA Épargne Salariale)
.br
* cesu (Le Cesu est une offre simplifiée pour déclarer facilement la rémunération de votre salarié à domicile pour des activités de service à la personne.)
.br
* cityscoot (Le scooter électrique en libre\-service, sans bornes.)
.br
* cragr (Crédit Agricole)
.br
* creditdunordpee (Crédit du Nord Épargne Salariale)
.br
* edfparticulier (edf particulier)
.br
* edfprofessionnel (EDF Professionnel)
* erehsbc (HSBC Épargne Salariale)
.br
* esalia (Société Générale Épargne Salariale)
.br
* franceconnect (France Connect website)
.br
* free (free website)
.br
* hellobank (BNP Paribas)
.br
* impotsgouvfrpar (Impots \- Avis et declarations \- particulier)
.br
* lampiris (French electricity provider Lampiris.fr)
.br
* lcl (LCL)
.br
* pajemploi (Pajemploi est une offre de service du réseau des Urssaf, destinée à simplifier les formalités administratives pour les parents employeurs qui font garder leur(s) enfant(s) par une assistante maternelle agréée ou une garde d’enfants à domicile.)
.br
* s2e (Épargne Salariale)
.br
Romain Bignon
committed
.SH BILL COMMANDS
\fBdebug\fR
.br
Launch a debug Python shell
.TP
\fBdetails\fR [\fIID\fR]
.br
Get details of subscriptions.
\fBdocuments\fR [\fIID\fR]
.br
Get the list of documents for subscriptions.
.br
If no ID given, display documents of all backends
.br
.br
Default is limited to 10 results.
.TP
\fBdownload\fR [\fIDOC_ID\fR | all] [\fIFILENAME\fR]
DOC_ID is the identifier of the document (hint: try documents command)
.br
FILENAME is where to write the file. If FILENAME is '\-',
.br
the file is written to stdout.
You can use special word "all" and download all documents of
subscription identified by SUB_ID.
.br
If SUB_ID is not given, download documents of all subscriptions.
.TP
\fBdownload_pdf\fR [id | all]
\fBprofile\fR
.br
Display detailed information about person or company.
.TP
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.br
ACTION is one of the following (default: list):
.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.
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
.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
.br
If an argument is given, list the specified path.
Use \-U option to not sort results. It allows you to use a "fast path" to
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
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
.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\-\-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
.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\-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, multiline, simple,
subscriptions, table, webkit)
.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
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.
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.
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
Copyright(C) 2012-2021 Florent Fourcot
For full copyright information see the COPYING file in the woob package.
Romain Bignon
committed
Home page: https://woob.tech/applications/bill