Toshl Developer

Create export

Create a new export.

POST /exports

Required scope:

Parameters

emails (deprecated)
optional
array

An array of emails to send the export file to.

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
filters
optional
object

Export filter settings (accounts, categories, tags …)

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.

expenses
optional
object

Expense export filter settings for categories and tags.

categories
optional
array

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

!categories
optional
array

An array of expense categories to exclude.

tags
optional
array

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

!tags
optional
array

An array of expense tags to exclude.

incomes
optional
object

Income export filter settings for categories and tags.

categories
optional
array

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

!categories
optional
array

An array of income categories to exclude.

tags
optional
array

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

!tags
optional
array

An array of income tags to exclude.

locations
optional
array

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

!locations
optional
array

An array of locations to exclude.

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.

from
optional
string

Used to define date range, in YYYY-MM-DD format.

Format: date
to
optional
string

Used to define date range, in YYYY-MM-DD format.

Format: date
type *
required
string

Export type.

Possible values: export, attachments, user_data
seen
optional
boolean

Marked as true if user has already seen the export after it was generated. If not set to true the system will send out a push notification after export was generated (with a slight delay).

* denotes required field/parameter.

Request

$ curl https://api.toshl.com/exports \
  -H "Authorization: Bearer T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{json}'

Response

HTTP/1.1 201 Created
Location: https://api.toshl.com/exports/42-export