Toshl Developer

Tags

Tags endpoint can be used to interact with users tags.

Resource representation

{
  "id": "42",
  "name": "coffee",
  "modified": "2012-09-04T13:55:15Z",
  "type": "expense",
  "category": "43",
  "count": 5,
  "deleted": 0
}

Properties

id
readonly
string

Tag id.

name
read, write
string

Tag name.

Max length: 100
name_override
read, write
boolean

Is true if name is overriden with a custom name.

modified
readonly
string

Specifies when the tag was last modified.

type
read, write
string

Tag type.

Possible values: expense, income
category
read, write
string

Primary category id of the tag.

counts
readonly
object

Number of times the tag has been used on entries and budgets.

entries *
readonly
integer

Number of entries with tag.

unsorted_entries
readonly
integer

Number of entries with tag and unsorted category.

budgets *
readonly
integer

Number of budgets with tag.

deleted
readonly
boolean

Is object deleted.

transient_created
readonly
string

Specifies when the transient data was created in UTC time.

transient_valid_till
readonly
string

Specifies till when the transient data is valid in user’s timezone.

meta_tag
readonly
boolean

Is object meta tag.

extra
read, write
object

A custom JSON object that you can use to extend Toshl API. Whatever you save into this field you will get back whenever you fetch it later.

* denotes required field/parameter.