Toshl Developer

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 array of emails to send the export file to.

resources (deprecated)
read, write
array

An array of resources to export.

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

An array of export formats.

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

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

!accounts (deprecated)
read, write
array

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

categories (deprecated)
read, write
array

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

!categories (deprecated)
read, write
array

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

tags (deprecated)
read, write
array

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

!tags (deprecated)
read, write
array

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

locations (deprecated)
read, write
array

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

!locations (deprecated)
read, write
array

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

modified
readonly
string

Specifies when the entry was last modified.

frequency (deprecated)
read, write
string

Report frequency

Possible values: weekly, monthly, yearly
export
read, write
object

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

resources
read, write
array

An array of resources to export.

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

An array of export formats.

Possible values: csv, xls, pdf, ofx
filters
read, write
object

Export filter settings (accounts, categories, tags …)

accounts
read, write
array

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

!accounts
read, write
array

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

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 array of locations to export. Default is to export all locations.

!locations
read, write
array

An array of locations to exclude.

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.