Toshl Developer

Update report

Update a report.

PUT /reports/{id}

Required scope:

Parameters

id *
required
string

Report id.

emails
optional
array

An array of emails to send the export file. If not set users default email is used.

resources (deprecated)
optional
array

An array of resources to export.

Possible values: expenses, incomes, budgets, summary, attachments, attachments_grid, balances
formats (deprecated)
optional
array

An array of export formats.

Possible values: csv, xls, pdf, ofx
accounts (deprecated)
optional
array

An array of accounts to export. Default is to export all accounts.

!accounts (deprecated)
optional
array

An array of accounts to not export. Default is to export all accounts.

categories (deprecated)
optional
array

An array of categories to export. Default is to export all categories.

!categories (deprecated)
optional
array

An array of categories to not export. Default is to export all categories.

tags (deprecated)
optional
array

An array of tags to export. Default is to export all tags.

!tags (deprecated)
optional
array

An array of tags to not export. Default is to export all tags.

locations (deprecated)
optional
array

An array of locations to export. Default is to export all locations.

!locations (deprecated)
optional
array

An array of locations to not export. Default is to export all locations.

frequency (deprecated)
optional
string

Report frequency

Possible values: weekly, monthly
export
optional
object

Export details. Sent only if export files should be attached to report emails

resources
optional
array

An array of resources to export.

Possible values: expenses, incomes, budgets, summary, attachments, attachments_grid, balances
formats
optional
array

An array of export formats.

Possible values: csv, xls, pdf, ofx
accounts
optional
array

An array of accounts to export. Default is to export all accounts.

!accounts
optional
array

An array of accounts to not export. Default is to export all accounts.

categories
optional
array

An array of categories to export. Default is to export all categories.

!categories
optional
array

An array of categories to not export. Default is to export all categories.

tags
optional
array

An array of tags to export. Default is to export all tags.

!tags
optional
array

An array of tags to not export. Default is to export all tags.

locations
optional
array

An array of locations to export. Default is to export all locations.

!locations
optional
array

An array of locations to not export. Default is to export all locations.

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"
    ],
    "accounts": [
      "43"
    ],
    "categories": [
      "44"
    ]
  },
  "include": {
    "account_balances": true,
    "networth": true
  },
  "frequencies": [
    "weekly",
    "monthly",
    "yearly"
  ],
  "modified": "2020-10-14T13:55:15Z",
  "status": "active"
}