Reports
Periodical reports for exporting users data.
Resource representation
{
"id": "42",
"emails": [
"demo@toshl.com",
"john@cleese.com"
],
"export": {
"resources": [
"expenses",
"incomes"
],
"formats": [
"pdf",
"ofx"
],
"filters": {
"accounts": ["1","2","3"],
"expenses": {
"categories": ["42"],
"tags": ["44"]
},
"incomes": {
"!categories": ["43"],
"!tags": ["45"]
},
"!locations": ["123"]
}
},
"include": {
"account_balances": true,
"networth": true
},
"frequencies": [
"weekly",
"monthly",
"yearly"
],
"modified": "2020-10-14T13:55:15Z",
"status": "active"
}Properties
|
id readonly string
|
Report id. |
|
emails read, write array
|
An |
|
modified readonly string
|
Specifies when the entry was last modified. |
|
export read, write object
|
Export details. Sent only if export files should be attached to report emails |
|
resources read, write array
|
An expenses, incomes, budgets, summary, attachments, attachments_grid, balances |
|
formats read, write array
|
An csv, xls, pdf, ofx |
|
filters read, write object
|
Export filter settings (accounts, categories, tags …) |
|
accounts read, write array
|
An |
|
!accounts read, write array
|
An |
|
expenses read, write object
|
Expense export filter settings for categories and tags. |
|
incomes read, write object
|
Income export filter settings for categories and tags. |
|
locations read, write array
|
An |
|
!locations read, write array
|
An |
|
include read, write object
|
Which parts of reports should be included. |
|
account_balances read, write boolean
|
Include account balances in report. |
|
networth read, write boolean
|
Include networth in report. |
|
frequencies read, write array
|
List of enabled report frequencies. Possible values:weekly, monthly, yearly |
|
status read, write string
|
Report status. Possible values:active, inactive |
* denotes required field/parameter.