Toshl Developer

List budgets

Get budget list.

GET /budgets

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 budgets that were modified since timestamp.

Format: date-time
from
optional
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
optional
string

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

Format: date
tags
optional
string

A comma separated list of tag ids. When used only budgets with the specified tags will be returned.

categories
optional
string

A comma separated list of category ids. When used only budgets with the specified categories will be returned.

accounts
optional
string

A comma separated list of account ids. When used only budgets with the specified accounts will be returned.

search
optional
string

Used to search budgets.

include_deleted
optional
boolean

Include deleted budgets.

expand
optional
boolean

If set to true the API will automatically expand budget iterations.

has_problem
optional
boolean

If set to true only budgets with problems will be returned.

one_iteration_only
optional
boolean

If set to true only one iteration for period is returned for repeating budgets.\nIf period intersects current date, the most current iteration is returned.\nIf period is in the past the latest iteration in the period is returned.\nIf period is in the future the first iteration in the period is returned.

parent
optional
string

Return all budgets that have the same parent.

Request

$ curl https://api.toshl.com/budgets \
  -H "Authorization: Bearer T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl"

Response

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

[
  {
    "id": "42",
    "name": "Monthly budget",
    "limit": 1000,
    "amount": 78.4,
    "planned": 12.6,
    "currency": {
      "code": "USD",
      "rate": 1,
      "fixed": false
    },
    "from": "2013-02-01",
    "to": "2013-02-30",
    "rollover": false,
    "modified": "2013-06-27T14:14:03+00:00Z",
    "recurrence": {
      "frequency": "monthly",
      "interval": 1,
      "start": "2012-06-01",
      "iteration": 4
    },
    "status": "active",
    "type": "regular",
    "order": 0,
    "categories": ["42"]
  }
]