cozyweboob/doc/capabilities/CapDocument.md

15 lines
1.5 KiB
Markdown
Raw Normal View History

2016-09-30 17:37:29 +02:00
CapDocument
===========
This capability is used for modules that have billing support.
2016-10-03 03:24:01 +02:00
| Key | Value | Type |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|
| subscriptions | List of subscriptions (contracts) | Subscription |
| bills | Map of bills for each subscription. Bills are final document produced by the third party. | Bill |
| history_bills | Map of history bills for each subscription. History bills are detailed counts for any event resulting in a transaction (typically any communication for a phone service provider) | Detail |
| detailed_bills | Map of detailed bills for each subscription. Detailed bills are aggregated counts by facturation type (typically voice and texts for a phone service provider) | Detail |
The fields available for any type are listed [in the Weboob
doc](http://dev.weboob.org/api/capabilities/bill).