Exports

Export users data in the selected formats. Exports are generated asynchronously so clients need to either implement pooling and wait for an export status to change to generated or wait for notification that is sent when export generation is complete.

Resource representation

{
  "id": "42-export",
  "resources": ["expenses", "incomes"],
  "formats": ["csv", "xls"],
  "filters": {
    "accounts": ["1","2","3"],
    "expenses": {
      "categories": ["42"],
      "tags": ["44"]
    },
    "incomes": {
      "!categories": ["43"],
      "!tags": ["45"]
    },
    "!locations": ["123"]
  },
  "from": "2020-10-01",
  "to": "2020-10-31",
  "created": "2020-10-04T13:55:15Z",
  "modified": "2020-10-04 13:55:15.324",
  "status": "generated",
  "data": {
    "path": "https://export.toshl.com",
    "filename": "export.zip",
    "filesize": 356271
  },
  "seen": false,
  "type": "export"
}

Properties

id readonly `string`	Export id.
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.
categories read, write `array`	An `array` of expense categories to export. Default is to export all categories.
!categories read, write `array`	An `array` of expense categories to exclude.
tags read, write `array`	An `array` of expense tags to export. Default is to export all tags.
!tags read, write `array`	An `array` of expense tags to exclude.
incomes read, write `object`	Income export filter settings for categories and tags.
categories read, write `array`	An `array` of income categories to export. Default is to export all categories.
!categories read, write `array`	An `array` of income categories to exclude.
tags read, write `array`	An `array` of income tags to export. Default is to export all tags.
!tags read, write `array`	An `array` of income tags to exclude.
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.
from read, write `string`	Used to define date range, in YYYY-MM-DD format. Format: `date`
to read, write `string`	Used to define date range, in YYYY-MM-DD format. Format: `date`
created readonly `string`	Specifies when the export was created. Format: `date-time`
modified readonly `string`	Specifies when the export was last modified.
status readonly `string`	Export status. Possible values: `sending, sent, error, generating, generated`
type read, write `string`	Export type. Possible values: `export, attachments, user_data`
seen read, write `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).
data readonly `object`	Export data after file was uploaded to S3
path readonly `string`	External export file path.
valid_until readonly `string`	Specifies how long the export file links will be valid. Format: `date-time`
filename readonly `string`	Filename
filesize read, write `number`	File size in bytes.

* denotes required field/parameter.

Page last modified: 08 Jan 2024