Toshl Developer

List timeline

List timeline.

GET /entries/timeline

Required scope:

Parameters

page
optional
integer

Page to display, used for pagination.

Minimum: >= 0
Default value: 0
per_page
optional
integer

Number of resource objects to return.

Minimum: >= 10
Maximum: =< 500
Default value: 200
since
optional
string

Return all entries that were modified since timestamp.

Format: date-time
from *
required
string

Used to define date range, in YYYY-MM-DD format. To filter by date both from and to must be set.

Format: date
to *
required
string

Used to define date range, in YYYY-MM-DD format. To filter by date both from and to must be set.

Format: date
type *
required
string

Entry types to return

Possible values: expense, income, transaction
group
optional
string

How to group timeline

Possible values: day, category, location
accounts
optional
string

A comma separated list of account ids. If used only entries from the specified accounts are returned.
categories
optional
string

A comma separated list of category ids. If used only entries in the specified categories are returned.
!categories
optional
string

A comma separated list of category ids. If used only entries not in the specified categories are returned.
tags
optional
string

A comma separated list of tag ids. If used only entries with the specified tags are returned.
!tags
optional
string

A comma separated list of tag ids. If used only entries without the specified tags are returned.
locations
optional
string

A comma separated list of location ids. If used only entries entered at the specified locations are returned.
!locations
optional
string

A comma separated list of location ids. If used entries not entered at the specified locations are returned.
repeat
optional
string

Used to return only entries that are part of the specified repeat.
search
optional
string

Used to search entries.
include_deleted
optional
boolean

Include deleted entries.
exclude_matching_transactions
optional
boolean

If set to true the API will exclude matching transaction entries.

* denotes required field/parameter.

Request

$ curl https://api.toshl.com/entries/timeline?from=2014-01-01&to=2014-01-31&type=expense&group=day \
  -H "Authorization: Bearer T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl"

Response

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "day": "2014-01-01",
    "sum": 45,
    "count": 1,
    "currency": "USD",
    "entries": [
      {
        "id": "42",
        "amount": -13.37,
        "currency": {
          "code": "USD",
          "rate": 1,
          "fixed": false
        },
        "date": "2014-01-01",
        "desc": "Entry description",
        "account": "45",
        "category": "42",
        "modified": "2014-01-01T13:55:15Z"
      }
    ]
  }
]