Toshl Developer

Planning

Planning endpoint can be used to help users plan their expenditures for future months based on previous months. When requesting make sure to include from - to range or an error will be returned.

Note: Be advised that planning is a pro feature and as such subject to free account limitation. If a user with a free account tries to access the planning endpoint a 403 Forbidden error will be returned.

Resource representation

{
  "avg": {
    "expenses": 1416,
    "incomes": 1700,
    "balance": 284,
    "networth": 284
  },
  "ranges": {
    "expenses": {
      "min": 1300,
      "max": 1800
    },
    "incomes": {
      "min": 1500,
      "max": 2000
    },
    "balance": {
      "min": -100,
      "max": 600
    },
    "networth": {
      "min": -200,
      "max": 1000
    }
  },
  "planning": [
    {
      "from": "12-01-2016",
      "to": "12-31-2016",
      "expenses": {
        "sum": 1376,
        "planned": 0,
        "predicted": 1376
      },
      "incomes": {
        "sum": 1800,
        "planned": 0,
        "predicted": 1800
      },
      "balance": {
        "sum": 424,
        "planned": 0,
        "predicted": 424
      },
      "estimated": {
        "sum": 1500,
        "planned": 400,
        "predicted": 1900
      }
    }
  ]
}

Properties

avg
read, write
object
expenses
read, write
number

Expense average

Minimum: >= 0
Maximum: < 1000000000000000
incomes
read, write
number

Income average

Minimum: >= 0
Maximum: < 1000000000000000
balance
read, write
number

Balance average

Minimum: > -1000000000000000
Maximum: < 1000000000000000
networth
read, write
number

Networth average

Minimum: > -1000000000000000
Maximum: < 1000000000000000
ranges
read, write
object

Min-max ranges for planning used to make a consistent graph scale.

expenses
read, write
object

Min-max range for expenses

min
read, write
number

Min range

Minimum: >= 0
Maximum: < 1000000000000000
max
read, write
number

Max range

Minimum: >= 0
Maximum: < 1000000000000000
incomes
read, write
object

Min-max range for incomes

min
read, write
number

Min range

Minimum: >= 0
Maximum: < 1000000000000000
max
read, write
number

Max range

Minimum: >= 0
Maximum: < 1000000000000000
balance
read, write
object

Min-max range for balance

min
read, write
number

Min range

Minimum: >= 0
Maximum: < 1000000000000000
max
read, write
number

Max range

Minimum: >= 0
Maximum: < 1000000000000000
networth
read, write
object

Min-max range for networth

min
read, write
number

Min range

Minimum: >= 0
Maximum: < 1000000000000000
max
read, write
number

Max range

Minimum: >= 0
Maximum: < 1000000000000000
planning
read, write
array

Planning list

from
readonly
string

Month start date.

Format: date
to
readonly
string

Month end date.

Format: date
expenses
read, write
object

Expense planning.

sum
read, write
number

Expense sum

Minimum: >= 0
Maximum: < 1000000000000000
planned
read, write
number

Expense sum planned

Minimum: >= 0
Maximum: < 1000000000000000
estimated
read, write
number

Expense sum estimated

Minimum: >= 0
Maximum: < 1000000000000000
incomes
read, write
object

Income planning.

sum
read, write
number

Income sum

Minimum: >= 0
Maximum: < 1000000000000000
planned
read, write
number

Income sum planned

Minimum: >= 0
Maximum: < 1000000000000000
estimated
read, write
number

Income sum estimated

Minimum: >= 0
Maximum: < 1000000000000000
balance
read, write
object

Balance planning.

sum
read, write
number

Balance sum

Minimum: > -1000000000000000
Maximum: < 1000000000000000
planned
read, write
number

Balance sum planned

Minimum: > -1000000000000000
Maximum: < 1000000000000000
estimated
read, write
number

Balance sum estimated

Minimum: > -1000000000000000
Maximum: < 1000000000000000
networth
read, write
object

Net worth planning.

sum
read, write
number

Net worth sum

Minimum: > -1000000000000000
Maximum: < 1000000000000000
planned
read, write
number

Net worth sum planned

Minimum: > -1000000000000000
Maximum: < 1000000000000000
estimated
read, write
number

Net worth sum estimated

Minimum: > -1000000000000000
Maximum: < 1000000000000000