Update report
Update a report.
PUT /reports/{id}
Required scope:
- entries:r
- budgets:r
- accounts:r
- categories:r
- tags:r
Parameters
id * required string
|
Report id. |
emails optional array
|
An |
export optional object
|
Export details. Sent only if export files should be attached to report emails |
resources optional array
|
An expenses, incomes, budgets, summary, attachments, attachments_grid, balances |
formats optional array
|
An csv, xls, pdf, ofx |
filters optional object
|
Export filter settings (accounts, categories, tags …) |
accounts optional array
|
An |
!accounts optional array
|
An |
expenses optional object
|
Expense export filter settings for categories and tags. |
incomes optional object
|
Income export filter settings for categories and tags. |
locations optional array
|
An |
!locations optional array
|
An |
include optional object
|
Which parts of reports should be included. |
account_balances optional boolean
|
Include account balances in report. |
networth optional boolean
|
Include networth in report. |
frequencies optional array
|
List of enabled report frequencies. Possible values:weekly, monthly, yearly |
status optional string
|
Report status. Possible values:active, inactive |
* denotes required field/parameter.
Request
$ curl https://api.toshl.com/reports/42 \ -H "Authorization: Bearer T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl" \ -H "Content-Type: application/json" \ -X PUT \ -d '{json}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"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"
}