Toshl Developer

Summary

Summary endpoint can be used to retrieve an overview of users expenses, incomes and budgets for the desired fromto timespan.

Resource representation

{
  "from": "2014-01-01",
  "to": "2014-01-31",
  "expenses": {
    "sum": 1540,
    "count": 23,
    "daily_median": 50.4
  },
  "incomes": {
    "sum": 2300,
    "count": 1,
    "daily_median": 2000
  },
  "budget": {
    "id": "42",
    "amount": 1540,
    "limit": 1800
  },
  "left": 260
}

Properties

from
readonly
string

Timespan start date in YYYY-MM-DD format.

Format: date
to
readonly
string

Timespan end date in YYYY-MM-DD format.

Format: date
expenses
readonly
object

Expenses overview of the given timespan.

sum
readonly
number

Expense sum for timespan.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
sum_planned
readonly
number

Planned expense sum for timespan.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
count
readonly
integer

Expense count for timespan.

Minimum: >= 0
daily_median
readonly
number

Median of daily expense sums. Zero sums are ignored.

Minimum: >= 0
all_time_avg
readonly
number

All time average for selected accounts

Minimum: > -1000000000000000
Maximum: < 1000000000000000
incomes
readonly
object

Income overview of the given timespan.

sum
readonly
number

Income sum for timespan.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
sum_planned
readonly
number

Planned income sum for timespan.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
count
readonly
integer

Income count for timespan.

Minimum: >= 0
daily_median
readonly
number

Median of daily income sums. Zero sums are ignored.

Minimum: >= 0
all_time_avg
readonly
number

All time average for selected accounts

Minimum: > -1000000000000000
Maximum: < 1000000000000000
budget
readonly
object

The summary budget

left
readonly
number

Amount left to spend for selected timestamp. If the amount is negative the user went over the income/budget limit.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
left_planned
readonly
number

Amount left to spend based on planned entriesfor selected timestamp. If the amount is negative the user went over the income/budget limit.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
balance
readonly
number

Balance until today

Minimum: > -1000000000000000
Maximum: < 1000000000000000